[Bug]: All 4 custom DAB metrics have empty descriptions

Open Beginner friendly
#3,562 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
70/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Quiet
Tech stack
csharp
Domain
observability

Research direction

Search the repository for the DataApiBuilder.Metrics instrumentation scope and the four metric names. Inspect how their descriptors are configured, add the human-readable descriptions from the issue, and address the missing units noted for the count metrics. Run the relevant metrics or instrumentation tests, if present, and verify the exported descriptors are populated.

Written by the indexing model from the issue text.

Description

2.x telemetry

The DataApiBuilder.Metrics instrumentation scope defines 4 metrics (active_requests, total_requests, total_errors, request_duration), but none of them include a Description field. This violates OTEL best practices and makes metrics harder to understand in dashboards and alerting tools.

Expected

Each metric should include a human-readable description, per the OTEL metric semantic conventions:

Metric: active_requests
Description: "Number of in-flight API requests currently being processed"

Metric: total_requests
Description: "Cumulative count of completed API requests"

Metric: total_errors
Description: "Cumulative count of failed API requests"

Metric: request_duration
Description: "Duration of API request processing in milliseconds"

Actual

All 4 metrics export with blank descriptions:

Descriptor:
     -> Name: active_requests
     -> Description:
     -> Unit:

The Unit field is also empty for active_requests, total_requests, and total_errors (only request_duration correctly sets Unit: ms).

Dominant language
C#
Stars
1.5k
Forks
372
Avg merge
3d 8h
Merged PRs (30d)
7

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Azure/data-api-builder

All issues in Azure/data-api-builder

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.