OpenTelemetry Semantic Conventions

https://docs.rs/opentelemetry-semantic-conventions/latest/
Admin
OpenTelemetry semantic conventions are agreed standardized naming patterns for OpenTelemetry things,...
Tokens:540,888
Snippets:11,953
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Example Usage of HOST_IMAGE_VERSION

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.HOST_IMAGE_VERSION.html

An example value for the host.image.version attribute.

```text
"0.1"
```

--------------------------------

### Example APP_INSTALLATION_ID Value

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.APP_INSTALLATION_ID.html

This is an example of a valid value for the APP_INSTALLATION_ID attribute. It represents a unique installation identifier.

```string
"2ab2916d-a51f-4ac8-80ee-45ac31a28092"
```

--------------------------------

### Example Usage of PROCESS_EXECUTABLE_PATH

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.PROCESS_EXECUTABLE_PATH.html

Illustrates an example value for the process executable path.

```text
"/usr/bin/cmd/otelcol"
```

--------------------------------

### Example Oracle DB Instance Names

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.ORACLE_DB_INSTANCE_NAME.html

Illustrates example values for the `oracle.db.instance.name` attribute. These represent unique instance names in an Oracle RAC setup.

```text
"ORCL1"
```

```text
"ORCL2"
```

```text
"ORCL3"
```

--------------------------------

### Example Filesystem Mount Point

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.SYSTEM_FILESYSTEM_MOUNTPOINT.html

Provides an example value for the system.filesystem.mountpoint attribute.

```text
"/mnt/data"
```

--------------------------------

### Example query string

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.URL_QUERY.html?search=u32+-%3E+bool

A simple example of a query string value.

```text
"q=OpenTelemetry"
```

--------------------------------

### Example DNS Question Names

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.DNS_QUESTION_NAME.html

Illustrates example values for the dns.question.name attribute.

```text
"www.example.com"
```

```text
"opentelemetry.io"
```

--------------------------------

### Example Usage of BROWSER_DOCUMENT_URL_FULL

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.BROWSER_DOCUMENT_URL_FULL.html

An example of a full browser document URL.

```text
"https://www.example.com/search?q=OpenTelemetry#SemConv"
```

--------------------------------

### Example Label Values

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.K8S_PERSISTENTVOLUME_LABEL.html

Provides example values for Kubernetes PersistentVolume labels.

```text
"ssd"
```

```text
""
```

--------------------------------

### Example ARTIFACT_VERSION Values

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.ARTIFACT_VERSION.html

Examples of string values that can be used for ARTIFACT_VERSION.

```text
"v0.1.0"
```

```text
"1.2.1"
```

```text
"122691-build"
```

--------------------------------

### Example Value: 'in'

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.SYSTEM_PAGING_DIRECTION.html

Illustrates an example value for the system paging direction.

```text
"in"
```

--------------------------------

### Example Usage of DEPLOYMENT_NAME

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.DEPLOYMENT_NAME.html

Examples of string values that can be used for the deployment name.

```text
"deploy my app"
```

```text
"deploy-frontend"
```

--------------------------------

### Example PROCESS_CREATION_TIME Value

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.PROCESS_CREATION_TIME.html

An example of the expected ISO 8601 formatted string for process creation time.

```text
"2023-11-21T09:25:34.853Z"
```

--------------------------------

### Example Usage of TELEMETRY_DISTRO_NAME

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.TELEMETRY_DISTRO_NAME.html

Illustrates an example value for the `telemetry.distro.name` attribute, which should be a string starting with 'opentelemetry-'.

```text
"parts-unlimited-java"
```

--------------------------------

### Example Values for HOST_CPU_STEPPING

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.HOST_CPU_STEPPING.html

Provides example string values for the host CPU stepping attribute.

```text
"1"
```

```text
"r1p1"
```

--------------------------------

### AWS DynamoDB Exclusive Start Table Example

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/src/opentelemetry_semantic_conventions/attribute.rs.html

Demonstrates the format for specifying the starting table name for paginated AWS DynamoDB requests.

```json
"Users"
```

```json
"CatsTable"
```

--------------------------------

### Example OS Descriptions

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.OS_DESCRIPTION.html

