Signalfx Action

This Action lets you send events and metrics to Signalfx from a GitHub workflow.

Forked from masci/datadog and translated for Signalfx

Usage

The action can send events to any Signalfx site by setting the api-url param. When omitted, it defaults to the US endpoint: https://ingest.us1.signalfx.com.

You can send Signalfx events and/or metrics from workflows. Please note how the events and `metrics fields are a string containing YAML code. For example, an use case might be sending an event and some metrics when a job has failed:

steps:
  - name: checkout
    uses: actions/checkout@v2
  - name: build
    run: this-will-fail
  - name: Signalfx
    if: failure()
    uses: RentTheRunway/signalfx-reporting-action@v2
    with:
      token: ${{ secrets.SIGNALFX_TOKEN }}
      metrics: |
            - type: "counter"
              name: "test.workflow.runtime"
              value: ${{ env.RUN_TIME }} 
              dimensions:
                pr: true
            - type: "gauge"
              name: "test.workflow.cpu"
              value: 98.5
            - type: "cumulative_counter"
              name: "test.workflow.executions"
              value: 1
      events: |
        - eventType: 'Test'
          dimensions: {dimension1: 'value1', dimension2: 'value2'}
          properties: {property1: 'value1', property2: 'value2'}
          category: 'USER_DEFINED'

Development

Install the dependencies

$ npm install

Lint, test and build the typescript and package it for distribution

$ npm run all

Run the tests ✔️

$ npm test

> [email protected] test /signalfx
> jest

 PASS  __tests__/main.test.ts
  unit-tests
    ✓ token 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 SFX_TOKEN env var is set
...
Ran all test suites.

When the SFX_TOKEN env var is set with a valid token, the tests will also perform an actual call sending some events.

Releasing a New Version

• Checkout main and pull the latest version
• npm run all
• Commit the result with a message like "Release Build v2"
• git push origin main
• Cut a release via GitHub UI 🙂