Azure / Azure/data-api-builder
[Bug]: All 4 custom DAB metrics have empty descriptions
- Lingua principale
- C#
- Stelle
- 1.5k
- Fork
- 370
- Merge medio
- 3g 22h
- PR unite (30g)
- 9
Descrizione
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](https://opentelemetry.io/docs/specs/otel/metrics/api/#instrument):
```
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`).
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Cerca nel repository lo scope di strumentazione DataApiBuilder.Metrics e i quattro nomi delle metriche. Controlla come sono configurati i relativi descrittori, aggiungi le descrizioni leggibili dall’uomo indicate nell’issue e correggi le unità mancanti segnalate per le metriche di conteggio. Esegui i test pertinenti delle metriche o della strumentazione, se presenti, e verifica che i descrittori esportati siano valorizzati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- csharp
- Ambito
- observability
- Tipo di issue
- Bug
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Tranquilla
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 70/100