Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Update README with example image of trace #9

Merged
merged 1 commit into from
Feb 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
.env
otel-action
*.bak
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
<!-- markdownlint-disable MD033 MD013 -->
<h1 align="center">
<br>
OpenTelemetry Action
Expand All @@ -15,17 +14,22 @@
>
</a>
</p>
<!-- markdownlint-enable -->


---

<!-- markdownlint-disable-next-line MD002 -->
## About

`otel-action` is currently in early Alpha.
Branch `master` is not guaranteed to be stable and breaking changes may be
introduced without notice.
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)!

<p align="center">
<img
src="assets/honeycomb-example-trace.png"
alt="Honeycomb Example Trace"
>
</p>

## Example usage

Expand Down
Binary file added assets/honeycomb-example-trace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading