Propose semantic conventions for GCP client library identification (#1047)
Co-authored-by: Liudmila Molkova <limolkova@microsoft.com>
This commit is contained in:
parent
315a717762
commit
a159095c4e
|
|
@ -0,0 +1,4 @@
|
||||||
|
change_type: 'enhancement'
|
||||||
|
component: gcp
|
||||||
|
note: Introduces `gcp.client.service` scope attribute.
|
||||||
|
issues: [ 1047 ]
|
||||||
|
|
@ -6,9 +6,28 @@
|
||||||
|
|
||||||
# GCP
|
# GCP
|
||||||
|
|
||||||
|
- [Gcp](#gcp-attributes)
|
||||||
|
- [Gcp Client](#gcp-client-attributes)
|
||||||
- [Gcp Cloud Run](#gcp-cloud-run-attributes)
|
- [Gcp Cloud Run](#gcp-cloud-run-attributes)
|
||||||
- [Gcp Gce](#gcp-gce-attributes)
|
- [Gcp Gce](#gcp-gce-attributes)
|
||||||
|
|
||||||
|
## GCP Attributes
|
||||||
|
|
||||||
|
Attributes for Google Cloud
|
||||||
|
|
||||||
|
| Attribute | Type | Description | Examples | Stability |
|
||||||
|
| --------- | ---- | ----------- | -------- | --------- |
|
||||||
|
|
||||||
|
## GCP Client Attributes
|
||||||
|
|
||||||
|
Attributes for Google Cloud client libraries.
|
||||||
|
|
||||||
|
| Attribute | Type | Description | Examples | Stability |
|
||||||
|
| -------------------- | ------ | ------------------------------------------------------------------------------------------ | ----------------------------------------------------- | ---------------------------------------------------------------- |
|
||||||
|
| `gcp.client.service` | string | Identifies the Google Cloud service for which the official client library is intended. [1] | `appengine`; `run`; `firestore`; `alloydb`; `spanner` |  |
|
||||||
|
|
||||||
|
**[1]:** Intended to be a stable identifier for Google Cloud client libraries that is uniform across implementation languages. The value should be derived from the canonical service domain for the service; for example, 'foo.googleapis.com' should result in a value of 'foo'.
|
||||||
|
|
||||||
## GCP Cloud Run Attributes
|
## GCP Cloud Run Attributes
|
||||||
|
|
||||||
This document defines attributes for Google Cloud Run.
|
This document defines attributes for Google Cloud Run.
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,24 @@
|
||||||
groups:
|
groups:
|
||||||
|
- id: registry.gcp
|
||||||
|
prefix: gcp
|
||||||
|
type: attribute_group
|
||||||
|
brief: Attributes for Google Cloud
|
||||||
|
- id: registry.gcp.client
|
||||||
|
prefix: gcp.client
|
||||||
|
type: attribute_group
|
||||||
|
brief: >
|
||||||
|
Attributes for Google Cloud client libraries.
|
||||||
|
attributes:
|
||||||
|
- id: service
|
||||||
|
type: string
|
||||||
|
stability: experimental
|
||||||
|
brief: Identifies the Google Cloud service for which the official client library is intended.
|
||||||
|
note: >
|
||||||
|
Intended to be a stable identifier for Google Cloud client libraries
|
||||||
|
that is uniform across implementation languages. The value should be
|
||||||
|
derived from the canonical service domain for the service; for
|
||||||
|
example, 'foo.googleapis.com' should result in a value of 'foo'.
|
||||||
|
examples: ['appengine', 'run', 'firestore', 'alloydb', 'spanner']
|
||||||
- id: registry.gcp.cloud_run
|
- id: registry.gcp.cloud_run
|
||||||
prefix: gcp.cloud_run
|
prefix: gcp.cloud_run
|
||||||
type: attribute_group
|
type: attribute_group
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,12 @@
|
||||||
|
groups:
|
||||||
|
- id: gcp.client.attributes
|
||||||
|
type: attribute_group
|
||||||
|
brief: Conventions for official Google Cloud client libraries.
|
||||||
|
prefix: gcp.client
|
||||||
|
stability: experimental
|
||||||
|
attributes:
|
||||||
|
- ref: gcp.client.service
|
||||||
|
requirement_level:
|
||||||
|
conditionally_required:
|
||||||
|
Required if and only if the instrumentation library is an official,
|
||||||
|
Google-provided GCP and/or Firebase client library.
|
||||||
Loading…
Reference in New Issue