serilog-contrib
diff --git a/‎.config/dotnet-tools.json‎
Lines changed: 14 additions & 0 deletions b/‎.config/dotnet-tools.json‎
Lines changed: 14 additions & 0 deletions
diff --git a/‎.editorconfig‎
Lines changed: 114 additions & 0 deletions b/‎.editorconfig‎
Lines changed: 114 additions & 0 deletions
diff --git a/‎.gitattributes‎
Lines changed: 9 additions & 0 deletions b/‎.gitattributes‎
Lines changed: 9 additions & 0 deletions
diff --git a/‎.github/ISSUE_TEMPLATE/bug_report.yml‎
Lines changed: 1 addition & 1 deletion b/‎.github/ISSUE_TEMPLATE/bug_report.yml‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎.github/dependabot.yml‎
Lines changed: 7 additions & 0 deletions b/‎.github/dependabot.yml‎
Lines changed: 7 additions & 0 deletions
diff --git a/‎.github/workflows/benchmark.yml‎
Lines changed: 195 additions & 0 deletions b/‎.github/workflows/benchmark.yml‎
Lines changed: 195 additions & 0 deletions
@@ -0,0 +1,14 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "fantomas": {
+      "version": "7.0.5",
+      "commands": ["fantomas"]
+    },
+    "husky": {
+      "version": "0.9.1",
+      "commands": ["husky"]
+    }
+  }
+}
@@ -0,0 +1,114 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 4
+insert_final_newline = false
+trim_trailing_whitespace = true
+
+# YAML conventionally uses 2-space indentation
+[*.{yml,yaml}]
+indent_size = 2
+
+# Markdown: a trailing double-space is a hard line break
+[*.md]
+trim_trailing_whitespace = false
+
+# ── F# — Fantomas ──────────────────────────────────────────────────────────────
+# Read by the Fantomas CLI, the Husky pre-commit hook, and Rider's F# formatter.
+# max_line_length pins the Fantomas default; aligned brackets (dotnet/fsharp
+# compiler style) and the blank-line cap are deliberate choices.
+[*.{fs,fsx}]
+max_line_length = 120
+fsharp_multiline_bracket_style = aligned
+fsharp_keep_max_number_of_blank_lines = 1
+
+[*.cs]
+# ── StyleCop.Analyzers.Unstable — rule severity ───────────────────────────────
+# Rule decisions: documentation and file-header rules off; spacing, layout,
+# ordering and naming enforced as errors.
+
+# SA0001/SA0002 — disable to avoid requiring GenerateDocumentationFile everywhere
+dotnet_diagnostic.SA0001.severity = none
+dotnet_diagnostic.SA0002.severity = none
+
+# SA1003 — symbol spacing (None)
+dotnet_diagnostic.SA1003.severity = none
+# SA1009 — closing parenthesis spacing (None)
+dotnet_diagnostic.SA1009.severity = none
+# SA1012 — opening brace spacing (None)
+dotnet_diagnostic.SA1012.severity = none
+# SA1013 — closing brace spacing (None)
+dotnet_diagnostic.SA1013.severity = none
+
+# SA1101 — do NOT require this. prefix (SX1101 requires no this. prefix)
+dotnet_diagnostic.SA1101.severity = none
+dotnet_diagnostic.SX1101.severity = error
+
+# SA1200 — using directives placement; modern C# allows file-scoped usings
+dotnet_diagnostic.SA1200.severity = none
+
+# SA1305/SA1306/SA1309 — naming: allow lowercase private fields, _prefix
+dotnet_diagnostic.SA1305.severity = none
+dotnet_diagnostic.SA1306.severity = none
+dotnet_diagnostic.SA1309.severity = none
+
+# SA1401 — fields may be public (e.g. test fixtures, records)
+dotnet_diagnostic.SA1401.severity = none
+
+# SA1412/SA1413 — file encoding / trailing comma (flexible)
+dotnet_diagnostic.SA1412.severity = none
+dotnet_diagnostic.SA1413.severity = none
+
+# SA1518 — no trailing newline requirement
+dotnet_diagnostic.SA1518.severity = none
+
+# SA1506/SA1514 — blank line rules (flexible)
+dotnet_diagnostic.SA1506.severity = none
+dotnet_diagnostic.SA1514.severity = none
+
+# SA1600–SA1651 — all documentation rules disabled
+dotnet_diagnostic.SA1600.severity = none
+dotnet_diagnostic.SA1601.severity = none
+dotnet_diagnostic.SA1602.severity = none
+dotnet_diagnostic.SA1604.severity = none
+dotnet_diagnostic.SA1605.severity = none
+dotnet_diagnostic.SA1606.severity = none
+dotnet_diagnostic.SA1607.severity = none
+dotnet_diagnostic.SA1608.severity = none
+dotnet_diagnostic.SA1610.severity = none
+dotnet_diagnostic.SA1611.severity = none
+dotnet_diagnostic.SA1612.severity = none
+dotnet_diagnostic.SA1613.severity = none
+dotnet_diagnostic.SA1614.severity = none
+dotnet_diagnostic.SA1615.severity = none
+dotnet_diagnostic.SA1616.severity = none
+dotnet_diagnostic.SA1617.severity = none
+dotnet_diagnostic.SA1618.severity = none
+dotnet_diagnostic.SA1619.severity = none
+dotnet_diagnostic.SA1620.severity = none
+dotnet_diagnostic.SA1621.severity = none
+dotnet_diagnostic.SA1622.severity = none
+dotnet_diagnostic.SA1623.severity = none
+dotnet_diagnostic.SA1624.severity = none
+dotnet_diagnostic.SA1625.severity = none
+dotnet_diagnostic.SA1626.severity = none
+dotnet_diagnostic.SA1627.severity = none
+dotnet_diagnostic.SA1629.severity = none
+
+# SA1633–SA1651 — file header and copyright rules disabled
+dotnet_diagnostic.SA1633.severity = none
+dotnet_diagnostic.SA1634.severity = none
+dotnet_diagnostic.SA1635.severity = none
+dotnet_diagnostic.SA1636.severity = none
+dotnet_diagnostic.SA1637.severity = none
+dotnet_diagnostic.SA1638.severity = none
+dotnet_diagnostic.SA1640.severity = none
+dotnet_diagnostic.SA1641.severity = none
+dotnet_diagnostic.SA1642.severity = none
+dotnet_diagnostic.SA1643.severity = none
+dotnet_diagnostic.SA1648.severity = none
+dotnet_diagnostic.SA1649.severity = error
+dotnet_diagnostic.SA1651.severity = none
@@ -0,0 +1,9 @@
+# Normalise all text files to LF in the repository and on checkout.
+# Eliminates the "LF will be replaced by CRLF" warning on Windows.
+* text=auto eol=lf
+
+# Explicitly mark binary assets so git never attempts line-ending conversion.
+*.snk  binary
+*.png  binary
+*.dll  binary
+*.exe  binary
@@ -8,7 +8,7 @@ body:
     id: sink-version
     attributes:
       label: Which version of Serilog.Sinks.Grafana.Loki are you using?
