Description
Now that we have OTEL, add DAB info
The current OTEL implementation only has generic/basic ASPNET information.
Traces:
https://github.com/Azure/data-api-builder/blob/jerry-otel-design/docs/design/otel-trace.md
Trace: DAB Request
│ ├── Tags:
│ │ ├── trace_id: <unique_trace_id>
│ │ ├── service.name: "Data API Builder"
│ │ ├── deployment.environment: "production" (or "development")
│
├── Activity: Request Setup
│ ├── Tags:
│ │ ├── http.method: "GET" | "POST" | "PUT" | "DELETE"
│ │ ├── action.type: "CREATE" | "READ" | "UPDATE" | "DELETE" | "EXECUTE"
│ │ ├── http.status_code: "200" | "400" | "500"
│ │ ├── http.url: "/api/entity"
│ │ ├── http.querystring: "?xyz" {only when mode = development}
│ │ ├── user.role: "Anonymous"
│ │ ├── api.type: "REST" | "GRAPHQL"
│ │ ├── api.entity: "User"
│ │ │
│ ├── Span: Validate Request Context
│ │ ├── Tags:
│ │ │ ├── validation.result: "Success" | "Failure"
│ │ ├── Event: Validation Error (if any)
│ │ ├── Tags: { error.message: "<error_details>", error.type: "<exception_type>" }
│ │
│ ├── Span: Process Request
│ │ │
│ │ ├── Event: Error (if any)
│ │ ├── Tags: { error.message: "<error_details>", error.type: "<exception_type>" }
│ │
│ ├── Span: Format Response
│ │ │
│ │ ├── Event: Response Sent
│ │ ├── Tags: { event.name: "Response Sent", timestamp: <time> }
│
└── Activity: Database Query
├── Tags:
│ ├── data-source.name: {data-source.telemetry.name}
│ ├── data-source.type: "mssql" | "mysql" | "postgresql" | "cosmos" | "sqldw"
│ ├── db.operation: "SELECT" | "INSERT" | "UPDATE" | "DELETE" | "EXECUTE"
│ ├── db.statement: "<SQL_query_text>" {only when mode = development}
│
├── Span: Data Operation
│ │ ├── query.rows_returned: <num_rows>
│ │ ├── query.mb_returned: <double>
│ │ ├── query.used_cache: true | false
│ │
│ ├── Event: Cache Returned
│ │
│ ├── Event: Connection Opened
│ │
│ ├── Event: Query Executed
│ │
│ ├── Event: Connection Opened
│ │
│ ├── Event: Error (if any)
│ ├── Tags: { error.message: "<error_details>", error.type: "<exception_type>" }
Metrics:
TelemetryHelper.cs
using System;
using System.Diagnostics.Metrics;
public static class TelemetryHelper
{
private static readonly Meter Meter = new("Dab.Metrics");
private static readonly Counter<long> RequestsTotal = Meter.CreateCounter<long>("requests_total");
private static readonly UpDownCounter<long> RequestsActive = Meter.CreateUpDownCounter<long>("requests_active");
private static readonly Counter<long> RequestErrors = Meter.CreateCounter<long>("request_errors");
public static void TrackRequest(string method, string statusCode, string endpoint, string apiType)
{
RequestsTotal.Add(1,
new("method", method),
new("status_code", statusCode),
new("endpoint", endpoint),
new("api_type", apiType));
}
public static void TrackError(string method, string statusCode, string endpoint, string apiType, Exception ex)
{
RequestErrors.Add(1,
new("method", method),
new("status_code", statusCode),
new("endpoint", endpoint),
new("api_type", apiType),
new("error_type", ex.GetType().Name));
}
public static void IncrementActiveRequests() => RequestsActive.Add(1);
public static void DecrementActiveRequests() => RequestsActive.Add(-1);
}Then use it like.
[HttpGet]
public IActionResult GetAsync(...)
{
TelemetryHelper.IncrementActiveRequests();
try
{
// Simulating success
TelemetryHelper.TrackRequest("GET", "200", "User", "REST");
return Ok(new { Message = "Hello, World!" });
}
catch (Exception ex)
{
TelemetryHelper.TrackError("GET", "500", "User", "REST", ex);
return StatusCode(500, new { Error = "An error occurred" });
}
finally
{
TelemetryHelper.DecrementActiveRequests();
}
}