Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Propose semantic conventions for GCP client library identification #1047

Merged
merged 18 commits into from
Jun 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
36aaf4c
Propose semantic conventions for GCP client library identification/at…
michaelsafyan May 17, 2024
0ec889d
Added changelog entry for the enhancement.
michaelsafyan May 17, 2024
f700981
Add pull request reference.
michaelsafyan May 17, 2024
589567c
Merge branch 'open-telemetry:main' into gcp-client-libraries
michaelsafyan May 20, 2024
bdb00c8
Merge branch 'open-telemetry:main' into gcp-client-libraries
michaelsafyan May 22, 2024
a974d53
Merge branch 'open-telemetry:main' into gcp-client-libraries
michaelsafyan May 24, 2024
042da91
Generalize the name for 'repo' and 'asset'.
michaelsafyan May 24, 2024
0fbdce0
Remove redundant prefix in the registry, fixing the attribute generat…
michaelsafyan May 24, 2024
2581647
Apply suggestion requested in pull request.
michaelsafyan May 28, 2024
437b3e4
Apply suggestion requested in pull request.
michaelsafyan May 28, 2024
19397df
Merge branch 'open-telemetry:main' into gcp-client-libraries
michaelsafyan May 29, 2024
d65aa65
Remove non-GCP attributes from the scope.
michaelsafyan May 29, 2024
b48c641
Regenerate the documentation.
michaelsafyan May 30, 2024
281a3af
Remove docs that were generated by files that have since been deleted.
michaelsafyan May 30, 2024
29fbf7b
Merge branch 'open-telemetry:main' into gcp-client-libraries
michaelsafyan Jun 4, 2024
4c3fb77
Apply requested changes in pull request 1047.
michaelsafyan Jun 4, 2024
bd6823f
Remove '.scope' from the ID given that it is no longer of scope type.
michaelsafyan Jun 4, 2024
bccab97
Merge branch 'main' into gcp-client-libraries
lmolkova Jun 7, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .chloggen/gcp-client-libraries.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
change_type: 'enhancement'
component: gcp
note: Introduces `gcp.client.service` scope attribute.
issues: [ 1047 ]
19 changes: 19 additions & 0 deletions docs/attributes-registry/gcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
20 changes: 20 additions & 0 deletions model/registry/gcp.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
12 changes: 12 additions & 0 deletions model/trace/instrumentation/gcp-client.yml
Original file line number Diff line number Diff line change
@@ -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