SemanticAttributes (opentelemetry-api 0.7.1 API)

java.lang.Object
- io.opentelemetry.trace.attributes.SemanticAttributes

```
public final class SemanticAttributes
extends Object
```
Defines constants for all attribute names defined in the OpenTelemetry Semantic Conventions specifications.

See Also:

Semantic Conventions

Field Summary

Fields
Modifier and Type	Field and Description
`static StringAttributeSetter`	`CASSANDRA_NAMESPACE` For db.system == cassandra, the name of the keyspace being accessed.
`static StringAttributeSetter`	`DB_CONNECTION_STRING` The connection string used to connect to the database.
`static StringAttributeSetter`	`DB_NAME` Database name.
`static StringAttributeSetter`	`DB_OPERATION` Database operation that is being executed.
`static StringAttributeSetter`	`DB_STATEMENT` Database statement for the given database type.
`static StringAttributeSetter`	`DB_SYSTEM` An identifier for the database management system (DBMS) product being used.
`static StringAttributeSetter`	`DB_USER` Username for accessing database.
`static StringAttributeSetter`	`ENDUSER_ID` Username or client_id extracted from the access token or Authorization header in the inbound request from outside the system.
`static StringAttributeSetter`	`ENDUSER_ROLE` Actual/assumed role the client is making the request under extracted from token or application security context.
`static StringAttributeSetter`	`ENDUSER_SCOPE` Scopes or granted authorities the client currently possesses extracted from token or application security context.
`static String`	`EXCEPTION_EVENT_NAME` The name of an `Event` describing an exception.
`static StringAttributeSetter`	`EXCEPTION_MESSAGE` The exception message.
`static StringAttributeSetter`	`EXCEPTION_STACKTRACE` A string representing the stacktrace of an exception, as produced by `Throwable.printStackTrace()`.
`static StringAttributeSetter`	`EXCEPTION_TYPE` The type of the exception, i.e., it's fully qualified name.
`static StringAttributeSetter`	`HBASE_NAMESPACE` For db.system == hbase, the namespace being accessed.
`static StringAttributeSetter`	`HTTP_CLIENT_IP` The IP address of the original client behind all proxies, if known.
`static StringAttributeSetter`	`HTTP_FLAVOR` Kind of HTTP protocol used: "1.0", "1.1", "2", "SPDY" or "QUIC".
`static StringAttributeSetter`	`HTTP_HOST` The value of the HTTP host header.
`static StringAttributeSetter`	`HTTP_METHOD` HTTP request method.
`static LongAttributeSetter`	`HTTP_REQUEST_CONTENT_LENGTH` The size of the request payload body, in bytes.
`static LongAttributeSetter`	`HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED` The size of the uncompressed request payload body, in bytes.
`static LongAttributeSetter`	`HTTP_RESPONSE_CONTENT_LENGTH` The size of the response payload body, in bytes.
`static LongAttributeSetter`	`HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED` The size of the uncompressed response payload body, in bytes.
`static StringAttributeSetter`	`HTTP_ROUTE` The matched route (path template).
`static StringAttributeSetter`	`HTTP_SCHEME` The URI scheme identifying the used protocol: "http" or "https".
`static StringAttributeSetter`	`HTTP_SERVER_NAME` The primary server name of the matched virtual host.
`static LongAttributeSetter`	`HTTP_STATUS_CODE` HTTP response status code.
`static StringAttributeSetter`	`HTTP_STATUS_TEXT` HTTP reason phrase.
`static StringAttributeSetter`	`HTTP_TARGET` The full request target as passed in a HTTP request line or equivalent.
`static StringAttributeSetter`	`HTTP_URL` Full HTTP request URL in the form scheme://host[:port]/path?query[#fragment].
`static StringAttributeSetter`	`HTTP_USER_AGENT` Value of the HTTP "User-Agent" header sent by the client.
`static StringAttributeSetter`	`JDBC_DRIVER_CLASSNAME` For JDBC clients, the fully-qualified class name of the Java Database Connectivity (JDBC) driver used to connect, e.g.
`static LongAttributeSetter`	`MESSAGE_COMPRESSED_SIZE` RPC span event attribute for compressed size.
`static LongAttributeSetter`	`MESSAGE_ID` RPC span event attribute starting from 1 for each of sent messages and received messages.
`static StringAttributeSetter`	`MESSAGE_TYPE` RPC span event attribute with value "SENT" or "RECEIVED".
`static LongAttributeSetter`	`MESSAGE_UNCOMPRESSED_SIZE` RPC span event attribute for uncompressed size.
`static StringAttributeSetter`	`MESSAGING_CONVERSATION_ID` A value identifying the conversation to which the message belongs, represented as a string.
`static StringAttributeSetter`	`MESSAGING_DESTINATION` The message destination name, e.g.
`static StringAttributeSetter`	`MESSAGING_DESTINATION_KIND` The kind of message destination.
`static StringAttributeSetter`	`MESSAGING_MESSAGE_ID` A value used by the messaging system as an identifier for the message, represented as a string.
`static LongAttributeSetter`	`MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES` The compressed size of the message payload in bytes.
`static LongAttributeSetter`	`MESSAGING_MESSAGE_PAYLOAD_SIZE_BYTES` The (uncompressed) size of the message payload in bytes.
`static StringAttributeSetter`	`MESSAGING_OPERATION` A string identifying which part and kind of message consumption this span describes: either "receive" or "process".
`static StringAttributeSetter`	`MESSAGING_PROTOCOL` The name of the transport protocol such as AMQP or MQTT.
`static StringAttributeSetter`	`MESSAGING_PROTOCOL_VERSION` The version of the transport protocol such as 0.9.1.
`static StringAttributeSetter`	`MESSAGING_SYSTEM` A string identifying the messaging system such as kafka, rabbitmq or activemq.
`static BooleanAttributeSetter`	`MESSAGING_TEMP_DESTINATION` A boolean that is true if the message destination is temporary.
`static StringAttributeSetter`	`MESSAGING_URL` Connection string such as tibjmsnaming://localhost:7222 or https://queue.amazonaws.com/80398EXAMPLE/MyQueue
`static StringAttributeSetter`	`MONGODB_COLLECTION` For db.system == mongodb, the collection being accessed within the database stated in db.name
`static StringAttributeSetter`	`MSSQL_SQL_SERVER` For db.system == mssql, the instance name connecting to.
`static StringAttributeSetter`	`NET_HOST_IP` Like net.peer.ip but for the host IP.
`static StringAttributeSetter`	`NET_HOST_NAME` Local hostname or similar.
`static LongAttributeSetter`	`NET_HOST_PORT` Like net.peer.port but for the host port.
`static StringAttributeSetter`	`NET_PEER_IP` Remote address of the peer (dotted decimal for IPv4 or RFC5952 for IPv6).
`static StringAttributeSetter`	`NET_PEER_NAME` Remote hostname or similar.
`static LongAttributeSetter`	`NET_PEER_PORT` Remote port number as an integer.
`static StringAttributeSetter`	`NET_TRANSPORT` Transport protocol used.
`static StringAttributeSetter`	`PEER_SERVICE` Logical name of a remote service.
`static StringAttributeSetter`	`REDIS_DATABASE_INDEX` For db.system == redis, the index of the database being accessed as used in the SELECT command, provided as an integer.
`static StringAttributeSetter`	`RPC_SERVICE` The service name, must be equal to the $service part in the span name.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NET_TRANSPORT
```
public static final StringAttributeSetter NET_TRANSPORT
```
    Transport protocol used.
  - NET_PEER_IP
