View Source OpenTelemetry.SemConv.Incubating.GCPAttributes (OpenTelemetry.SemConv v1.27.0)
OpenTelemetry Semantic Conventions for GCP attributes.
Summary
Functions
Identifies the Google Cloud service for which the official client library is intended.
The name of the Cloud Run execution being run for the Job, as set by the CLOUD_RUN_EXECUTION
environment variable.
The index for a task within an execution as provided by the CLOUD_RUN_TASK_INDEX
environment variable.
The hostname of a GCE instance. This is the full value of the default or custom hostname.
The instance name of a GCE instance. This is the value provided by host.name
, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the default internal DNS name.
Functions
@spec gcp_client_service() :: :"gcp.client.service"
Identifies the Google Cloud service for which the official client library is intended.
Value type
Value must be of type atom() | String.t()
.
Notes
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"]
iex> OpenTelemetry.SemConv.Incubating.GCPAttributes.gcp_client_service()
:"gcp.client.service"
?GCP_CLIENT_SERVICE.
'gcp.client.service'
@spec gcp_cloud_run_job_execution() :: :"gcp.cloud_run.job.execution"
The name of the Cloud Run execution being run for the Job, as set by the CLOUD_RUN_EXECUTION
environment variable.
Value type
Value must be of type atom() | String.t()
.
Examples
["job-name-xxxx", "sample-job-mdw84"]
iex> OpenTelemetry.SemConv.Incubating.GCPAttributes.gcp_cloud_run_job_execution()
:"gcp.cloud_run.job.execution"
?GCP_CLOUD_RUN_JOB_EXECUTION.
'gcp.cloud_run.job.execution'
@spec gcp_cloud_run_job_task_index() :: :"gcp.cloud_run.job.task_index"
The index for a task within an execution as provided by the CLOUD_RUN_TASK_INDEX
environment variable.
Value type
Value must be of type integer()
.
Examples
[0, 1]
iex> OpenTelemetry.SemConv.Incubating.GCPAttributes.gcp_cloud_run_job_task_index()
:"gcp.cloud_run.job.task_index"
?GCP_CLOUD_RUN_JOB_TASK_INDEX.
'gcp.cloud_run.job.task_index'
@spec gcp_gce_instance_hostname() :: :"gcp.gce.instance.hostname"
The hostname of a GCE instance. This is the full value of the default or custom hostname.
Value type
Value must be of type atom() | String.t()
.
Examples
["my-host1234.example.com", "sample-vm.us-west1-b.c.my-project.internal"]
iex> OpenTelemetry.SemConv.Incubating.GCPAttributes.gcp_gce_instance_hostname()
:"gcp.gce.instance.hostname"
?GCP_GCE_INSTANCE_HOSTNAME.
'gcp.gce.instance.hostname'
@spec gcp_gce_instance_name() :: :"gcp.gce.instance.name"
The instance name of a GCE instance. This is the value provided by host.name
, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the default internal DNS name.
Value type
Value must be of type atom() | String.t()
.
Examples
["instance-1", "my-vm-name"]
iex> OpenTelemetry.SemConv.Incubating.GCPAttributes.gcp_gce_instance_name()
:"gcp.gce.instance.name"
?GCP_GCE_INSTANCE_NAME.
'gcp.gce.instance.name'