Skip to content

mrtz-j/Saturn.OpenTelemetry

Repository files navigation

built with nix

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

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:

dotnet add package Saturn.OpenTelemetry

Basic use case:

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
[<EntryPoint>]
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.

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.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

A OpenTelemetry Extension for Saturn

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •