Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrtz-j/saturn.opentelemetry
A OpenTelemetry Extension for Saturn
https://github.com/mrtz-j/saturn.opentelemetry
fsharp opentelemetry saturn
Last synced: about 1 month ago
JSON representation
A OpenTelemetry Extension for Saturn
- Host: GitHub
- URL: https://github.com/mrtz-j/saturn.opentelemetry
- Owner: mrtz-j
- License: mit
- Created: 2024-09-23T21:27:34.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-27T08:20:24.000Z (3 months ago)
- Last Synced: 2024-10-27T09:27:02.310Z (3 months ago)
- Topics: fsharp, opentelemetry, saturn
- Language: Nix
- Homepage:
- Size: 73.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Saturn.OpenTelemetry
Includes a small `Telemetry` wrapper for the dotnet `ActivitySource`, to make it more compatible
with other OpenTelemetry applications in other languages.
## Table of Contents
- [About](#about)
- [Getting Started](#getting-started)
- [LGTM-Stack](#lgtm-stack-locally)
- [License](#license)
## About
`Saturn.OpenTelemetry` is a library that extends the `Saturn` Web Application framework with functionality to integrate OpenTelemetry for distributed tracing and metrics. This means that you can easily add observability to your Saturn applications, allowing you to monitor and analyze the performance and behavior of your services.
Inspired by the OpenTelemetry .NET SDK, but adapted to work seamlessly with Saturn's functional programming model and F# syntax.
## Getting Started
Add the `Saturn.OpenTelemetry` NuGet package to your project:
```bash
dotnet add package Saturn.OpenTelemetry
```
Basic use case:
```fsharp
open Saturn
open Saturn.OpenTelemetry
// General OpenTelemetry Configuration
let otelConfig: OtelConfig = {
Endpoint = "http://localhost:4317"
AppId = "Example"
Namespace = "Saturn"
Version = "1.0.0"
}
// Add OpenTelemetry to the Saturn pipeline
let app = application {
use_router webAppRouter
url "http://0.0.0.0:8085/"
use_otel (
configure_otel {
// These are required
settings otelConfig
// These are optional and can be used to enable specific features
// use_efcore
// use_redis
// use_openfga
}
)
use_static "static"
memory_cache
use_gzip
}
// Start the application and Initialize OpenTelemetry
[]
let main _ =
Telemetry.init otelConfig.AppId
run app
0
```
## LGTM stack locally
You can deploy the LGTM (Loki, Grafana, Tempo and Mirmir) stack locally for development purposes.
```console
docker run -p 3002:3000 -p 4317:4317 -p 4318:4318 --rm -ti grafana/otel-lgtm
```
This will spin up a container listening for OTEL traces on port 4317 and 4318 and can be accessed on port 3002.
A slightly pimped version of the classic otel-lgtm container preconfigured with DotNet and Dapr dashboards, is
available [here](https://github.com/juselius/otel-lgtm).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.