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

Minor improvements to example doc #6033

Merged
merged 4 commits into from
Dec 16, 2024
Merged

Minor improvements to example doc #6033

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
967625e
Minor improvements to example doc
cijothomas Dec 16, 2024
69b47ab
mdfix
cijothomas Dec 16, 2024
4af1481
Update examples/AspNetCore/README.md
cijothomas Dec 16, 2024
7980271
Update examples/AspNetCore/README.md
cijothomas Dec 16, 2024
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
28 changes: 24 additions & 4 deletions examples/AspNetCore/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OpenTelemetry ASP.NET Core 7 Web API Example
# OpenTelemetry ASP.NET Core Web API Example

This example uses the new WebApplication host that ships with .NET 7
This example uses the new WebApplication host that ships with .NET
and shows how to setup

1. OpenTelemetry logging
Expand All @@ -13,7 +13,27 @@ service name, version and the machine on which this program is running.
The sample rate is set to emit all the traces using `AlwaysOnSampler`.
You can try out different samplers like `TraceIdRatioBasedSampler`.

## Running Dependencies via Docker

The example by default writes telemetry to stdout. To enable telemetry export
via OTLP, update the `appsettings.json` file to replace `"console"` with
`"otlp"`. Launching the application will then send telemetry data via OTLP.

Use the provided [docker-compose](./docker-compose.yaml) file to spin up the
required dependencies, including:
cijothomas marked this conversation as resolved.
Show resolved Hide resolved

- **OTel Collector** Accept telemetry and forwards them to Tempo, Prometheus
- **Prometheus** to store metrics
- **Grafana (UI)** UI to view metrics, traces. (Exemplars can be used to jump
from metrics to traces)
- **Tempo** to store traces // TODO: Add a logging store also.

Once the Docker containers are running, you can access the **Grafana UI** at:
[http://localhost:3000/](http://localhost:3000/)

## References

* [ASP.NET Core 3.1 Example](https://github.com/open-telemetry/opentelemetry-dotnet/tree/98cb28974af43fc893ab80a8cead6e2d4163e144/examples/AspNetCore)
* [OpenTelemetry Project](https://opentelemetry.io/)
- [ASP.NET Core](https://learn.microsoft.com/aspnet/core/introduction-to-aspnet-core)
- [Docker](http://docker.com)
- [Prometheus](http://prometheus.io/docs)
- [Tempo](https://github.com/grafana/tempo)
Loading