Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/masci/datadog
Send Datadog metrics and events from GitHub workflows
https://github.com/masci/datadog
actions datadog monitoring
Last synced: 25 days ago
JSON representation
Send Datadog metrics and events from GitHub workflows
- Host: GitHub
- URL: https://github.com/masci/datadog
- Owner: masci
- License: mit
- Created: 2020-04-16T21:12:02.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-18T06:30:49.000Z (7 months ago)
- Last Synced: 2024-12-27T03:04:09.931Z (about 1 month ago)
- Topics: actions, datadog, monitoring
- Language: TypeScript
- Homepage:
- Size: 781 KB
- Stars: 73
- Watchers: 3
- Forks: 21
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome_ai_agents - Datadog - Send Datadog metrics and events from GitHub workflows (Building / Workflows)
README
# Datadog Action
[](https://github.com/masci/datadog/actions/workflows/test.yml)
This Action lets you send events and metrics to Datadog from a GitHub workflow.
## Usage
> [!IMPORTANT]
> The action can send metrics and events to any Datadog site by setting the `api-url` param. When
> omitted, it defaults to the US endpoint: `https://api.datadoghq.com`.
Please note how `metrics` is defined as a string containing YAML code - this
allows to send more than one metric at once if needed. To send one metric,
configure a job step like the following:
```yaml
- name: Build count
uses: masci/datadog@v1
with:
api-key: ${{ secrets.DATADOG_API_KEY }}
metrics: |
- type: "count"
name: "test.runs.count"
value: 1.0
host: ${{ github.repository_owner }}
tags:
- "project:${{ github.repository }}"
- "branch:${{ github.head_ref }}"
```
You can also send Datadog events from workflows, same as `metric` please note
how `events` is indeed a string containing YAML code. For example, an use case
might be sending an event when a job has failed:
```yaml
steps:
- name: checkout
uses: actions/checkout@v2
- name: build
run: this-will-fail
- name: Datadog
if: failure()
uses: masci/datadog@v1
with:
api-key: ${{ secrets.DATADOG_API_KEY }}
events: |
- title: "Failed building Foo"
text: "Branch ${{ github.head_ref }} failed to build"
alert_type: "error"
host: ${{ github.repository_owner }}
tags:
- "project:${{ github.repository }}"
```
You can also send Datadog service checks from workflows, same as others please note
how `service-checks` is indeed a string containing YAML code. For example, an use case
might be sending when a job has failed:
```yaml
steps:
- name: checkout
uses: actions/checkout@v2
- name: build
run: this-will-fail
- name: Datadog
if: failure()
uses: masci/datadog@v1
with:
api-key: ${{ secrets.DATADOG_API_KEY }}
service-checks: |
- check: "app.ok"
message: "Branch ${{ github.head_ref }} failed to build"
status: 0
host_name: ${{ github.repository_owner }}
tags:
- "project:${{ github.repository }}"
```
You can also send Datadog logs from workflows, same as others please note
how `logs` is indeed a string containing YAML code. For example, an use case
might be sending when a job has failed:
```yaml
steps:
- name: checkout
uses: actions/checkout@v2
- name: build
run: this-will-fail
- name: Datadog
if: failure()
uses: masci/datadog@v1
with:
api-key: ${{ secrets.DATADOG_API_KEY }}
logs: |
- ddsource: "nginx"
ddtags: "env:staging,version:5.1"
hostname: "i-012345678"
message: "{\"message\":\"2019-11-19T14:37:58,995 ERROR [process.name][20081] Hello World\", \"level\":\"error\"}"
service: "payment"
```
## Development
Install the dependencies
```bash
$ npm install
```
Lint, test and build the typescript and package it for distribution
```bash
$ npm run all
```
Run the tests :heavy_check_mark:
```bash
$ npm test
> [email protected] test /datadog
> jest
PASS __tests__/main.test.ts
unit-tests
✓ api-key input param must be set (3 ms)
✓ default api endpoint URL (1 ms)
✓ custom api endpoint URL
✓ run calls the sending functions (1 ms)
end-to-end tests
✓ actually sends data to the backend when DD_API_KEY env var is set
...
Ran all test suites.
```
When the DD_API_KEY env var is set with a valid API Key, the tests will
also perform an actual call sending some metrics, events and service checks.