Skip to content
Telemetry
Integration guide

.NET and Serilog structured event analytics

Add a focused Telemetry outcome event beside Serilog diagnostics for ASP.NET request latency, failures, releases, and customer impact.

Reviewed by the Telemetry product team on . We checked which events to send, which data to exclude, and how to add the code. Who reviews this page

Useful for
  • ASP.NET API monitoring
  • Serilog correlation
  • Dependency reliability
Test the integration

Send and verify events with .NET and Serilog structured event analytics

Use .NET and Serilog structured event analytics where your app knows the final result. Collect only the fields you need, then verify a test event before building charts.

  1. 1

    Choose the outcome

    ASP.NET API monitoring

  2. 2

    Define the contract

    route_template, method, status_code, and status

  3. 3

    Log the final result

    Keep detailed exceptions in Serilog while sending a controlled error_type to Telemetry.

  4. 4

    Check the stored event

    Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.

Before you start

Before you start

  • A server-side TELEMETRY_API_KEY
  • Named ASP.NET endpoints
  • An HttpClient with a short timeout

Delivery setup

Install and initialize server-side

Use one shared HttpClient with a server-side key, a short timeout, and a small allowlisted Log API wrapper. Keep ingestion credentials out of browser bundles, client-visible environment variables, source control, logs, and exception messages.

  1. 1Create one reusable server-side client. Set its timeout and retry limit.
  2. 2Log an event when the operation succeeds, fails, retries, or times out.
  3. 3Send test events with known results and inspect the stored rows before enabling an alert.

Snippet

Start with one structured event

Add this shape where the workflow completes, fails, or retries. Then build the dashboard from real fields.

dotnet-serilog

.NET and Serilog structured event analytics event

csharp
await telemetryClient.LogAsync("api_request_completed", new {
    route_template = context.GetEndpoint()?.DisplayName ?? "unmatched",
    method = context.Request.Method,
    status_code = context.Response.StatusCode,
    status = context.Response.StatusCode >= 500 ? "failed" : "success",
    latency_ms = stopwatch.Elapsed.TotalMilliseconds,
    trace_id = Activity.Current?.TraceId.ToString(),
    release = configuration["APP_RELEASE"]
});

Event schema

route_template, method, status_code, and status

latency_ms, trace_id, error_type, and dependency

environment, release, and safe tenant identifiers

Check your setup

Checkpoint 1

Keep detailed exceptions in Serilog while sending a controlled error_type to Telemetry.

Checkpoint 2

Read the matched endpoint route pattern rather than Request.Path.

Checkpoint 3

Propagate Activity trace identifiers for correlation without duplicating spans.

Verification

Prove the event arrived

Run this after exercising known success and failure cases. Replace the fallback table name if your final event contract differs from the snippet.

dotnet-serilog-verification

.NET and Serilog structured event analytics verification query

sql
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;
Confirm one terminal row per logical outcome, with the expected status, identifiers, units, and UTC time.
Inspect the inferred schema and verify that retries do not change field types or generate a new logical event ID.
Search the stored fields for credentials, raw payloads, prompts, private content, and unbounded error messages.
Exercise a provider timeout, ingestion rejection, and process shutdown before treating the dashboard as complete.

Implementation references

Review the event contract, data-safety guidance, and upstream primary documentation before enabling a new production path.

Where to log

Keep the outcome event small and recoverable

This pattern provides

  • Record the outcome as an event you can query with SQL.
  • Stable fields for dashboards, alerts, and cross-event correlation.
  • Test events for checking success, failure, retries, and timeouts.

This pattern does not provide

  • An OTLP exporter, automatic collection pipeline, or replacement for detailed traces and diagnostic logs.
  • Exactly-once delivery merely because the payload contains an event ID.
  • Permission to collect raw provider payloads, user content, credentials, or regulated data.

Example event schemas

Check what each event records, when to send it, and which field types it needs. Review the example payload and privacy checklist before using it in production.

Use these queries in Telemetry

Learn about Alerts

Add a threshold and recipients to your reliability query to get alerts.

Related SQL recipes

More SQL recipes

Run the query using this workflow's event fields and check the example result. Save the result to a dashboard or set up an alert.

Browse all recipes
Recipe collectionsAPI reliability SQL

Browse by implementation family

Compare related integration patterns

Templates to pair with this integration

More integrations