Saturn.OpenTelemetry 0.5.0-alpha

This is a prerelease version of Saturn.OpenTelemetry.

There is a newer prerelease version of this package available.
See the version list below for details.

dotnet add package Saturn.OpenTelemetry --version 0.5.0-alpha

NuGet\Install-Package Saturn.OpenTelemetry -Version 0.5.0-alpha

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Saturn.OpenTelemetry" Version="0.5.0-alpha" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Saturn.OpenTelemetry --version 0.5.0-alpha

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Saturn.OpenTelemetry, 0.5.0-alpha"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install Saturn.OpenTelemetry as a Cake Addin
#addin nuget:?package=Saturn.OpenTelemetry&version=0.5.0-alpha&prerelease

// Install Saturn.OpenTelemetry as a Cake Tool
#tool nuget:?package=Saturn.OpenTelemetry&version=0.5.0-alpha&prerelease

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Saturn.OpenTelemetry

Includes a small Telemetry wrapper for the dotnet ActivitySource, to make it more compatible with other OpenTelemetry applications in other languages.

About
Getting Started
LGTM-Stack
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:

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 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.

License

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

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.