```
public static final StringAttributeSetter NET_PEER_IP
```
    Remote address of the peer (dotted decimal for IPv4 or RFC5952 for IPv6).
  - NET_PEER_PORT
```
public static final LongAttributeSetter NET_PEER_PORT
```
    Remote port number as an integer. E.g., 80.
  - NET_PEER_NAME
```
public static final StringAttributeSetter NET_PEER_NAME
```
    Remote hostname or similar.
  - NET_HOST_IP
```
public static final StringAttributeSetter NET_HOST_IP
```
    Like net.peer.ip but for the host IP. Useful in case of a multi-IP host.
  - NET_HOST_PORT
```
public static final LongAttributeSetter NET_HOST_PORT
```
    Like net.peer.port but for the host port.
  - NET_HOST_NAME
```
public static final StringAttributeSetter NET_HOST_NAME
```
    Local hostname or similar.
  - PEER_SERVICE
```
public static final StringAttributeSetter PEER_SERVICE
```
    Logical name of a remote service.
  - ENDUSER_ID
```
public static final StringAttributeSetter ENDUSER_ID
```
    Username or client_id extracted from the access token or Authorization header in the inbound request from outside the system.
  - ENDUSER_ROLE
```
public static final StringAttributeSetter ENDUSER_ROLE
```
    Actual/assumed role the client is making the request under extracted from token or application security context.
  - ENDUSER_SCOPE
