Fork from Serilog.Sinks.OpenTelemetry, version 4.2.0-dev

Author: nblumhardt

.gitattributes

@@ -0,0 +1,3 @@
+# Auto detect text files and perform LF normalization
+
+* text=auto

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Report a bug and help us to improve Serilog.Sinks.OpenTelemetry
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+The Serilog maintainers want you to have a great experience using Serilog.Sinks.OpenTelemetry, and will happily track down and resolve bugs. We all have limited time, though, so please think through all of the factors that might be involved and include as much useful information as possible 😊.
+
+ℹ If the problem is caused by a sink or other extension package, please track down the correct repository for that package and create the report there: this tracker is for the **Serilog.Sinks.OpenTelemetry** package only.
+
+**Description**
+What's going wrong?
+
+**Reproduction**
+Please provide code samples showing how you're configuring and calling Serilog to produce the behavior.
+
+**Expected behavior**
+A concise description of what you expected to happen.
+
+**Relevant package, tooling and runtime versions**
+Which package versions are you using, on what platform?
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,4 @@
+contact_links:
+  - name: Ask for help
+    url: https://github.com/serilog/serilog/wiki/Usage-help
+    about: Ask the community for help on how to use Serilog

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an improvement to Serilog.Sinks.OpenTelemetry
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. `When [...], it would be great if [...]`.
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+# If this file is renamed, the incrementing run attempt number will be reset.
+
+name: CI
+
+on:
+  push:
+    branches: [ "dev", "main" ]
+  pull_request:
+    branches: [ "dev", "main" ]
+
+env:
+  CI_BUILD_NUMBER_BASE: ${{ github.run_number }}
+  CI_TARGET_BRANCH: ${{ github.head_ref || github.ref_name }}
+
+jobs:
+  build:
+
+    # The build must run on Windows so that .NET Framework targets can be built and tested.
+    runs-on: windows-latest
+
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 9.0.x
+      - name: Compute build number
+        shell: bash
+        run: |
+          echo "CI_BUILD_NUMBER=$(($CI_BUILD_NUMBER_BASE+2300))" >> $GITHUB_ENV
+      - name: Build and Publish
+        env:
+          DOTNET_CLI_TELEMETRY_OPTOUT: true
+          NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        shell: pwsh
+        run: |
+          ./Build.ps1

.gitignore

@@ -37,6 +37,12 @@ bld/
 # Uncomment if you have tasks that create the project's static files in wwwroot
 #wwwroot/
 
+# JetBrains Rider cache
+.idea/
+
+# VSCode cache
+.vscode/
+
 # Visual Studio 2017 auto generated files
 Generated\ Files/
 
@@ -82,8 +88,6 @@ StyleCopReport.xml
 *.pgc
 *.pgd
 *.rsp
-# but not Directory.Build.rsp, as it configures directory-level build defaults
-!Directory.Build.rsp
 *.sbr
 *.tlb
 *.tli
@@ -398,3 +402,6 @@ FodyWeavers.xsd
 
 # JetBrains Rider
 *.sln.iml
+/test/Serilog.Sinks.OpenTelemetry.Tests/PublicApiVisibilityTests.received.txt
+
+.DS_Store

Build.ps1

