The lightstep/lightstep-action-snapshot action takes a snapshot of a service in Lightstep and optionally attaches analysis of existing snapshot(s) to related pull requests or issues that helps developers understand how their production services change over time.

Snapshots help you correlate code changes in GitHub with latency and errors in different environments.

• Instrumented service(s) running in a production environment (create account here)
• Lightstep API key

This action can be run on ubuntu-latest GitHub Actions runner.

Taking a snapshot requires one step and no other dependencies:

    steps:  
      - name: Take Lightstep Snapshot
        id: lightstep-snapshot
        with:
          lightstep_api_key: ${{ secrets.LIGHTSTEP_API_KEY }}
          lightstep_organization: org
          lightstep_project: project
          # See https://api-docs.lightstep.com/reference#query-syntax
          # for supported queries.
          lightstep_snapshot_query: service IN ("frontend")

Most workflows will involve taking a snapshot and performing analysis on that snapshot, usually in the context of a GitHub PR or Issue. See examples below.

• Take a snapshot in response to an API trigger
• Take a snapshot after a deploy and get a report of what changed as a pull request comment
• Take a snapshot when a specific label is applied to an issue

The following are required and can also be passed as environment variables:

To take a snapshot, the following input is required:

To analyze a snapshot, the following input is required:

The following are optional:

This action can also be used with the act tool to run this action locally.

For example, this act with the example snapshot workflow in this repository to take a snapshot from a local environment:

  $ export LIGHTSTEP_API_KEY=your-api-key
  $ act deployment -s LIGHTSTEP_API_KEY=$LIGHTSTEP_API_KEY -W examples/workflows/snapshot.yml

Apache License 2.0