```
public static final StringAttributeSetter ENDUSER_SCOPE
```
    Scopes or granted authorities the client currently possesses extracted from token or application security context. The value would come from the scope associated with an OAuth 2.0 Access Token or an attribute value in a SAML 2.0 Assertion.
  - HTTP_METHOD
```
public static final StringAttributeSetter HTTP_METHOD
```
    HTTP request method. E.g. "GET".
  - HTTP_URL
```
public static final StringAttributeSetter HTTP_URL
```
    Full HTTP request URL in the form scheme://host[:port]/path?query[#fragment].
  - HTTP_TARGET
```
public static final StringAttributeSetter HTTP_TARGET
```
    The full request target as passed in a HTTP request line or equivalent.
  - HTTP_HOST
```
public static final StringAttributeSetter HTTP_HOST
```
    The value of the HTTP host header.
  - HTTP_SCHEME
```
public static final StringAttributeSetter HTTP_SCHEME
```
    The URI scheme identifying the used protocol: "http" or "https".
  - HTTP_STATUS_CODE
```
public static final LongAttributeSetter HTTP_STATUS_CODE
```
    HTTP response status code. E.g. 200 (integer) If and only if one was received/sent.
  - HTTP_STATUS_TEXT
```
public static final StringAttributeSetter HTTP_STATUS_TEXT
```
    HTTP reason phrase. E.g. "OK"
  - HTTP_FLAVOR
```
public static final StringAttributeSetter HTTP_FLAVOR
```
    Kind of HTTP protocol used: "1.0", "1.1", "2", "SPDY" or "QUIC".
  - HTTP_USER_AGENT
```
public static final StringAttributeSetter HTTP_USER_AGENT
```
    Value of the HTTP "User-Agent" header sent by the client.
  - HTTP_SERVER_NAME
```
public static final StringAttributeSetter HTTP_SERVER_NAME
```
    The primary server name of the matched virtual host. Usually obtained via configuration.
  - HTTP_ROUTE
```
public static final StringAttributeSetter HTTP_ROUTE
```
    The matched route (path template).
  - HTTP_CLIENT_IP
```
public static final StringAttributeSetter HTTP_CLIENT_IP
```
    The IP address of the original client behind all proxies, if known.
  - HTTP_REQUEST_CONTENT_LENGTH
```
public static final LongAttributeSetter HTTP_REQUEST_CONTENT_LENGTH
```
    The size of the request payload body, in bytes. For payloads using transport encoding, this is the compressed size.
  - HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED
```
public static final LongAttributeSetter HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED
```
    The size of the uncompressed request payload body, in bytes. Only set for requests that use transport encoding.
  - HTTP_RESPONSE_CONTENT_LENGTH
```
public static final LongAttributeSetter HTTP_RESPONSE_CONTENT_LENGTH
```
    The size of the response payload body, in bytes. For payloads using transport encoding, this is the compressed size.
  - HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED
```
public static final LongAttributeSetter HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED
```
    The size of the uncompressed response payload body, in bytes. Only set for responses that use transport encoding.
  - RPC_SERVICE
```
public static final StringAttributeSetter RPC_SERVICE
```
    The service name, must be equal to the $service part in the span name.
  - MESSAGE_TYPE
