View Source OpenTelemetry.SemConv.Incubating.DeploymentAttributes (OpenTelemetry.SemConv v1.27.0)

OpenTelemetry Semantic Conventions for Deployment attributes.

Summary

Types

deployment_status_values()

The status of the deployment.

Functions

deployment_environment() deprecated
deployment_environment_name()

Name of the deployment environment (aka deployment tier).

deployment_id()

The id of the deployment.

deployment_name()

The name of the deployment.

deployment_status()

The status of the deployment.

deployment_status_values()

Types

Link to this type

deployment_status_values()

View Source 
@type deployment_status_values() :: %{failed: :failed, succeeded: :succeeded}

The status of the deployment.

Enum Values

  • :failed e - failed
  • :succeeded e - succeeded

Functions

Link to this function

deployment_environment()

View Source
This function is deprecated. Deprecated, use `deployment.environment.name` instead. . 
@spec deployment_environment() :: :"deployment.environment"
Link to this function

deployment_environment_name()

View Source 
@spec deployment_environment_name() :: :"deployment.environment.name"

Name of the deployment environment (aka deployment tier).

Value type

Value must be of type atom() | String.t().

Notes

deployment.environment.name does not affect the uniqueness constraints defined through
the service.namespace, service.name and service.instance.id resource attributes.
This implies that resources carrying the following attribute combinations MUST be
considered to be identifying the same service:

  • service.name=frontend, deployment.environment.name=production
  • service.name=frontend, deployment.environment.name=staging.

Examples 

["staging", "production"]
iex> OpenTelemetry.SemConv.Incubating.DeploymentAttributes.deployment_environment_name()
:"deployment.environment.name"
Link to this function

deployment_id()

View Source 
@spec deployment_id() :: :"deployment.id"

The id of the deployment.

Value type

Value must be of type atom() | String.t().

Examples 

["1208"]
iex> OpenTelemetry.SemConv.Incubating.DeploymentAttributes.deployment_id()
:"deployment.id"
Link to this function

deployment_name()

View Source 
@spec deployment_name() :: :"deployment.name"

The name of the deployment.

Value type

Value must be of type atom() | String.t().

Examples 

["deploy my app", "deploy-frontend"]
iex> OpenTelemetry.SemConv.Incubating.DeploymentAttributes.deployment_name()
:"deployment.name"
Link to this function

deployment_status()

View Source 
@spec deployment_status() :: :"deployment.status"

The status of the deployment.

iex> OpenTelemetry.SemConv.Incubating.DeploymentAttributes.deployment_status()
:"deployment.status"

iex> OpenTelemetry.SemConv.Incubating.DeploymentAttributes.deployment_status_values().failed
:failed

iex> %{OpenTelemetry.SemConv.Incubating.DeploymentAttributes.deployment_status() => OpenTelemetry.SemConv.Incubating.DeploymentAttributes.deployment_status_values().failed}
%{:"deployment.status" => :failed}
Link to this function

deployment_status_values()

View Source 
@spec deployment_status_values() :: deployment_status_values()