Propose semantic conventions for GCP client library identification (#1047)

Co-authored-by: Liudmila Molkova <limolkova@microsoft.com>
This commit is contained in:
Michael Safyan 2024-06-07 14:46:09 -05:00 committed by GitHub
parent 315a717762
commit a159095c4e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 55 additions and 0 deletions

View File

@ -0,0 +1,4 @@
change_type: 'enhancement'
component: gcp
note: Introduces `gcp.client.service` scope attribute.
issues: [ 1047 ]

View File

@ -6,9 +6,28 @@
# GCP
- [Gcp](#gcp-attributes)
- [Gcp Client](#gcp-client-attributes)
- [Gcp Cloud Run](#gcp-cloud-run-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` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
**[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
This document defines attributes for Google Cloud Run.

View File

@ -1,4 +1,24 @@
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
prefix: gcp.cloud_run
type: attribute_group

View File

@ -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.