```
public static final StringAttributeSetter MESSAGE_TYPE
```
    RPC span event attribute with value "SENT" or "RECEIVED".
  - MESSAGE_ID
```
public static final LongAttributeSetter MESSAGE_ID
```
    RPC span event attribute starting from 1 for each of sent messages and received messages.
  - MESSAGE_COMPRESSED_SIZE
```
public static final LongAttributeSetter MESSAGE_COMPRESSED_SIZE
```
    RPC span event attribute for compressed size.
  - MESSAGE_UNCOMPRESSED_SIZE
```
public static final LongAttributeSetter MESSAGE_UNCOMPRESSED_SIZE
```
    RPC span event attribute for uncompressed size.
  - DB_SYSTEM
```
public static final StringAttributeSetter DB_SYSTEM
```
    An identifier for the database management system (DBMS) product being used.
    
    See Also:
    
    A list of well-known identifiers
  - DB_NAME
```
public static final StringAttributeSetter DB_NAME
```
    Database name.
  - DB_CONNECTION_STRING
```
public static final StringAttributeSetter DB_CONNECTION_STRING
```
    The connection string used to connect to the database. It's recommended to remove embedded credentials. This will replace db.url.
  - DB_STATEMENT
```
public static final StringAttributeSetter DB_STATEMENT
```
    Database statement for the given database type.
  - DB_OPERATION
```
public static final StringAttributeSetter DB_OPERATION
```
    Database operation that is being executed.
  - DB_USER
```
public static final StringAttributeSetter DB_USER
```
    Username for accessing database.
  - MSSQL_SQL_SERVER
```
public static final StringAttributeSetter MSSQL_SQL_SERVER
```
    For db.system == mssql, the instance name connecting to. This name is used to determine the port of a named instance. When set, NET_PEER_PORT is not required, but recommended when connecting to a non-standard port.
  - JDBC_DRIVER_CLASSNAME
```
public static final StringAttributeSetter JDBC_DRIVER_CLASSNAME
```
    For JDBC clients, the fully-qualified class name of the Java Database Connectivity (JDBC) driver used to connect, e.g. "org.postgresql.Driver" or "com.microsoft.sqlserver.jdbc.SQLServerDriver".
  - CASSANDRA_NAMESPACE
```
public static final StringAttributeSetter CASSANDRA_NAMESPACE
```
    For db.system == cassandra, the name of the keyspace being accessed. To be used instead of the generic db.name attribute.
  - HBASE_NAMESPACE
```
public static final StringAttributeSetter HBASE_NAMESPACE
```
    For db.system == hbase, the namespace being accessed. To be used instead of the generic db.name attribute.
  - REDIS_DATABASE_INDEX
```
public static final StringAttributeSetter REDIS_DATABASE_INDEX
```
    For db.system == redis, the index of the database being accessed as used in the SELECT command, provided as an integer. To be used instead of the generic db.name attribute.
  - MONGODB_COLLECTION
```
public static final StringAttributeSetter MONGODB_COLLECTION
```
    For db.system == mongodb, the collection being accessed within the database stated in db.name
  - MESSAGING_SYSTEM
```
public static final StringAttributeSetter MESSAGING_SYSTEM
```
    A string identifying the messaging system such as kafka, rabbitmq or activemq.
  - MESSAGING_DESTINATION
```
public static final StringAttributeSetter MESSAGING_DESTINATION
```
    The message destination name, e.g. MyQueue or MyTopic. This might be equal to the span name but is required nevertheless
  - MESSAGING_DESTINATION_KIND
```
public static final StringAttributeSetter MESSAGING_DESTINATION_KIND
```
    The kind of message destination. Either queue or topic.
  - MESSAGING_TEMP_DESTINATION
```
public static final BooleanAttributeSetter MESSAGING_TEMP_DESTINATION
```
    A boolean that is true if the message destination is temporary.
  - MESSAGING_PROTOCOL
```
public static final StringAttributeSetter MESSAGING_PROTOCOL
```
    The name of the transport protocol such as AMQP or MQTT.
  - MESSAGING_PROTOCOL_VERSION
