[chore] move graphql to registry (#882)
This commit is contained in:
parent
1210132a1b
commit
98bed07b8e
|
|
@ -41,6 +41,7 @@ body:
|
|||
- area:file
|
||||
- area:gcp-cloud-run
|
||||
- area:gcp-gce
|
||||
- area:graphql
|
||||
- area:host
|
||||
- area:http
|
||||
- area:k8s
|
||||
|
|
|
|||
|
|
@ -34,6 +34,7 @@ body:
|
|||
- area:file
|
||||
- area:gcp-cloud-run
|
||||
- area:gcp-gce
|
||||
- area:graphql
|
||||
- area:host
|
||||
- area:http
|
||||
- area:k8s
|
||||
|
|
|
|||
|
|
@ -43,6 +43,7 @@ body:
|
|||
- area:file
|
||||
- area:gcp-cloud-run
|
||||
- area:gcp-gce
|
||||
- area:graphql
|
||||
- area:host
|
||||
- area:http
|
||||
- area:k8s
|
||||
|
|
|
|||
|
|
@ -48,6 +48,7 @@ Currently, the following namespaces exist:
|
|||
* [File](file.md)
|
||||
* [Google Cloud Run](gcp-cloud-run.md)
|
||||
* [Google Compute Engine](gcp-gce.md)
|
||||
* [GraphQl](graphql.md)
|
||||
* [Host](host.md)
|
||||
* [HTTP](http.md)
|
||||
* [K8s](k8s.md)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,24 @@
|
|||
<!--- Hugo front matter used to generate the website version of this page:
|
||||
--->
|
||||
|
||||
# GraphQL
|
||||
|
||||
## GraphQL Attributes
|
||||
|
||||
<!-- semconv registry.graphql(omit_requirement_level) -->
|
||||
| Attribute | Type | Description | Examples | Stability |
|
||||
|---|---|---|---|---|
|
||||
| `graphql.document` | string | The GraphQL document being executed. [1] | `query findBookById { bookById(id: ?) { name } }` |  |
|
||||
| `graphql.operation.name` | string | The name of the operation being executed. | `findBookById` |  |
|
||||
| `graphql.operation.type` | string | The type of the operation being executed. | `query`; `mutation`; `subscription` |  |
|
||||
|
||||
**[1]:** The value may be sanitized to exclude sensitive information.
|
||||
|
||||
`graphql.operation.type` MUST be one of the following:
|
||||
|
||||
| Value | Description | Stability |
|
||||
|---|---|---|
|
||||
| `query` | GraphQL query |  |
|
||||
| `mutation` | GraphQL mutation |  |
|
||||
| `subscription` | GraphQL subscription |  |
|
||||
<!-- endsemconv -->
|
||||
|
|
@ -14,12 +14,12 @@ The **span name** MUST be of the format `<graphql.operation.type> <graphql.opera
|
|||
span SHOULD be named `<graphql.operation.type>`. When `<graphql.operation.type>` is not available, `GraphQL Operation`
|
||||
MAY be used as span name.
|
||||
|
||||
<!-- semconv graphql -->
|
||||
<!-- semconv graphql(full) -->
|
||||
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||
|---|---|---|---|---|---|
|
||||
| `graphql.document` | string | The GraphQL document being executed. [1] | `query findBookById { bookById(id: ?) { name } }` | `Recommended` |  |
|
||||
| `graphql.operation.name` | string | The name of the operation being executed. | `findBookById` | `Recommended` |  |
|
||||
| `graphql.operation.type` | string | The type of the operation being executed. | `query`; `mutation`; `subscription` | `Recommended` |  |
|
||||
| [`graphql.document`](../attributes-registry/graphql.md) | string | The GraphQL document being executed. [1] | `query findBookById { bookById(id: ?) { name } }` | `Recommended` |  |
|
||||
| [`graphql.operation.name`](../attributes-registry/graphql.md) | string | The name of the operation being executed. | `findBookById` | `Recommended` |  |
|
||||
| [`graphql.operation.type`](../attributes-registry/graphql.md) | string | The type of the operation being executed. | `query`; `mutation`; `subscription` | `Recommended` |  |
|
||||
|
||||
**[1]:** The value may be sanitized to exclude sensitive information.
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,36 @@
|
|||
groups:
|
||||
- id: registry.graphql
|
||||
prefix: graphql
|
||||
type: attribute_group
|
||||
brief: 'This document defines attributes for GraphQL.'
|
||||
attributes:
|
||||
- id: operation.name
|
||||
brief: "The name of the operation being executed."
|
||||
type: string
|
||||
stability: experimental
|
||||
examples: 'findBookById'
|
||||
- id: operation.type
|
||||
brief: "The type of the operation being executed."
|
||||
stability: experimental
|
||||
type:
|
||||
allow_custom_values: false
|
||||
members:
|
||||
- id: query
|
||||
value: "query"
|
||||
brief: "GraphQL query"
|
||||
stability: experimental
|
||||
- id: mutation
|
||||
value: "mutation"
|
||||
brief: "GraphQL mutation"
|
||||
stability: experimental
|
||||
- id: subscription
|
||||
value: "subscription"
|
||||
brief: "GraphQL subscription"
|
||||
stability: experimental
|
||||
examples: ['query', 'mutation', 'subscription']
|
||||
- id: document
|
||||
brief: "The GraphQL document being executed."
|
||||
type: string
|
||||
stability: experimental
|
||||
note: The value may be sanitized to exclude sensitive information.
|
||||
examples: 'query findBookById { bookById(id: ?) { name } }'
|
||||
|
|
@ -1,38 +1,13 @@
|
|||
groups:
|
||||
- id: graphql
|
||||
prefix: graphql
|
||||
type: span
|
||||
brief: >
|
||||
This document defines semantic conventions to apply when instrumenting the GraphQL implementation. They map
|
||||
GraphQL operations to attributes on a Span.
|
||||
attributes:
|
||||
- id: operation.name
|
||||
brief: "The name of the operation being executed."
|
||||
type: string
|
||||
stability: experimental
|
||||
examples: 'findBookById'
|
||||
- id: operation.type
|
||||
brief: "The type of the operation being executed."
|
||||
stability: experimental
|
||||
type:
|
||||
allow_custom_values: false
|
||||
members:
|
||||
- id: query
|
||||
value: "query"
|
||||
brief: "GraphQL query"
|
||||
stability: experimental
|
||||
- id: mutation
|
||||
value: "mutation"
|
||||
brief: "GraphQL mutation"
|
||||
stability: experimental
|
||||
- id: subscription
|
||||
value: "subscription"
|
||||
brief: "GraphQL subscription"
|
||||
stability: experimental
|
||||
examples: ['query', 'mutation', 'subscription']
|
||||
- id: document
|
||||
brief: "The GraphQL document being executed."
|
||||
type: string
|
||||
stability: experimental
|
||||
note: The value may be sanitized to exclude sensitive information.
|
||||
examples: 'query findBookById { bookById(id: ?) { name } }'
|
||||
- ref: graphql.operation.name
|
||||
requirement_level: recommended
|
||||
- ref: graphql.operation.type
|
||||
requirement_level: recommended
|
||||
- ref: graphql.document
|
||||
requirement_level: recommended
|
||||
|
|
|
|||
Loading…
Reference in New Issue