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

Have consistent naming for Google Cloud services #1496

Merged
merged 5 commits into from
Mar 4, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ release.
- Add [`ForceFlush`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md#forceflush) to SDK's `TracerProvider` ([#1452](https://github.com/open-telemetry/opentelemetry-specification/pull/1452))
- Add `elasticsearch` to `db.system` semantic conventions ([#1463](https://github.com/open-telemetry/opentelemetry-specification/pull/1463))
- Add `runtime` to `container` semantic conventions ([#1482](https://github.com/open-telemetry/opentelemetry-specification/pull/1482))
- Rename `gcp_gke` to `gcp_kubernetes_engine` to have consistency with other
Google products under `cloud.infrastructure_service` ([#1496](https://github.com/open-telemetry/opentelemetry-specification/pull/1496))

## v1.0.1 (2021-02-11)

Expand Down
12 changes: 6 additions & 6 deletions semantic_conventions/resource/cloud.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -78,19 +78,19 @@ groups:
brief: Azure App Service
- id: GCP_ComputeEngine
value: 'gcp_compute_engine'
brief: GCP Compute Engine
brief: Google Compute Engine
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
brief: Google Compute Engine
brief: Google Cloud Compute Engine

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Their brand name is actually Google Kubernetes/Compute Engine (GKE and GCE) without "Cloud" so it should be fine.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
brief: Google Compute Engine
brief: Google Compute Engine (GCE)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done for all.

- id: GCP_CloudRun
value: 'gcp_cloud_run'
brief: GCP Cloud Run
- id: GCP_GKE
value: 'gcp_gke'
brief: Google Cloud Run
- id: GCP_KubernetesEngine
value: 'gcp_kubernetes_engine'
brief: Google Kubernetes Engine
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
brief: Google Kubernetes Engine
brief: Google Cloud Kubernetes Engine

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to @arminru comment, see: https://cloud.google.com/kubernetes-engine for the branded product name

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
brief: Google Kubernetes Engine
brief: Google Kubernetes Engine (GKE)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should be consistent with acronym usage across this whole file. EKS, e.g. is branded as Amazon Elastic Kubernetes Engine. If we're going to call out an acronym here, is there a reason we wouldn't use it in the value field to be consistent across cloud offerings?

Just want to understand what judgement call / criteria we're using for naming here so we're consistent across all offerings.

- id: GCP_CloudFunctions
value: 'gcp_cloud_functions'
brief: GCP Cloud Functions
brief: Google Cloud Functions
- id: GCP_AppEngine
value: 'gcp_app_engine'
brief: GCP App Engine
brief: Google Cloud App Engine
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
brief: Google Cloud App Engine
brief: Google App Engine (GAE)

brief: >
The cloud infrastructure resource in use.
note: >
Expand Down
10 changes: 5 additions & 5 deletions specification/resource/semantic_conventions/cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@
| `azure_aks` | Azure Kubernetes Service |
| `azure_functions` | Azure Functions |
| `azure_app_service` | Azure App Service |
| `gcp_compute_engine` | GCP Compute Engine |
| `gcp_cloud_run` | GCP Cloud Run |
| `gcp_gke` | Google Kubernetes Engine |
| `gcp_cloud_functions` | GCP Cloud Functions |
| `gcp_app_engine` | GCP App Engine |
| `gcp_compute_engine` | Google Compute Engine |
| `gcp_cloud_run` | Google Cloud Run |
| `gcp_kubernetes_engine` | Google Kubernetes Engine |
| `gcp_cloud_functions` | Google Cloud Functions |
| `gcp_app_engine` | Google Cloud App Engine |
<!-- endsemconv -->