```
public static final StringAttributeSetter MESSAGING_PROTOCOL_VERSION
```
    The version of the transport protocol such as 0.9.1.
  - MESSAGING_URL
```
public static final StringAttributeSetter MESSAGING_URL
```
    Connection string such as tibjmsnaming://localhost:7222 or https://queue.amazonaws.com/80398EXAMPLE/MyQueue
  - MESSAGING_MESSAGE_ID
```
public static final StringAttributeSetter MESSAGING_MESSAGE_ID
```
    A value used by the messaging system as an identifier for the message, represented as a string.
  - MESSAGING_CONVERSATION_ID
```
public static final StringAttributeSetter MESSAGING_CONVERSATION_ID
```
    A value identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID".
  - MESSAGING_MESSAGE_PAYLOAD_SIZE_BYTES
```
public static final LongAttributeSetter MESSAGING_MESSAGE_PAYLOAD_SIZE_BYTES
```
    The (uncompressed) size of the message payload in bytes. Also use this attribute if it is unknown whether the compressed or uncompressed payload size is reported.
  - MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES
```
public static final LongAttributeSetter MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES
```
    The compressed size of the message payload in bytes.
  - MESSAGING_OPERATION
```
public static final StringAttributeSetter MESSAGING_OPERATION
```
    A string identifying which part and kind of message consumption this span describes: either "receive" or "process". If the operation is "send", this attribute must not be set: the operation can be inferred from the span kind in that case.
  - EXCEPTION_EVENT_NAME
```
public static final String EXCEPTION_EVENT_NAME
```
    The name of an Event describing an exception.
    
    See Also:
    
    Constant Field Values
  - EXCEPTION_TYPE
```
public static final StringAttributeSetter EXCEPTION_TYPE
```
    The type of the exception, i.e., it's fully qualified name.
  - EXCEPTION_MESSAGE
```
public static final StringAttributeSetter EXCEPTION_MESSAGE
```
    The exception message.
  - EXCEPTION_STACKTRACE
```
public static final StringAttributeSetter EXCEPTION_STACKTRACE
```
    A string representing the stacktrace of an exception, as produced by Throwable.printStackTrace().

Class SemanticAttributes

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NET_TRANSPORT

NET_PEER_IP

NET_PEER_PORT

NET_PEER_NAME

NET_HOST_IP

NET_HOST_PORT

NET_HOST_NAME

PEER_SERVICE

ENDUSER_ID

ENDUSER_ROLE

ENDUSER_SCOPE

HTTP_METHOD

HTTP_URL

HTTP_TARGET

HTTP_HOST

HTTP_SCHEME

HTTP_STATUS_CODE

HTTP_STATUS_TEXT

HTTP_FLAVOR

HTTP_USER_AGENT

HTTP_SERVER_NAME

HTTP_ROUTE

HTTP_CLIENT_IP

HTTP_REQUEST_CONTENT_LENGTH

HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED

HTTP_RESPONSE_CONTENT_LENGTH

HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED

RPC_SERVICE

MESSAGE_TYPE

MESSAGE_ID

MESSAGE_COMPRESSED_SIZE

MESSAGE_UNCOMPRESSED_SIZE

DB_SYSTEM

DB_NAME

DB_CONNECTION_STRING

DB_STATEMENT

DB_OPERATION

DB_USER

MSSQL_SQL_SERVER

JDBC_DRIVER_CLASSNAME

CASSANDRA_NAMESPACE

HBASE_NAMESPACE

REDIS_DATABASE_INDEX

MONGODB_COLLECTION

MESSAGING_SYSTEM

MESSAGING_DESTINATION

MESSAGING_DESTINATION_KIND

MESSAGING_TEMP_DESTINATION

MESSAGING_PROTOCOL

MESSAGING_PROTOCOL_VERSION

MESSAGING_URL

MESSAGING_MESSAGE_ID

MESSAGING_CONVERSATION_ID

MESSAGING_MESSAGE_PAYLOAD_SIZE_BYTES

MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES

MESSAGING_OPERATION

EXCEPTION_EVENT_NAME

EXCEPTION_TYPE

EXCEPTION_MESSAGE

EXCEPTION_STACKTRACE