DiamondLightSource / DiamondLightSource/blueapi
Update docs to cover changes due to adding tracing
- Lingua principale
- Python
- Stelle
- 13
- Fork
- 13
- Merge medio
- 2g 11h
- PR unite (30g)
- 25
Descrizione
The addition of traceability require the setting of several Environment variable to make the export to Jaeger to work properly. THis should be reflected in the BlueAPI Documentation
e.g. at startup using the format
`docker run -d --rm -e OLTP_FOO=true -e OLTP_BAR=false blueapi:latest`
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Inizia con la BlueAPI Documentation e traccia la configurazione di tracciabilità utilizzata per l’esportazione a Jaeger. Identifica le variabili d’ambiente richieste all’avvio e documenta un’invocazione di Docker che le utilizzi, basandoti sull’esempio nell’issue. Il lavoro è completato quando la documentazione spiega chiaramente le impostazioni richieste.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- docker, python
- Ambito
- documentation, observability
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 55/100