@@ -0,0 +1,79 @@
+Write-Output "build: Tool versions follow"
+
+dotnet --version
+dotnet --list-sdks
+
+Write-Output "build: Build started"
+
+Push-Location $PSScriptRoot
+try {
+    if(Test-Path .\artifacts) {
+        Write-Output "build: Cleaning ./artifacts"
+        Remove-Item ./artifacts -Force -Recurse
+    }
+
+    & dotnet restore --no-cache
+
+    $dbp = [Xml] (Get-Content .\Directory.Version.props)
+    $versionPrefix = $dbp.Project.PropertyGroup.VersionPrefix
+
+    Write-Output "build: Package version prefix is $versionPrefix"
+
+    $branch = @{ $true = $env:CI_TARGET_BRANCH; $false = $(git symbolic-ref --short -q HEAD) }[$NULL -ne $env:CI_TARGET_BRANCH];
+    $revision = @{ $true = "{0:00000}" -f [convert]::ToInt32("0" + $env:CI_BUILD_NUMBER, 10); $false = "local" }[$NULL -ne $env:CI_BUILD_NUMBER];
+    $suffix = @{ $true = ""; $false = "$($branch.Substring(0, [math]::Min(10,$branch.Length)) -replace '([^a-zA-Z0-9\-]*)', '')-$revision"}[$branch -eq "main" -and $revision -ne "local"]
+    $commitHash = $(git rev-parse --short HEAD)
+    $buildSuffix = @{ $true = "$($suffix)-$($commitHash)"; $false = "$($branch)-$($commitHash)" }[$suffix -ne ""]
+
+    Write-Output "build: Package version suffix is $suffix"
+    Write-Output "build: Build version suffix is $buildSuffix"
+
+    & dotnet build -c Release --version-suffix=$buildSuffix /p:ContinuousIntegrationBuild=true
+    if($LASTEXITCODE -ne 0) { throw "Build failed" }
+
+    foreach ($src in Get-ChildItem src/*) {
+        Push-Location $src
+
+        Write-Output "build: Packaging project in $src"
+
+        if ($suffix) {
+            & dotnet pack -c Release --no-build --no-restore  -o ../../artifacts --version-suffix=$suffix
+        } else {
+            & dotnet pack -c Release --no-build --no-restore  -o ../../artifacts
+        }
+        if($LASTEXITCODE -ne 0) { throw "Packaging failed" }
+
+        Pop-Location
+    }
+
+    foreach ($test in Get-ChildItem test/*.Tests) {
+        Push-Location $test
+
+        Write-Output "build: Testing project in $test"
+
+        & dotnet test -c Release --no-build --no-restore
+        if($LASTEXITCODE -ne 0) { throw "Testing failed" }
+
+        Pop-Location
+    }
+
+    if ($env:NUGET_API_KEY) {
+        # GitHub Actions will only supply this to branch builds and not PRs. We publish
+        # builds from any branch this action targets (i.e. main and dev).
+
+        Write-Output "build: Publishing NuGet packages"
+
+        foreach ($nupkg in Get-ChildItem artifacts/*.nupkg) {
+            & dotnet nuget push -k $env:NUGET_API_KEY -s https://api.nuget.org/v3/index.json "$nupkg"
+            if($LASTEXITCODE -ne 0) { throw "Publishing failed" }
+        }
+
+        if (!($suffix)) {
+            Write-Output "build: Creating release for version $versionPrefix"
+
+            iex "gh release create v$versionPrefix --title v$versionPrefix --generate-notes $(get-item ./artifacts/*.nupkg) $(get-item ./artifacts/*.snupkg)"
+        }
+    }
+} finally {
+    Pop-Location
+}

Directory.Build.props

@@ -0,0 +1,25 @@
+<Project>
+  <!-- Properties in this file are expected to be identical for all Serilog organization projects. If
+   a property value is project-specific, please record it in the CSPROJ file instead. -->
+  <Import Project="$(MSBuildThisFileDirectory)Directory.Version.props" />
+  <PropertyGroup>
+    <LangVersion>latest</LangVersion>
+    <TreatWarningsAsErrors>True</TreatWarningsAsErrors>
+    <!-- The condition is required to support BenchmarkDotNet -->
+    <SignAssembly Condition="Exists('$(MSBuildThisFileDirectory)assets/Serilog.snk')">true</SignAssembly>
+    <AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)assets/Serilog.snk</AssemblyOriginatorKeyFile>
+    <CheckEolTargetFramework>false</CheckEolTargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <PublishRepositoryUrl>true</PublishRepositoryUrl>
+    <EmbedUntrackedSources>true</EmbedUntrackedSources>
+    <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+  </PropertyGroup>
+  <ItemGroup Condition="'$(TargetFrameworkIdentifier)' == '.NETFramework'">
+    <Reference Include="System" />
+    <Reference Include="System.Core" />
+    <Reference Include="Microsoft.CSharp" />
+  </ItemGroup>
+</Project>

Directory.Version.props

@@ -0,0 +1,5 @@
+<Project>
+  <PropertyGroup>
+    <VersionPrefix>1.0.0</VersionPrefix>
+  </PropertyGroup>
+</Project>

README.md

@@ -1,2 +1,72 @@
-# serilog-sinks-opentelemetrysdk
-An experimental Serilog sink that writes log events directly to the OpenTelemetry SDK.
+# Serilog.Sinks.OpenTelemetrySdk [![Build status](https://github.com/serilog/serilog-sinks-opentelemetrysdk/actions/workflows/ci.yml/badge.svg?branch=dev)](https://github.com/serilog/serilog-sinks-opentelemetrysdk/actions) [![NuGet Version](https://img.shields.io/nuget/vpre/Serilog.Sinks.OpenTelemetrySdk.svg?style=flat)](https://www.nuget.org/packages/Serilog.Sinks.OpenTelemetrySdk/)
+
+This Serilog sink passes Serilog `LogEvents` to the OpenTelemetry SDK.
+
+> [!IMPORTANT] This package relies on experimental OpenTelemetry features.
+> It will only work with pre-release builds
+> of the .NET OpenTelemetry SDK. Because there's no guarantee that these 
+> experimental features will ever ship as stable APIs, there's also no guarantee
+> that a stable version of this sink will ever be available.
+
+## Getting started
+
+To use this sink, you should already have a **pre-release** (`-beta` or `-rc`) version of the OpenTeleme~~~~try SDK installed
+and configured.
+
+Install the [NuGet package](https://nuget.org/packages/serilog.sinks.opentelemetrysdk):
+
+```shell
+dotnet add package Serilog.Sinks.OpenTelemetrySdk
+```
+
+Then enable the sink using `WriteTo.OpenTelemetrySdk()`, passing your application's `IServiceProvider`:
+
+```csharp
+// var app = ...
+
+Log.Logger = new LoggerConfiguration()
+    .WriteTo.OpenTelemetrySdk(app.Services)
+    .CreateLogger();
+```
+
+Logs written with `Log.Information(...)` and similar methods will be output by the configured OpenTelemetry exporters.
+
+## Serilog `LogEvent` to OpenTelemetry log record mapping
+
+The following table provides the mapping between the Serilog log 
+events and the OpenTelemetry log records. 
+
+Serilog `LogEvent`               | OpenTelemetry `LogRecord`                  | Comments                                                                                      |
+---------------------------------|--------------------------------------------|-----------------------------------------------------------------------------------------------| 
+`Exception.GetType().ToString()` | `Attributes["exception.type"]`             |                                                                                               |
+`Exception.Message`              | `Attributes["exception.message"]`          | Ignored if empty                                                                              |
+`Exception.StackTrace`           | `Attributes[ "exception.stacktrace"]`      | Value of `ex.ToString()`                                                                      |
+`Level`                          | `LogRecordSeverity`                           | Serilog levels are mapped to corresponding OpenTelemetry severities                           | 
+`Level.ToString()`               | `SeverityText`                             |                                                                                               |
+`Message`                        | `Body`                                     | Culture-specific formatting can be provided via sink configuration                            |
+`MessageTemplate`                | `Attributes[ "message_template.text"]`     | Requires `IncludedData. MessageTemplateText` (enabled by default)                             |
+`MessageTemplate` (MD5)          | `Attributes[ "message_template.hash.md5"]` | Requires `IncludedData. MessageTemplateMD5 HashAttribute`                                     |
+`Properties`                     | `Attributes`                               | Each property is mapped to an attribute keeping the name; the value's structure is maintained |
+`SpanId` (`Activity.Current`)    | `SpanId`                                   | Requires `IncludedData.SpanIdField` (enabled by default)                                           |
+`Timestamp`                      | `TimeUnixNano`                             | .NET provides 100-nanosecond precision                                                        |
+`TraceId` (`Activity.Current`)   | `TraceId`                                  | Requires `IncludedData.TraceIdField` (enabled by default)                                          |
+
+Serialized data is passed using the `Dictionary<string, object?>` type. Logged arrays are passed as `List<object?>`.
+
+### Configuring included data
+
+This sink supports configuration of how common OpenTelemetry fields are populated from
+the Serilog `LogEvent` by passing `includedData`:
+
+```csharp
+Log.Logger = new LoggerConfiguration()
+    .WriteTo.OpenTelemetrySdk(app.Services, includedData: IncludedData.MessageTemplateTextAttribute)
+    .CreateLogger();
+```
+
+## Acknowledgements
+
+This sink is a fork of [`Serilog.Sinks.OpenTelemetry`](https://github.com/serilog/serilog-sinks-opentelemetry), which
+sends log events using the OpenTelemetry wire protocol, and does not have a dependency on the OpenTelemetry SDK.
+
+_Copyright &copy; Serilog Contributors - Provided under the [Apache License, Version 2.0](http://apache.org/licenses/LICENSE-2.0.html)._