Azure / Azure/data-api-builder

[Enh]: Improve health endpoint with filters

Aperta
#3,278 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
2.x health-endpoint
Lingua principale
C#
Stelle
1.5k
Fork
370
Merge medio
3g 22h
PR unite (30g)
9

Descrizione

## What

Make the health endpoint easier to use.

### Introduce tag filters

Support filtering health checks by tag using query parameters.

```
https://localhost:5000/health?tag=rest
https://localhost:5000/health?tag=graphql
https://localhost:5000/health?tag=mcp
https://localhost:5000/health?tag=endpoint
https://localhost:5000/health?tag=data-source
```

Support compound filters by specifying multiple tags.

```
https://localhost:5000/health?tag=rest&tag=graphql
```

### Introduce easy aliases

Provide simple aliases for common filters so they are easy to demo and remember.

```
https://localhost:5000/health/rest
https://localhost:5000/health/graphql
https://localhost:5000/health/mcp
https://localhost:5000/health/data-source
```

These routes internally translate to the equivalent tag filter.

```
/health/rest -> /health?tag=rest
/health/graphql -> /health?tag=graphql
/health/mcp -> /health?tag=mcp
/health/data-source -> /health?tag=data-source
```

### Introduce UI

Introduce a path that consumes the health report and renders it as a web page.

```
https://localhost:5000/health/ui
```

A similar feature is already present in our extension: https://marketplace.visualstudio.com/items?itemName=jerry-nixon.health-data-api-builder

> [!NOTE]
> This feature will shine. A valuable part of our Aspire story. An important link to emit with `dab start`.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia dal punto di ingresso dell’endpoint di health e confronta i percorsi di query e alias richiesti con il report di health esistente. Controlla gli esempi nell’issue, inclusi i parametri tag ripetuti e /health/ui; è completato quando i filtri e gli alias restituiscono il report previsto e la UI visualizza quel report.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
csharp, graphql
Ambito
api, observability, web-dev
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.