github-workflow-runs-monitor.ts

/*
 * Copyright OpenSearch Contributors
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 */

// Name         : githubWorkflowRunsMonitor
// Description  : prints the githubWorkflowRunsMonitor output and indexes logData to OpenSearch
// Arguments    :
//  - events     : The list of events to monitor and index, from https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows.

import { Probot } from 'probot';
import { CloudWatchClient, PutMetricDataCommand } from '@aws-sdk/client-cloudwatch';
import { Resource } from '../service/resource/resource';
import { OpensearchClient } from '../utility/opensearch/opensearch-client';
import { validateResourceConfig } from '../utility/verification/verify-resource';

interface WorkflowRunMonitorArgs {
  events: string[];
  workflows: string[];
}

export default async function githubWorkflowRunsMonitor(
  app: Probot,
  context: any,
  resource: Resource,
  { events, workflows }: WorkflowRunMonitorArgs,
): Promise<void> {
  app.log.info(`workflowArgs: ${JSON.stringify(events)}`);
  app.log.info(`workflowsToMonitor: ${JSON.stringify(workflows)}`);
  if (!(await validateResourceConfig(app, context, resource))) return;

  const job = context.payload.workflow_run;

  if (!events.includes(job?.event)) {
    app.log.info('Event not relevant. Not Indexing...');
    return;
  }
  if (!workflows.includes(job?.name)) {
    app.log.info('Workflow not relevant. Not Indexing...');
    return;
  }

  const repoName = context.payload.repository?.name;
  const orgName = context.payload.organization?.login || context.payload.repository?.owner?.login;

  const logData = {
    event: job?.event,
    repository: repoName,
    organization: orgName,
    id: job?.id,
    name: job?.name,
    head_branch: job?.head_branch,
    head_sha: job?.head_sha,
    path: job?.path,
    display_title: job?.display_title,
    created_at: job?.created_at,
    run_started_at: job?.run_started_at,
    updated_at: job?.updated_at,
    completed_at: job?.completed_at,
    triggering_actor_login: job?.triggering_actor.login,
    triggering_actor_type: job?.triggering_actor.type,
    check_run_url: job?.url,
    check_run_html_url: job?.html_url,
    status: job?.status,
    conclusion: job?.conclusion,
    check_run_jobs_url: job?.jobs_url,
  };

  const client = await new OpensearchClient().getClient();
  const [month, year] = [new Date().getMonth() + 1, new Date().getFullYear()].map((num) => String(num).padStart(2, '0'));
  try {
    await client.index({
      index: `github-ci-workflow-runs-${month}-${year}`,
      body: logData,
    });
    app.log.info('Log data indexed successfully.');
  } catch (error) {
    app.log.error(`Error indexing log data: ${error}`);
  }

  let count = 0;
  if (job?.status === 'completed' && (job?.conclusion === 'failure' || job?.conclusion === 'startup_failure')) {
    count = 1;
  }
  try {
    const cloudWatchClient = new CloudWatchClient({ region: String(process.env.REGION) });
    const putMetricDataCommand = new PutMetricDataCommand({
      Namespace: 'GitHubActions',
      MetricData: [
        {
          MetricName: 'WorkflowRunFailures',
          Dimensions: [
            {
              Name: 'Workflow',
              Value: job?.name,
            },
          ],
          Value: count,
          Unit: 'Count',
        },
      ],
    });
    await cloudWatchClient.send(putMetricDataCommand);
    app.log.info('CloudWatch metric for workflow published.');
  } catch (error) {
    app.log.error(`Error Publishing CloudWatch metric for workflow : ${error}`);
  }
}