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.

Sign up for GitHub

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: add Grafana dashboard link #878

Merged
merged 1 commit into from
Dec 31, 2024
Merged

docs: add Grafana dashboard link #878

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
Binary file added docs/instrumentation/grafana_dashboard.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions docs/instrumentation/metrics-cats-effect-io-runtime.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,13 @@ object Main extends IOApp.Simple {

@:@

## Grafana dashboard

You can use a Grafana [dashboard][grafana-dashboard] to visualize collected metrics.

@:image(grafana_dashboard.png) {
alt = Grafana Dashboard
}

## Customization

Expand Down Expand Up @@ -571,3 +578,5 @@ val config: IORuntimeMetrics.Config = {

IORuntimeMetrics.register[IO](runtime.metrics, config)
```

[grafana-dashboard]: https://grafana.com/grafana/dashboards/21487-cats-effect-runtime-metrics/
2 changes: 1 addition & 1 deletion docs/oteljava/tracing-context-propagation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ import org.typelevel.otel4s.trace.Tracer
object Main extends IOApp.Simple {
def program(tracer: Tracer[IO]): IO[Unit] =
tracer.span("test").use { span => // start 'test' span using otel4s
println(s"jctx: ${JSpan.current().getSpanContext}") // get a span from a ThreadLocal var
println(s"jctx: ${JSpan.current().getSpanContext}") // get a span from a ThreadLocal
IO.println(s"otel4s: ${span.context}")
}

Expand Down