These examples illustrate the expected format for the 'os.description' attribute value. They are human-readable strings representing OS versions.

```text
"Microsoft Windows [Version 10.0.18363.778]"
```

```text
"Ubuntu 18.04.1 LTS"
```

--------------------------------

### AWS DynamoDB Attributes to Get Example

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/src/opentelemetry_semantic_conventions/attribute.rs.html

Shows the format for specifying attributes to retrieve in an AWS DynamoDB request.

```json
[
 "lives",
 "id",
]
```

--------------------------------

### Example CLOUDEVENTS_EVENT_ID Values

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.CLOUDEVENTS_EVENT_ID.html

Provides example string values for the CLOUDEVENTS_EVENT_ID. These examples illustrate the expected format for unique event identifiers.

```text
"123e4567-e89b-12d3-a456-426614174000"
```

```text
"0001"
```

--------------------------------

### Example GEN_AI_SYSTEM_INSTRUCTIONS (Multiple Instructions)

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.GEN_AI_SYSTEM_INSTRUCTIONS.html

Illustrates the JSON string format for multiple system instructions.

```json
[
  {
    "type": "text",
    "content": "You are a language translator."
  },
  {
    "type": "text",
    "content": "Your mission is to translate text in English to French."
  }
]

```

--------------------------------

### Example URL Subdomain Values

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.URL_SUBDOMAIN.html

Illustrates example values for the URL_SUBDOMAIN attribute. These examples show how subdomains are represented, including multi-level subdomains.

```text
"east"
```

```text
"sub2.sub1"
```

--------------------------------

### Example HTTP Route Templates

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.HTTP_ROUTE.html

These examples illustrate the expected format for the HTTP_ROUTE attribute, showcasing static and dynamic path segments with optional parameters.

```text
"/users/:userID?"
```

```text
"my-controller/my-action/{id?}"
```

--------------------------------

### JSONRPC_REQUEST_ID Examples

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.JSONRPC_REQUEST_ID.html

Examples of string representations for the JSONRPC_REQUEST_ID attribute.

```text
"10"
```

```text
"request-7"
```

--------------------------------

### Example ARTIFACT_PURL Usage

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.ARTIFACT_PURL.html

Illustrates example Package URLs for different artifact types.

```text
"pkg:github/package-url/purl-spec@1209109710924"
```

```text
"pkg:npm/foo@12.12.3"
```

--------------------------------

### Example Usage of PROCESS_RUNTIME_DESCRIPTION

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.PROCESS_RUNTIME_DESCRIPTION.html

Illustrates an example value for the `process.runtime.description` attribute, indicating a specific runtime environment.

```text
"Eclipse OpenJ9 Eclipse OpenJ9 VM openj9-0.21.0"
```

--------------------------------

### Example JSON system instructions

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.GEN_AI_SYSTEM_INSTRUCTIONS.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Examples of structured JSON strings used for system instructions.

```json
"[
  {
    "type": "text",
    "content": "You are an Agent that greet users, always use greetings tool to respond"
  }
]
"
```

```json
"[
  {
    "type": "text",
    "content": "You are a language translator."
  },
  {
    "type": "text",
    "content": "Your mission is to translate text in English to French."
  }
]
"
```

--------------------------------

### CODE_FUNCTION_NAME Attribute Examples

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.CODE_FUNCTION_NAME.html?search=

Example values for the code.function.name attribute.

```text
"com.example.MyHttpService.serveRequest"
```

```text
"GuzzleHttp\\Client::transfer"
```

```text
"fopen"
```

--------------------------------

### Example Resource URIs

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.MCP_RESOURCE_URI.html

Illustrates example values for the MCP_RESOURCE_URI, including a PostgreSQL database URI and a local file URI.

```text
"postgres://database/customers/schema"
```

```text
"file:///home/user/documents/report.pdf"
```

--------------------------------

### Example HTTP User-Agent Strings

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.HTTP_USER_AGENT.html

Illustrates common formats for the HTTP User-Agent header. Use `user_agent.original` for new instrumentation.

```text
"CERN-LineMode/2.15 libwww/2.17b3"
```

```text
"Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1"
```

--------------------------------

