# README

Semconv v1.14.0

PkgGoDev

# Packages

Package httpconv provides OpenTelemetry HTTP semantic conventions for tracing telemetry.
Package netconv provides OpenTelemetry network semantic conventions for tracing telemetry.

# Constants

The JSON-serialized value of each item in the `AttributeDefinitions` request field.
The value of the `AttributesToGet` request parameter.
The value of the `ConsistentRead` request parameter.
The JSON-serialized value of each item in the `ConsumedCapacity` response field.
The value of the `Count` response parameter.
The value of the `ExclusiveStartTableName` request parameter.
The JSON-serialized value of each item of the `GlobalSecondaryIndexes` request field Type: string[] RequirementLevel: Optional Stability: stable Examples: '{ "IndexName": "string", "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "Projection": { "NonKeyAttributes": [ "string" ], "ProjectionType": "string" }, "ProvisionedThroughput": { "ReadCapacityUnits": number, "WriteCapacityUnits": number } }'.
The JSON-serialized value of each item in the `GlobalSecondaryIndexUpdates` request field.
The value of the `IndexName` request parameter.
The JSON-serialized value of the `ItemCollectionMetrics` response field.
The value of the `Limit` request parameter.
The JSON-serialized value of each item of the `LocalSecondaryIndexes` request field.
The value of the `ProjectionExpression` request parameter.
The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter.
The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter.
The value of the `ScanIndexForward` request parameter.
The value of the `ScannedCount` response parameter.
The value of the `Segment` request parameter.
The value of the `Select` request parameter.
The number of items in the `TableNames` response parameter.
The keys in the `RequestItems` object field.
The value of the `TotalSegments` request parameter.
The ARN of an [ECS cluster](https://docs.aws.amazon.com/AmazonECS/latest/develo perguide/clusters.html).
The Amazon Resource Name (ARN) of an [ECS container instance](https://docs.aws.
The [launch type](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/l aunch_types.html) for an ECS task.
The ARN of an [ECS task definition](https://docs.aws.amazon.com/AmazonECS/lates t/developerguide/task_definitions.html).
The task definition family this task definition is a member of.
The revision for this task definition.
The ARN of an EKS cluster.
The full invoked ARN as provided on the `Context` passed to the function (`Lambda-Runtime-Invoked-Function-ARN` header on the `/runtime/invocation/next` applicable).
The Amazon Resource Name(s) (ARN) of the AWS log group(s).
The name(s) of the AWS log group(s) an application is writing to.
The ARN(s) of the AWS log stream(s).
The name(s) of the AWS log stream(s) an application is writing to.
Array of brand name and version separated by a space Type: string[] RequirementLevel: Optional Stability: stable Examples: ' Not A;Brand 99', 'Chromium 99', 'Chrome 99' Note: This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.brands`).
Preferred language of the user using the browser Type: string RequirementLevel: Optional Stability: stable Examples: 'en', 'en-US', 'fr', 'fr-FR' Note: This value is intended to be taken from the Navigator API `navigator.language`.
A boolean that is true if the browser is running on a mobile device Type: boolean RequirementLevel: Optional Stability: stable Note: This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.mobile`).
The platform on which the browser is running Type: string RequirementLevel: Optional Stability: stable Examples: 'Windows', 'macOS', 'Android' Note: This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.platform`).
Full user-agent string provided by the browser Type: string RequirementLevel: Optional Stability: stable Examples: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, ' 'like Gecko) Chrome/95.0.4638.54 Safari/537.36' Note: The user-agent value SHOULD be provided only from browsers that do not have a mechanism to retrieve brands and platform individually from the User- Agent Client Hints API.
The cloud account ID the resource is assigned to.
Cloud regions often have multiple, isolated locations known as zones to increase availability.
The [event_id](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec .md#id) uniquely identifies the event.
The [source](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.m d#source-1) identifies the context in which an event happened.
The [version of the CloudEvents specification](https://github.com/cloudevents/s pec/blob/v1.0.2/cloudevents/spec.md#specversion) which the event uses.
The [subject](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.
The [event_type](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/sp ec.md#type) contains a value describing the type of event related to the originating occurrence.
The cloud platform in use.
Name of the cloud provider.
The geographical region the resource is running.
The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path).
The method or function name, or equivalent (usually rightmost part of the code unit's name).
The line number in `code.filepath` best representing the operation.
The "namespace" within which `code.function` is defined.
Container ID.
Name of the image the container was built on.
Container image tag.
Container name used by container runtime.
The container runtime managing this container.
The consistency level of the query.
The data center of the coordinating node for a query.
The ID of the coordinating node for a query.
Whether or not the query is idempotent.
The fetch size used for paging, i.e.
The number of times a query was speculatively executed.
The name of the primary table that the operation is acting upon, including the keyspace name (if applicable).
The connection string used to connect to the database.
The fully-qualified class name of the [Java Database Connectivity (JDBC)](https://docs.oracle.com/javase/8/docs/technotes/guides/jdbc/) driver used to connect.
The collection being accessed within the database stated in `db.name`.
The Microsoft SQL Server [instance name](https://docs.microsoft.com/en- us/sql/connect/jdbc/building-the-connection-url?view=sql-server-ver15) connecting to.
This attribute is used to report the name of the database being accessed.
The name of the operation being executed, e.g.
The index of the database being accessed as used in the [`SELECT` command](https://redis.io/commands/select), provided as an integer.
The name of the primary table that the operation is acting upon, including the database name (if applicable).
The database statement being executed.
An identifier for the database management system (DBMS) product being used.
Username for accessing the database.
Name of the [deployment environment](https://en.wikipedia.org/wiki/Deployment_environment) (aka deployment tier).
A unique identifier representing the device Type: string RequirementLevel: Optional Stability: stable Examples: '2ab2916d-a51f-4ac8-80ee-45ac31a28092' Note: The device identifier MUST only be defined using the values outlined below.
The name of the device manufacturer Type: string RequirementLevel: Optional Stability: stable Examples: 'Apple', 'Samsung' Note: The Android OS provides this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER).
The model identifier for the device Type: string RequirementLevel: Optional Stability: stable Examples: 'iPhone3,4', 'SM-G920F' Note: It's recommended this value represents a machine readable version of the model identifier rather than the market or consumer-friendly name of the device.
The marketing name for the device model Type: string RequirementLevel: Optional Stability: stable Examples: 'iPhone 6s Plus', 'Samsung Galaxy S6' Note: It's recommended this value represents a human readable version of the device model rather than a machine readable alternative.
Username or client_id extracted from the access token or [Authorization](https://tools.ietf.org/html/rfc7235#section-4.2) header in the inbound request from outside the system.
Actual/assumed role the client is making the request under extracted from token or application security context.
Scopes or granted authorities the client currently possesses extracted from token or application security context.
The domain identifies the context in which an event happened.
The name identifies the event.
ExceptionEventName is the name of the Span event representing an exception.
The exception message.
A stacktrace as a string in the natural representation for the language runtime.
The type of the exception (its fully-qualified class name, if applicable).
A boolean that is true if the serverless function is executed for the first time (aka cold-start).
A string containing the schedule period as [Cron Expression](https://docs.oracl e.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm).
The name of the source on which the triggering operation was performed.
The document name/table subjected to the operation.
Describes the type of the operation that was performed on the data.
A string containing the time when the data was accessed in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime).
The execution ID of the current function execution.
* **AWS Lambda:** The function [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and- namespaces.html).
The execution environment ID as a string, that will be potentially reused for other invocations to the same function/function version.
The name of the invoked function.
The cloud provider of the invoked function.
The cloud region of the invoked function.
The amount of memory available to the serverless function in MiB.
* **Azure:** The full name `<FUNCAPP>/<FUNC>`, i.e., function app name followed by a forward slash followed by the function name (this form can also be seen in the resource JSON for the function).
A string containing the function invocation time in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime).
Clients invoking FaaS instances usually cannot set `faas.trigger`, since they would typically need to look in the payload to determine the event type.
* **AWS Lambda:** The [function version](https://docs.aws.amazon.com/lambda/latest/dg/configuration- versions.html) (an integer represented as a decimal string).
The GraphQL document being executed.
The name of the operation being executed.
The type of the operation being executed.
The CPU architecture the host system is running on.
Unique host ID.
VM image ID.
Name of the VM image or OS install the host was instantiated from.
The version string of the VM image as defined in [Version Attributes](README.md#version-attributes).
Name of the host.
Type of host.
This attribute should be set when a source of information different from the one used for `net.sock.peer.addr`, is available even if that other source just confirms the same value as `net.sock.peer.addr`.
Kind of HTTP protocol used.
HTTP request method.
The size of the request payload body in bytes.
The size of the response payload body in bytes.
The ordinal number of request re-sending attempt.
The matched route (path template in the format used by the respective server framework).
The URI scheme identifying the used protocol.
[HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6).
The full request target as passed in a HTTP request line or equivalent.
Full HTTP request URL in the form `scheme://host[:port]/path?query[#fragment]`.
Value of the [HTTP User-Agent](https://www.rfc- editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client.
The name of the cluster.
The name of the Container from Pod specification, must be unique within a Pod.
Number of times the container was restarted.
The name of the CronJob.
The UID of the CronJob.
The name of the DaemonSet.
The UID of the DaemonSet.
The name of the Deployment.
The UID of the Deployment.
The name of the Job.
The UID of the Job.
The name of the namespace that the pod is running in.
The name of the Node.
The UID of the Node.
The name of the Pod.
The UID of the Pod.
The name of the ReplicaSet.
The UID of the ReplicaSet.
The name of the StatefulSet.
The UID of the StatefulSet.
The identifier for the consumer receiving a message.
The [conversation ID](#conversations) identifying the conversation to which the message belongs, represented as a string.
The message destination name.
The kind of message destination Type: Enum RequirementLevel: ConditionallyRequired (If the message destination is either a `queue` or `topic`.) Stability: stable.
Client ID for the Consumer or Producer that is handling the message.
Name of the Kafka Consumer Group that is handling the message.
Message keys in Kafka are used for grouping alike messages to ensure they're processed on the same partition.
Partition the message is sent to.
A boolean that is true if the message is a tombstone.
A value used by the messaging system as an identifier for the message, represented as a string.
The compressed size of the message payload in bytes.
The (uncompressed) size of the message payload in bytes.
A string identifying the kind of message consumption as defined in the [Operation names](#operation-names) section above.
The name of the transport protocol.
The version of the transport protocol.
RabbitMQ message routing key.
Name of the RocketMQ producer/consumer group that is handling the message.
The unique identifier for each client.
Model of message consumption.
Key(s) of message, another way to mark message besides message id.
The secondary classifier of message besides topic.
Type of message.
Namespace of RocketMQ resources, resources in different namespaces are individual.
A string identifying the messaging system.
A boolean that is true if the message destination is temporary.
Connection string.
Application layer protocol used.
Version of the application layer protocol used.
The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network.
The mobile carrier country code.
The mobile carrier network code.
The name of the mobile carrier.
This describes more details regarding the connection.type.
The internet connection type currently being used by the host.
Logical local hostname or similar, see note below.
Logical local port number, preferably the one that the peer used to connect Type: int RequirementLevel: Optional Stability: stable Examples: 8080.
Logical remote hostname, see note below.
Logical remote port number Type: int RequirementLevel: Optional Stability: stable Examples: 80, 8080, 443.
Protocol [address family](https://man7.org/linux/man- pages/man7/address_families.7.html) which is used for communication.
Local socket address.
Local socket port number.
Remote socket peer address: IPv4 or IPv6 for internet protocols, path for local communication, [etc](https://man7.org/linux/man- pages/man7/address_families.7.html).
Remote socket peer name.
Remote socket peer port.
Transport protocol used.
Parent-child Reference type Type: Enum RequirementLevel: Optional Stability: stable Note: The causal relationship between a child Span and a parent Span.
Human readable (not intended to be parsed) OS version information, like e.g.
Human readable operating system name.
The operating system type.
The version string of the operating system as defined in [Version Attributes](../../resource/semantic_conventions/README.md#version-attributes).
The [`service.name`](../../resource/semantic_conventions/README.md#service) of the remote service.
All the command arguments (including the command/executable itself) as received by the process.
The command used to launch the process (i.e.
The full command used to launch the process as a single string representing the full command.
The name of the process executable.
The full path to the process executable.
The username of the user that owns the process.
Parent Process identifier (PID).
Process identifier (PID).
An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment.
The name of the runtime of this process.
The version of the runtime of this process, as returned by the runtime without modification.
The [numeric status code](https://github.com/grpc/grpc/blob/v1.33.2/doc/statuscodes.md) of the gRPC request.
`error.code` property of response if it is an error response.
`error.message` property of response if it is an error response.
`id` property of request or response.
Protocol version as in `jsonrpc` property of request/response.
The name of the (logical) method being called, must be equal to the $method part in the span name.
The full (logical) name of the service being called, including its package name, if applicable.
A string identifying the remoting system.
SchemaURL is the schema URL that matches the version of the semantic conventions that this package defines.
The string ID of the service instance.
Logical name of the service.
A namespace for `service.name`.
The version string of the service API or implementation.
The version string of the auto instrumentation agent, if used.
The language of the telemetry SDK.
The name of the telemetry SDK as defined above.
The version string of the telemetry SDK.
Current "managed" thread ID (as opposed to OS thread ID).
Current thread name.
Additional description of the web engine (e.g.
The name of the web engine.
The version of the web engine.

# Variables

ec2.
fargate.
Alibaba Cloud Elastic Compute Service.
Alibaba Cloud Function Compute.
AWS App Runner.
AWS Elastic Compute Cloud.
AWS Elastic Container Service.
AWS Elastic Kubernetes Service.
AWS Elastic Beanstalk.
AWS Lambda.
Azure Kubernetes Service.
Azure App Service.
Azure Container Instances.
Azure Functions.
Azure Virtual Machines.
Google Cloud App Engine (GAE).
Google Cloud Functions (GCF).
Google Cloud Run.
Google Cloud Compute Engine (GCE).
Google Cloud Kubernetes Engine (GKE).
Tencent Cloud Cloud Virtual Machine (CVM).
Tencent Cloud Elastic Kubernetes Service (EKS).
Tencent Cloud Serverless Cloud Function (SCF).
Alibaba Cloud.
Amazon Web Services.
Microsoft Azure.
Google Cloud Platform.
Tencent Cloud.
all.
any.
each_quorum.
local_one.
local_quorum.
local_serial.
one.
quorum.
serial.
three.
two.
Adabas (Adaptable Database System).
InterSystems Caché.
Apache Cassandra.
Cloudscape.
CockroachDB.
ColdFusion IMQ.
Microsoft Azure Cosmos DB.
Couchbase.
CouchDB.
IBM DB2.
Apache Derby.
Amazon DynamoDB.
EnterpriseDB.
Elasticsearch.
FileMaker.
Firebird.
FirstSQL.
Apache Geode.
H2.
SAP HANA.
Apache HBase.
Apache Hive.
HyperSQL DataBase.
Informix.
Ingres.
InstantDB.
InterBase.
MariaDB.
SAP MaxDB.
Memcached.
MongoDB.
Microsoft SQL Server.
MySQL.
Neo4j.
Netezza.
OpenSearch.
Oracle Database.
Some other SQL database.
Pervasive PSQL.
PointBase.
PostgreSQL.
Progress Database.
Redis.
Amazon Redshift.
SQLite.
Sybase.
Teradata.
Vertica.
Events from browser apps.
Events from mobile apps.
Events from Kubernetes.
When an object is deleted.
When an object is modified.
When a new object is created.
Alibaba Cloud.
Amazon Web Services.
Microsoft Azure.
Google Cloud Platform.
Tencent Cloud.
A response to some data source operation such as a database or filesystem read/write.
To provide an answer to an inbound HTTP request.
If none of the others apply.
A function is set to be executed when messages are sent to a messaging system.
A function is scheduled to be executed regularly.
GraphQL mutation.
GraphQL query.
GraphQL subscription.
AMD64.
ARM32.
ARM64.
Itanium.
32-bit PowerPC.
64-bit PowerPC.
IBM z/Architecture.
32-bit x86.
HTTP/1.0.
HTTP/1.1.
HTTP/2.
HTTP/3.
QUIC protocol.
SPDY protocol.
HTTP scheme attributes.
HTTP scheme attributes.
A message sent to a queue.
A message sent to a topic.
process.
receive.
Broadcasting consumption model.
Clustering consumption model.
Delay message.
FIFO message.
Normal message.
Transaction message.
CDMA.
CDMA2000 1XRTT.
EDGE.
EHRPD.
EVDO Rel.
EVDO Rev.
EVDO Rev.
GPRS.
GSM.
HSDPA.
HSPA.
HSPAP.
HSUPA.
IDEN.
IWLAN.
LTE.
LTE CA.
5G NR (New Radio).
5G NRNSA (New Radio Non-Standalone).
TD-SCDMA.
UMTS.
cell.
unavailable.
unknown.
wifi.
wired.
IPv4 address.
IPv6 address.
Unix domain socket path.
In-process communication.
Something else (non IP-based).
Named or anonymous pipe.
ip_tcp.
ip_udp.
The parent Span depends on the child Span in some capacity.
The parent Span does not depend in any way on the result of the child Span.
AIX (Advanced Interactive eXecutive).
Apple Darwin.
DragonFly BSD.
FreeBSD.
HP-UX (Hewlett Packard Unix).
Linux.
NetBSD.
OpenBSD.
SunOS, Oracle Solaris.
Microsoft Windows.
IBM z/OS.
ABORTED.
ALREADY_EXISTS.
CANCELLED.
DATA_LOSS.
DEADLINE_EXCEEDED.
FAILED_PRECONDITION.
INTERNAL.
INVALID_ARGUMENT.
NOT_FOUND.
OK.
OUT_OF_RANGE.
PERMISSION_DENIED.
RESOURCE_EXHAUSTED.
UNAUTHENTICATED.
UNAVAILABLE.
UNIMPLEMENTED.
UNKNOWN.
Apache Dubbo.
.NET WCF.
gRPC.
Java RMI.
cpp.
dotnet.
erlang.
go.
java.
nodejs.
php.
python.
ruby.
swift.
webjs.