Package io.opentelemetry.semconv.incubating

Class DbIncubatingAttributes

java.lang.Object
io.opentelemetry.semconv.incubating.DbIncubatingAttributes
public final class DbIncubatingAttributes extends Object

  • Field Details

    • DB_CASSANDRA_CONSISTENCY_LEVEL

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_CASSANDRA_CONSISTENCY_LEVEL
      The consistency level of the query. Based on consistency values from CQL.

    • DB_CASSANDRA_COORDINATOR_DC

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_CASSANDRA_COORDINATOR_DC
      The data center of the coordinating node for a query.

    • DB_CASSANDRA_COORDINATOR_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_CASSANDRA_COORDINATOR_ID
      The ID of the coordinating node for a query.

    • DB_CASSANDRA_IDEMPOTENCE

      public static final io.opentelemetry.api.common.AttributeKey<Boolean> DB_CASSANDRA_IDEMPOTENCE
      Whether or not the query is idempotent.

    • DB_CASSANDRA_PAGE_SIZE

      public static final io.opentelemetry.api.common.AttributeKey<Long> DB_CASSANDRA_PAGE_SIZE
      The fetch size used for paging, i.e. how many rows will be returned at once.

    • DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT

      public static final io.opentelemetry.api.common.AttributeKey<Long> DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT
      The number of times a query was speculatively executed. Not set or 0 if the query was not executed speculatively.

    • DB_CASSANDRA_TABLE

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_CASSANDRA_TABLE
      The name of the primary Cassandra table that the operation is acting upon, including the keyspace name (if applicable).

      Notes:

      • This mirrors the db.sql.table attribute but references cassandra rather than sql. It is not recommended to attempt any client-side parsing of db.statement just to get this property, but it should be set if it is provided by the library being instrumented. If the operation is acting upon an anonymous table, or more than one table, this value MUST NOT be set.

    • DB_CONNECTION_STRING

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_CONNECTION_STRING
      Deprecated.
      Deprecated, use `server.address`, `server.port` attributes instead.
      Deprecated, use server.address, server.port attributes instead.

    • DB_COSMOSDB_CLIENT_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_COSMOSDB_CLIENT_ID
      Unique Cosmos client instance id.

    • DB_COSMOSDB_CONNECTION_MODE

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_COSMOSDB_CONNECTION_MODE
      Cosmos client connection mode.

    • DB_COSMOSDB_CONTAINER

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_COSMOSDB_CONTAINER
      Cosmos DB container name.

    • DB_COSMOSDB_OPERATION_TYPE

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_COSMOSDB_OPERATION_TYPE
      CosmosDB Operation Type.

    • DB_COSMOSDB_REQUEST_CHARGE

      public static final io.opentelemetry.api.common.AttributeKey<Double> DB_COSMOSDB_REQUEST_CHARGE
      RU consumed for that operation

    • DB_COSMOSDB_REQUEST_CONTENT_LENGTH

      public static final io.opentelemetry.api.common.AttributeKey<Long> DB_COSMOSDB_REQUEST_CONTENT_LENGTH
      Request payload size in bytes

    • DB_COSMOSDB_STATUS_CODE

      public static final io.opentelemetry.api.common.AttributeKey<Long> DB_COSMOSDB_STATUS_CODE
      Cosmos DB status code.

    • DB_COSMOSDB_SUB_STATUS_CODE

      public static final io.opentelemetry.api.common.AttributeKey<Long> DB_COSMOSDB_SUB_STATUS_CODE
      Cosmos DB sub status code.

    • DB_ELASTICSEARCH_CLUSTER_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_ELASTICSEARCH_CLUSTER_NAME
      Represents the identifier of an Elasticsearch cluster.

    • DB_ELASTICSEARCH_NODE_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_ELASTICSEARCH_NODE_NAME
      Deprecated.
      Deprecated, use `db.instance.id` instead.
      Deprecated, use db.instance.id instead.

    • DB_ELASTICSEARCH_PATH_PARTS

      public static final io.opentelemetry.semconv.AttributeKeyTemplate<String> DB_ELASTICSEARCH_PATH_PARTS
      A dynamic value in the url path.

      Notes:

      • Many Elasticsearch url paths allow dynamic values. These SHOULD be recorded in span attributes in the format db.elasticsearch.path_parts.<key>, where <key> is the url path part name. The implementation SHOULD reference the elasticsearch schema in order to map the path part values to their names.

    • DB_INSTANCE_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_INSTANCE_ID
      An identifier (address, unique name, or any other identifier) of the database instance that is executing queries or mutations on the current connection. This is useful in cases where the database is running in a clustered environment and the instrumentation is able to record the node executing the query. The client may obtain this value in databases like MySQL using queries like select @@hostname.

    • DB_JDBC_DRIVER_CLASSNAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_JDBC_DRIVER_CLASSNAME
      Deprecated.
      Removed, no replacement at this time.
      Removed, no replacement at this time.

    • DB_MONGODB_COLLECTION

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_MONGODB_COLLECTION
      The MongoDB collection being accessed within the database stated in db.name.

    • DB_MSSQL_INSTANCE_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_MSSQL_INSTANCE_NAME
      The Microsoft SQL Server instance name connecting to. This name is used to determine the port of a named instance.

      Notes:

      • If setting a db.mssql.instance_name, server.port is no longer required (but still recommended if non-standard).

    • DB_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_NAME
      This attribute is used to report the name of the database being accessed. For commands that switch the database, this should be set to the target database (even if the command fails).

      Notes:

      • In some SQL databases, the database name to be used is called "schema name". In case there are multiple layers that could be considered for database name (e.g. Oracle instance name and schema name), the database name to be used is the more specific layer (e.g. Oracle schema name).

    • DB_OPERATION

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_OPERATION
      The name of the operation being executed, e.g. the MongoDB command name such as findAndModify, or the SQL keyword.

      Notes:

      • When setting this to an SQL keyword, it is not recommended to attempt any client-side parsing of db.statement just to get this property, but it should be set if the operation name is provided by the library being instrumented. If the SQL statement has an ambiguous operation, or performs more than one operation, this value may be omitted.

    • DB_REDIS_DATABASE_INDEX

      public static final io.opentelemetry.api.common.AttributeKey<Long> DB_REDIS_DATABASE_INDEX
      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.

    • DB_SQL_TABLE

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_SQL_TABLE
      The name of the primary table that the operation is acting upon, including the database name (if applicable).

      Notes:

      • It is not recommended to attempt any client-side parsing of db.statement just to get this property, but it should be set if it is provided by the library being instrumented. If the operation is acting upon an anonymous table, or more than one table, this value MUST NOT be set.

    • DB_STATEMENT

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_STATEMENT
      The database statement being executed.

    • DB_SYSTEM

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_SYSTEM
      An identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers.

    • DB_USER

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_USER
      Username for accessing the database.