-      placeholder: v8.0.0
+      placeholder: v9.0.0
     validations:
       required: true
   - type: input
 
@@ -9,6 +9,13 @@ updates:
     directory: "/" # Location of package manifests
     schedule:
       interval: "daily"
+    ignore:
+      # Benchmark baselines are deliberate pins (benchmarks/*/*.fsproj VersionOverride):
+      # the previously published release the suite measures against, and the third-party
+      # yardstick. Bump them consciously — together with the recorded numbers in
+      # benchmarks/README.md — not via bot PRs.
+      - dependency-name: "Serilog.Sinks.Grafana.Loki"
+      - dependency-name: "Serilog.Sinks.Loki.YetAnother"
 
   - package-ecosystem: "github-actions"
     directory: "/" # Location of package manifests
 
@@ -0,0 +1,195 @@
+name: "Benchmarks"
+
+# Compares the benchmark suite of this source tree against the latest published
+# NuGet package, so a PR shows whether it changes performance.
+#
+# - On pull requests touching the library or the benchmarks: runs the end-to-end
+#   sink group (the regression target) for the NuGet baseline and the PR source,
+#   posts a comparison table to the run summary and as a sticky PR comment.
+# - On manual dispatch: same, plus the YetAnother yardstick and a custom filter.
+#
+# Reading the numbers: `Allocated` is exact and deterministic even on shared
+# runners — that is the regression signal. `Mean` is indicative only (noisy VMs).
+
+on:
+  pull_request:
+    paths:
+      - 'src/**'
+      - 'benchmarks/**'
+      - 'Directory.Packages.props'
+  workflow_dispatch:
+    inputs:
+      filter:
+        description: "BenchmarkDotNet --filter glob"
+        required: false
+        default: '*'
+      include_yetanother:
+        description: 'Also run the Serilog.Sinks.Loki.YetAnother yardstick'
+        type: boolean
+        required: false
+        default: true
+
+permissions:
+  contents: read
+  pull-requests: write   # sticky benchmark comment on same-repo PRs
+
+concurrency:
+  group: bench-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  DOTNET_CLI_TELEMETRY_OPTOUT: true
+  DOTNET_NOLOGO: true
+  HUSKY: 0
+  # PRs run only the end-to-end sink group to keep the job short; manual runs take the input.
+  BENCH_FILTER: ${{ github.event_name == 'workflow_dispatch' && inputs.filter || '*Sink*' }}
+
+jobs:
+  benchmark:
+    name: Baseline vs source
+    runs-on: ubuntu-latest
+    timeout-minutes: 90
+    steps:
+      # Full history + tags for MinVer (the V9 project builds ../src).
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v5.2.0
+        with:
+          dotnet-version: |
+            8.x
+            9.x
+            10.x
+
+      - name: Cache NuGet packages
+        uses: actions/cache@v4
+        with:
+          path: ~/.nuget/packages
+          key: nuget-${{ runner.os }}-${{ hashFiles('Directory.Packages.props', '**/*.fsproj', '**/*.csproj') }}
+          restore-keys: nuget-${{ runner.os }}-
+
+      - name: Resolve baseline version (latest on NuGet)
+        id: baseline
+        run: |
+          # Keep in sync with the BaselineVersion default in the V8 benchmark fsproj.
+          # The latest NuGet version is used only when it shares that pin's API major:
+          # a different major means a different public API, and the baseline project's
+          # Benchmarks.fs must be migrated before the pin can move.
+          pinned='8.3.2'
+          latest=$(curl -fsSL https://api.nuget.org/v3-flatcontainer/serilog.sinks.grafana.loki/index.json | jq -r '.versions | last')
+          if [ "${latest%%.*}" = "${pinned%%.*}" ]; then
+            version="$latest"
+            note='latest on NuGet'
+          else
+            version="$pinned"
+            note="pinned; latest on NuGet is $latest, whose API major differs - migrate the baseline benchmark project to move the pin"
+          fi
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+          echo "note=$note" >> "$GITHUB_OUTPUT"
+          echo "Baseline: Serilog.Sinks.Grafana.Loki $version ($note)"
+
+      - name: Run baseline (NuGet ${{ steps.baseline.outputs.version }})
+        run: >
+          dotnet run -c Release
+          --project benchmarks/Serilog.Sinks.Grafana.Loki.Benchmarks.V8
+          -p:BaselineVersion=${{ steps.baseline.outputs.version }}
+          -- --filter "$BENCH_FILTER"
+
+      - name: Run source
+        run: >
+          dotnet run -c Release
+          --project benchmarks/Serilog.Sinks.Grafana.Loki.Benchmarks.V9
+          -- --filter "$BENCH_FILTER"
+
+      - name: Run YetAnother yardstick
+        if: github.event_name == 'workflow_dispatch' && inputs.include_yetanother
+        run: >
+          dotnet run -c Release
+          --project benchmarks/Serilog.Sinks.Grafana.Loki.Benchmarks.YetAnother
+          -- --filter "$BENCH_FILTER"
+
+      - name: Build comparison report
+        env:
+          BASELINE_VERSION: ${{ steps.baseline.outputs.version }}
+          BASELINE_NOTE: ${{ steps.baseline.outputs.note }}
+        run: |
+          v8="benchmarks/Serilog.Sinks.Grafana.Loki.Benchmarks.V8/bin/Release/net8.0/BenchmarkDotNet.Artifacts"
+          v9="benchmarks/Serilog.Sinks.Grafana.Loki.Benchmarks.V9/bin/Release/net8.0/BenchmarkDotNet.Artifacts"
+          ya="benchmarks/Serilog.Sinks.Grafana.Loki.Benchmarks.YetAnother/bin/Release/net8.0/BenchmarkDotNet.Artifacts"
+
+          {
+            echo '## Benchmark comparison'
+            echo ''
+            echo "Baseline: \`Serilog.Sinks.Grafana.Loki $BASELINE_VERSION\` ($BASELINE_NOTE) vs **this source**."
+            echo ''
+            echo '> `Allocated` is exact and deterministic — treat it as the regression signal.'
+            echo '> `Mean` on shared CI runners is noisy; deltas within ±10% are not meaningful.'
+            echo ''
+            dotnet fsi benchmarks/compare-results.fsx "$v8" "$v9" "v$BASELINE_VERSION" 'source'
+            if [ -d "$ya" ]; then
+              echo ''
+              echo '### vs Serilog.Sinks.Loki.YetAnother (yardstick)'
+              echo ''
+              dotnet fsi benchmarks/compare-results.fsx "$ya" "$v9" 'YetAnother' 'source'
+            fi
+          } > benchmark-report.md
+
+          cat benchmark-report.md >> "$GITHUB_STEP_SUMMARY"
+
+      - name: Append full BenchmarkDotNet tables to the run summary
+        run: |
+          find benchmarks -path '*BenchmarkDotNet.Artifacts*' -name '*-report-github.md' | sort | while read -r f; do
+            proj=$(echo "$f" | sed -E 's#.*Benchmarks\.([^/]+)/bin.*#\1#')
+            {
+              echo "<details><summary>$proj — $(basename "$f" .md)</summary>"
+              echo ''
+              cat "$f"
+              echo ''
+              echo '</details>'
+              echo ''
+            } >> "$GITHUB_STEP_SUMMARY"
+          done
+
+      - name: Upload raw results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: benchmark-results
+          path: benchmarks/**/BenchmarkDotNet.Artifacts/results/*
+
+      # Forked PRs get a read-only token and cannot comment; the run summary covers them.
+      - name: Post sticky PR comment
+        if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const fs = require('fs');
+            const marker = '<!-- benchmark-report -->';
+            let body = marker + '\n' + fs.readFileSync('benchmark-report.md', 'utf8');
+            if (body.length > 65000) {
+              body = body.slice(0, 65000) + '\n\n_…truncated — see the workflow run summary for the full report._';
+            }
+            const { data: comments } = await github.rest.issues.listComments({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+              per_page: 100,
+            });
+            const existing = comments.find((c) => c.body && c.body.startsWith(marker));
+            if (existing) {
+              await github.rest.issues.updateComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: existing.id,
+                body,
+              });
+            } else {
+              await github.rest.issues.createComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: context.issue.number,
+                body,
+              });
+            }