### Example Usage of SECURITY_RULE_RULESET_NAME

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.SECURITY_RULE_RULESET_NAME.html

An example of a value that can be assigned to the security_rule.ruleset.name attribute.

```string
"Standard_Protocol_Filters"
```

--------------------------------

### Example GCP_GCE_INSTANCE_HOSTNAME Values

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.GCP_GCE_INSTANCE_HOSTNAME.html

Illustrates example values for the GCP_GCE_INSTANCE_HOSTNAME attribute, representing different hostname formats.

```text
"my-host1234.example.com"
```

```text
"sample-vm.us-west1-b.c.my-project.internal"
```

--------------------------------

### NET_PROTOCOL_NAME Examples

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.NET_PROTOCOL_NAME.html

Examples of values that can be used with the deprecated NET_PROTOCOL_NAME attribute.

```text
"amqp"
```

```text
"http"
```

```text
"mqtt"
```

--------------------------------

### Example Annotation Values

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.K8S_STATEFULSET_ANNOTATION.html

Provides example values for StatefulSet annotations.

```text
"1"
```

```text
""
```

--------------------------------

### Example VCS Reference Names

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.VCS_REF_BASE_NAME.html

Illustrates example values for the VCS_REF_BASE_NAME, showing branch and tag names.

```text
"my-feature-branch"
```

```text
"tag-1-test"
```

--------------------------------

### Example Usage of K8S_POD_START_TIME

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.K8S_POD_START_TIME.html

An example of the expected string format for the K8S_POD_START_TIME attribute, which should be in ISO 8601 format.

```text
"2025-12-04T08:41:03Z"
```

--------------------------------

### Example Annotation Values

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.K8S_CRONJOB_ANNOTATION.html

Provides example values for CronJob annotations.

```text
"4"
```

```text
""
```

--------------------------------

### Example Usage of CONTAINER_COMMAND_LINE

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.CONTAINER_COMMAND_LINE.html

Illustrates the expected format for the container command line attribute.

```text
"otelcontribcol --config config.yaml"
```

--------------------------------

### Example attribute values

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.HTTP_REQUEST_HEADER.html?search=

Examples of how header values should be represented as arrays.

```json
[  "application/json", ]
```

```json
[  "1.2.3.4",  "1.2.3.5", ]
```

--------------------------------

### Example HOST_ID Value

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.HOST_ID.html

An example of a unique host ID value.

```text
"fdbf79e8af94cb7f9e8df36789187052"
```

--------------------------------

### Example User Agent Versions

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.USER_AGENT_VERSION.html

Illustrates example values for the user agent version, typically extracted from original user-agent strings.

```text
"14.1.2"
```

```text
"1.0.0"
```

--------------------------------

### Example Usage of GEO_POSTAL_CODE

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.GEO_POSTAL_CODE.html

Illustrates an example value for the geo.postal_code attribute.

```string
"94040"
```

--------------------------------

### Example Usage of FEATURE_FLAG_CONTEXT_ID

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.FEATURE_FLAG_CONTEXT_ID.html

Illustrates an example value for FEATURE_FLAG_CONTEXT_ID, which is a UUID.

```string
"5157782b-2203-4c80-a857-dbbd5e7761db"
```

--------------------------------

### Example DaemonSet Label Values

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.K8S_DAEMONSET_LABEL.html

Provides example values for Kubernetes DaemonSet labels.

```text
"guestbook"
```

```text
""
```

--------------------------------

### CODE_LINE_NUMBER Example Value

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.CODE_LINE_NUMBER.html?search=std%3A%3Avec

An example value representing a line number.

```text
42
```

--------------------------------

### Example Usage of CLOUDFOUNDRY_SPACE_NAME

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.CLOUDFOUNDRY_SPACE_NAME.html

Provides an example of the expected value for the CloudFoundry space name.

```string
"my-space-name"
```

--------------------------------

### Example Usage of AWS_ECS_TASK_REVISION

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.AWS_ECS_TASK_REVISION.html

Illustrates example values for the AWS_ECS_TASK_REVISION attribute.

```text
"8"
```

```text
"26"
```

--------------------------------

### Example Usage of HOST_NAME

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.HOST_NAME.html

