open-telemetry/opentelemetry-ruby-contrib

Follow semantic conventions for naming graphql spans

Aperta

#560 aperta il 13 lug 2023

Vedi su GitHubGuida contributor
 (4 commenti) (0 reazioni) (1 assegnatario)Ruby (252 fork)auto 404
good first issuehelp wantedinstrumentation-graphqlkeep

Metriche repository

Star
 (135 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

The current graphql instrumentation does not follow span naming conventions detailed here. The documentation states the following: The span name MUST be of the format <graphql.operation.type> <graphql.operation.name> provided that graphql.operation.type and graphql.operation.name are available. If graphql.operation.name is not available, the span SHOULD be named <graphql.operation.type>. When <graphql.operation.type> is not available, GraphQL Operation MAY be used as span name.

The relevant code looks to be here, where graphql.operation.type and graphql.operation.name are added as span attributes but the span is then named graphql.execute_query.

This change would also align with other libraries that already follow this convention, such as nodejs's instrumentation for graphql seen here.

Guida contributor

Direzione di ricerca
Modifica il nome dello span nel trace graphql per utilizzare il formato '<graphql.operation.type> <graphql.operation.name>' o fallback secondo specifica. Gestisci casi in cui tipo o nome operazione mancano. Fai riferimento all'implementazione nodejs.
Tech stack
ruby
Dominio
backendapi
Tipo issue
Manutenzione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitRuby
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75