https://github.com/mnthomson/otel-action

🔭 Create & upload OpenTelemetry traces of a GitHub actions workflow run to an OTLP compatible endpoint
https://github.com/mnthomson/otel-action

action actions golang observability opentelemetry tracing

Last synced: 9 days ago
JSON representation

🔭 Create & upload OpenTelemetry traces of a GitHub actions workflow run to an OTLP compatible endpoint

• Host: GitHub
• URL: https://github.com/mnthomson/otel-action
• Owner: MNThomson
• License: mit
• Created: 2022-09-05T00:07:55.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-07T05:04:04.000Z (5 months ago)
• Last Synced: 2024-10-29T03:15:41.318Z (18 days ago)
• Topics: action, actions, golang, observability, opentelemetry, tracing
• Language: Go
• Homepage: https://mnt.dev
• Size: 154 KB
• Stars: 6
• Watchers: 1
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    


        OpenTelemetry Action

    






    Upload OpenTelemetry traces of a GitHub actions workflow run





    

        

    



---

## About

Running `otel-action` at the end of a GitHub workflow will upload [OpenTelemetry](https://opentelemetry.io/) spans for each job (and job step) to an OTel compatible endpoint. This provides observability into CI pipelines, and provides a quick method to find offending commits that are the root cause of a CI job becoming slower.

Below is an example trace from this repository's [test workflow](.github/workflows/test.yml) being viewed in [Honeycomb.io](https://www.honeycomb.io/)'s UI (they have an awesome free-forever tier)!



    



## Example usage

```yaml

- name: Upload OTEL traces

  uses: MNThomson/otel-action@master

  with:

    endpoint: ${{ secrets.ENDPOINT }}

    headers: ${{ secrets.HEADERS }}

    service_name: "MyDatasetName"

```

Checkout the [`test.yml`](.github/workflows/test.yml) worflow as well.