Illustrates how to use the HOST_NAME attribute with a sample value.

```text
"opentelemetry-test"
```

--------------------------------

### Example Attestation Filenames

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.ARTIFACT_ATTESTATION_FILENAME.html

Illustrates various valid filename formats for artifact attestations, including those for Go binaries, Docker images, and generic tarballs.

```text
"golang-binary-amd64-v0.1.0.attestation"
```

```text
"docker-image-amd64-v0.1.0.intoto.json1"
```

```text
"release-1.tar.gz.attestation"
```

```text
"file-name-package.tar.gz.intoto.json1"
```

--------------------------------

### Example ARTIFACT_HASH Value

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.ARTIFACT_HASH.html

An example of a full hash value for an artifact.

```text
"9ff4c52759e2c4ac70b7d517bc7fcdc1cda631ca0045271ddd1b192544f8a3e9"
```

--------------------------------

### Example OS Names

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.USER_AGENT_OS_NAME.html

Illustrative examples of operating system names that can be used with the USER_AGENT_OS_NAME attribute.

```text
"iOS"
```

```text
"Android"
```

```text
"Ubuntu"
```

--------------------------------

### Example FAAS_CRON Value

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.FAAS_CRON.html

Provides an example of a valid Cron Expression string that can be used with the FAAS_CRON attribute. This specific example represents a schedule that runs every 5 minutes.

```text
"0/5 * * * ? *"
```

--------------------------------

### Example container command arguments

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.CONTAINER_COMMAND_ARGS.html?search=

An example of how container command arguments are represented as a list.

```json
[  "otelcontribcol",  "--config",  "config.yaml", ]
```

--------------------------------

### Example Usage of SECURITY_RULE_DESCRIPTION

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.SECURITY_RULE_DESCRIPTION.html

An example string value for the security rule description.

```text
"Block requests to public DNS over HTTPS / TLS protocols"
```

--------------------------------

### Example GEN_AI_SYSTEM_INSTRUCTIONS (Single Instruction)

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.GEN_AI_SYSTEM_INSTRUCTIONS.html

Illustrates the JSON string format for a single system instruction.

```json
[
  {
    "type": "text",
    "content": "You are an Agent that greet users, always use greetings tool to respond"
  }
]

```

--------------------------------

### Example Network Protocol Versions

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.NETWORK_PROTOCOL_VERSION.html

Illustrates common string values for the network.protocol.version attribute.

```text
"1.1"
```

```text
"2"
```

--------------------------------

### Example Values for PPROF_PROFILE_COMMENT

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.PPROF_PROFILE_COMMENT.html?search=std%3A%3Avec

Example values that can be associated with the profile comment attribute.

```json
[  "hello world",  "bazinga", ]
```

--------------------------------

### Example Values for DEPLOYMENT_ENVIRONMENT

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.DEPLOYMENT_ENVIRONMENT.html

These are example string values that could be used for the deprecated `DEPLOYMENT_ENVIRONMENT` attribute.

```text
"staging"
```

```text
"production"
```

--------------------------------

### Example PDB Values

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.ORACLE_DB_PDB.html

Illustrates example string values for the ORACLE_DB_PDB attribute.

```text
"PDB1"
```

```text
"FREEPDB"
```

--------------------------------

### Example Value for NETWORK_CONNECTION_STATE

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.NETWORK_CONNECTION_STATE.html

Provides an example value for the network connection state.

```text
"close_wait"
```

--------------------------------

### Example Usage of PPROF_PROFILE_DOC_URL

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.PPROF_PROFILE_DOC_URL.html

This example demonstrates how to use the PPROF_PROFILE_DOC_URL attribute with an absolute URL. The URL should point to the documentation for the specific profile type.

```text
"http://pprof.example.com/cpu-profile.html"
```

--------------------------------

### Example value for DB_MSSQL_INSTANCE_NAME

Source: https://docs.rs/opentelemetry-semantic-conventions/latest/opentelemetry_semantic_conventions/attribute/constant.DB_MSSQL_INSTANCE_NAME.html?search=std%3A%3Avec

A common example value for the SQL Server instance name attribute.

```text
"MSSQLSERVER"
```
Tokens:
Raw