datadog-actions-metrics

This is an action to send metrics of GitHub Actions to Datadog on an event. It is inspired from yuya-takeyama/github-actions-metrics-to-datadog-action.

Purpose

Analyze workflow run statistics

You can analyze the workflow run statistics such as duration or success rate. It is useful to improve long-time tests or flaky tests.

Here is an example of screenshot in Datadog.

To collect the metrics of a workflow on completed:

on:
  workflow_run:
    workflows:
      - '**'
    types:
      - completed

jobs:
  send:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - uses: int128/datadog-actions-metrics@v1
        with:
          # create an API key in https://docs.datadoghq.com/account_management/api-app-keys/
          datadog-api-key: ${{ secrets.DATADOG_API_KEY }}

See also the actual metrics in the E2E test.

Analyze pull request statistics

You can analyze development activity such as number of merged pull requests. It helps the continuous process improvement of your team.

To collect the metrics of a pull request:

on:
  pull_request:
    types:
      - opened
      - closed

jobs:
  send:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - uses: int128/datadog-actions-metrics@v1
        with:
          # create an API key in https://docs.datadoghq.com/account_management/api-app-keys/
          datadog-api-key: ${{ secrets.DATADOG_API_KEY }}

Metrics

Workflow run

This metrics will be sent on workflow_run event.

This action sends the following metrics:

• github.actions.workflow_run.total
• github.actions.workflow_run.conclusion.{CONCLUSION}_total
  • e.g. github.actions.workflow_run.conclusion.success_total
  • e.g. github.actions.workflow_run.conclusion.failure_total
  • See the official document for the possible values of CONCLUSION field
• github.actions.workflow_run.duration_second
  • Time from a workflow is created to updated
• github.actions.workflow_run.queued_duration_second
  • Time from a workflow is created until the first job is started

It has the following tags:

• repository_owner
• repository_name
• workflow_name
• workflow_id
• event
• sender
• sender_type = either Bot, User or Organization
• branch
• default_branch = true or false
• conclusion

Job

This metrics will be sent on workflow_run event. You need to set collect-job-metrics to enable the metrics.

This action sends the following metrics:

• github.actions.job.total
• github.actions.job.conclusion.{CONCLUSION}_total
  • e.g. github.actions.job.conclusion.success_total
  • e.g. github.actions.job.conclusion.failure_total
• github.actions.job.duration_second
  • Time from a job is started to completed
• github.actions.job.queued_duration_second
  • Time from a job is started until the first step is started

It has the following tags:

• repository_owner
• repository_name
• workflow_name
• workflow_id
• event
• sender
• sender_type = either Bot, User or Organization
• branch
• default_branch = true or false
• job_name
• job_id
• conclusion
• status
• runs_on
  • Runner label inferred from the workflow file if available
  • e.g. ubuntu-latest

Step

This metrics will be sent on workflow_run event. You need to set collect-job-metrics to enable the metrics.

This action sends the following metrics:

• github.actions.step.total
• github.actions.step.conclusion.{CONCLUSION}_total
  • e.g. github.actions.step.conclusion.success_total
  • e.g. github.actions.step.conclusion.failure_total
• github.actions.step.duration_second

It has the following tags:

• repository_owner
• repository_name
• workflow_name
• workflow_id
• event
• sender
• sender_type = either Bot, User or Organization
• branch
• default_branch = true or false
• job_name
• job_id
• step_name
• step_number = 1, 2, ...
• conclusion
• status
• runs_on
  • Runner label inferred from the workflow file if available
  • e.g. ubuntu-latest

Pull request (opened)

This metrics will be sent on pull_request event.

This action sends the following metrics:

• github.actions.pull_request_opened.total
• github.actions.pull_request_opened.commits
• github.actions.pull_request_opened.changed_files
• github.actions.pull_request_opened.additions
• github.actions.pull_request_opened.deletions

It has the following tags:

• repository_owner
• repository_name
• sender
• sender_type = either Bot, User or Organization
• user
• pull_request_number
• draft = true or false
• base_ref
• head_ref
• label = label(s) of the pull request

Pull request (closed)

This metrics will be sent on pull_request event.

This action sends the following metrics:

• github.actions.pull_request_closed.total
• github.actions.pull_request_closed.since_opened_seconds
  • Time from a pull request is opened to closed
• github.actions.pull_request_closed.commits
• github.actions.pull_request_closed.changed_files
• github.actions.pull_request_closed.additions
• github.actions.pull_request_closed.deletions

It has the following tags:

• repository_owner
• repository_name
• sender
• sender_type = either Bot, User or Organization
• user
• pull_request_number
• draft = true or false
• base_ref
• head_ref
• label = label(s) of the pull request
• merged = true or false

Push

This metrics will be sent on push event.

This action sends the following metrics:

• github.actions.push.total

It has the following tags:

• repository_owner
• repository_name
• sender
• sender_type = either Bot, User or Organization
• ref
• created = true or false
• deleted = true or false
• forced = true or false
• default_branch = true or false

Rate limit

This metrics will be sent on any events.

This action sends the following metrics of the built-in GITHUB_TOKEN rate limit:

• github.actions.api_rate_limit.remaining
• github.actions.api_rate_limit.limit

It has the following tags:

• repository_owner
• repository_name
• resource is either of values
  • core
  • search
  • graphql

This does not affect the rate limit of GitHub API because it just calls /rate_limit endpoint.

Specification

You can set the following inputs:

Name	Type	Description
github-token	optional	GitHub token to get jobs and steps if needed. Default to github.token
github-token-rate-limit-metrics	optional	GitHub token for rate limit metrics. Default to github.token
datadog-api-key	optional	Datadog API key. If not set, this action does not send metrics actually
collect-job-metrics	optional	Collect metrics of jobs and steps. Default to false

Note that collect-job-metrics-for-only-default-branch is no longer supported. Use collect-job-metrics instead.

Jobs and steps metrics

By default, this actions sends only workflow run metrics on workflow_run event. As well as you can use jobs and steps metrics. It is useful to improve the deployment pipeline such as build or test.

To send the metrics of jobs and steps:

      - uses: int128/datadog-actions-metrics@v1
        with:
          datadog-api-key: ${{ secrets.DATADOG_API_KEY }}
          collect-job-metrics: true

Note that this calls GitHub API to get jobs and steps of a workflow run. It may cause the rate limit exceeding error if too many workflows are run.

To send the metrics of jobs and steps on the default branch only:

      - uses: int128/datadog-actions-metrics@v1
        with:
          datadog-api-key: ${{ secrets.DATADOG_API_KEY }}
          collect-job-metrics: ${{ github.event.workflow_run.head_branch == github.event.repository.default_branch }}

Contribution

This is an open source software. Feel free to open issues and pull requests.