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

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_CASSANDRA_CONSISTENCY_LEVEL
      Deprecated.
      Replaced by cassandra.consistency.level.
      Deprecated, use cassandra.consistency.level instead.

    • DB_CASSANDRA_COORDINATOR_DC

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_CASSANDRA_COORDINATOR_DC
      Deprecated.
      Replaced by cassandra.coordinator.dc.
      Deprecated, use cassandra.coordinator.dc instead.

    • DB_CASSANDRA_COORDINATOR_ID

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_CASSANDRA_COORDINATOR_ID
      Deprecated.
      Replaced by cassandra.coordinator.id.
      Deprecated, use cassandra.coordinator.id instead.

    • DB_CASSANDRA_IDEMPOTENCE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Boolean> DB_CASSANDRA_IDEMPOTENCE
      Deprecated.
      Replaced by cassandra.query.idempotent.
      Deprecated, use cassandra.query.idempotent instead.

    • DB_CASSANDRA_PAGE_SIZE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> DB_CASSANDRA_PAGE_SIZE
      Deprecated.
      Replaced by cassandra.page.size.
      Deprecated, use cassandra.page.size instead.

    • DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT
      Deprecated.
      Replaced by cassandra.speculative_execution.count.
      Deprecated, use cassandra.speculative_execution.count instead.

    • DB_CASSANDRA_TABLE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_CASSANDRA_TABLE
      Deprecated.
      Replaced by db.collection.name.
      Deprecated, use db.collection.name instead.

    • DB_CLIENT_CONNECTION_POOL_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_CLIENT_CONNECTION_POOL_NAME
      The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, instrumentation SHOULD use a combination of parameters that would make the name unique, for example, combining attributes server.address, server.port, and db.namespace, formatted as server.address:server.port/db.namespace. Instrumentations that generate connection pool name following different patterns SHOULD document it.

    • DB_CLIENT_CONNECTION_STATE

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_CLIENT_CONNECTION_STATE
      The state of a connection in the pool

    • DB_CLIENT_CONNECTIONS_POOL_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_CLIENT_CONNECTIONS_POOL_NAME
      Deprecated.
      Replaced by db.client.connection.pool.name.
      Deprecated, use db.client.connection.pool.name instead.

    • DB_CLIENT_CONNECTIONS_STATE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_CLIENT_CONNECTIONS_STATE
      Deprecated.
      Replaced by db.client.connection.state.
      Deprecated, use db.client.connection.state instead.

    • DB_COLLECTION_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_COLLECTION_NAME
      Deprecated.
      deprecated in favor of stable DbAttributes.DB_COLLECTION_NAME attribute.
      The name of a collection (table, container) within the database.

      Notes:

      It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization.

      The collection name SHOULD NOT be extracted from db.query.text, when the database system supports query text with multiple collections in non-batch operations.

      For batch operations, if the individual operations are known to have the same collection name then that collection name SHOULD be used.

    • DB_CONNECTION_STRING

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

    • DB_COSMOSDB_CLIENT_ID

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_COSMOSDB_CLIENT_ID
      Deprecated.
      Replaced by azure.client.id.
      Deprecated, use azure.client.id instead.

    • DB_COSMOSDB_CONNECTION_MODE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_COSMOSDB_CONNECTION_MODE
      Deprecated.
      Replaced by azure.cosmosdb.connection.mode.
      Deprecated, use azure.cosmosdb.connection.mode instead.

    • DB_COSMOSDB_CONSISTENCY_LEVEL

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_COSMOSDB_CONSISTENCY_LEVEL
      Deprecated.
      Replaced by azure.cosmosdb.consistency.level.
      Deprecated, use cosmosdb.consistency.level instead.

    • DB_COSMOSDB_CONTAINER

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_COSMOSDB_CONTAINER
      Deprecated.
      Replaced by db.collection.name.
      Deprecated, use db.collection.name instead.

    • DB_COSMOSDB_OPERATION_TYPE

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

    • DB_COSMOSDB_REGIONS_CONTACTED

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<List<String>> DB_COSMOSDB_REGIONS_CONTACTED
      Deprecated.
      Replaced by azure.cosmosdb.operation.contacted_regions.
      Deprecated, use azure.cosmosdb.operation.contacted_regions instead.

    • DB_COSMOSDB_REQUEST_CHARGE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Double> DB_COSMOSDB_REQUEST_CHARGE
      Deprecated.
      Replaced by azure.cosmosdb.operation.request_charge.
      Deprecated, use azure.cosmosdb.operation.request_charge instead.

    • DB_COSMOSDB_REQUEST_CONTENT_LENGTH

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> DB_COSMOSDB_REQUEST_CONTENT_LENGTH
      Deprecated.
      Replaced by azure.cosmosdb.request.body.size.
      Deprecated, use azure.cosmosdb.request.body.size instead.

    • DB_COSMOSDB_STATUS_CODE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> DB_COSMOSDB_STATUS_CODE
      Deprecated.
      Replaced by db.response.status_code.
      Deprecated, use db.response.status_code instead.

    • DB_COSMOSDB_SUB_STATUS_CODE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> DB_COSMOSDB_SUB_STATUS_CODE
      Deprecated.
      Replaced by azure.cosmosdb.response.sub_status_code.
      Deprecated, use azure.cosmosdb.response.sub_status_code instead.

    • DB_ELASTICSEARCH_CLUSTER_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_ELASTICSEARCH_CLUSTER_NAME
      Deprecated.
      Replaced by db.namespace.
      Deprecated, use db.namespace instead.

    • DB_ELASTICSEARCH_NODE_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_ELASTICSEARCH_NODE_NAME
      Deprecated.
      Replaced by elasticsearch.node.name.
      Deprecated, use elasticsearch.node.name instead.

    • DB_ELASTICSEARCH_PATH_PARTS

      @Deprecated public static final io.opentelemetry.semconv.AttributeKeyTemplate<String> DB_ELASTICSEARCH_PATH_PARTS
      Deprecated.
      Replaced by db.operation.parameter.
      Deprecated, use db.operation.parameter instead.

    • DB_INSTANCE_ID

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_INSTANCE_ID
      Deprecated.
      Removed, no general replacement at this time. For Elasticsearch, use db.elasticsearch.node.name instead.
      Deprecated, no general replacement at this time. For Elasticsearch, use db.elasticsearch.node.name instead.

    • 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

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_MONGODB_COLLECTION
      Deprecated.
      Replaced by db.collection.name.
      Deprecated, use db.collection.name instead.

    • DB_MSSQL_INSTANCE_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_MSSQL_INSTANCE_NAME
      Deprecated.
      Removed, no replacement at this time.
      Deprecated, SQL Server instance is now populated as a part of db.namespace attribute.

    • DB_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_NAME
      Deprecated.
      Replaced by db.namespace.
      Deprecated, use db.namespace instead.

    • DB_NAMESPACE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_NAMESPACE
      Deprecated.
      deprecated in favor of stable DbAttributes.DB_NAMESPACE attribute.
      The name of the database, fully qualified within the server address and port.

      Notes:

      If a database system has multiple namespace components, they SHOULD be concatenated from the most general to the most specific namespace component, using | as a separator between the components. Any missing components (and their associated separators) SHOULD be omitted. Semantic conventions for individual database systems SHOULD document what db.namespace means in the context of that system. It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization.

    • DB_OPERATION

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_OPERATION
      Deprecated.
      Replaced by db.operation.name.
      Deprecated, use db.operation.name instead.

    • DB_OPERATION_BATCH_SIZE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> DB_OPERATION_BATCH_SIZE
      Deprecated.
      deprecated in favor of stable DbAttributes.DB_OPERATION_BATCH_SIZE attribute.
      The number of queries included in a batch operation.

      Notes:

      Operations are only considered batches when they contain two or more operations, and so db.operation.batch.size SHOULD never be 1.

    • DB_OPERATION_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_OPERATION_NAME
      Deprecated.
      deprecated in favor of stable DbAttributes.DB_OPERATION_NAME attribute.
      The name of the operation or command being executed.

      Notes:

      It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization.

      The operation name SHOULD NOT be extracted from db.query.text, when the database system supports query text with multiple operations in non-batch operations.

      If spaces can occur in the operation name, multiple consecutive spaces SHOULD be normalized to a single space.

      For batch operations, if the individual operations are known to have the same operation name then that operation name SHOULD be used prepended by BATCH , otherwise db.operation.name SHOULD be BATCH or some other database system specific term if more applicable.

    • DB_OPERATION_PARAMETER

      public static final io.opentelemetry.semconv.AttributeKeyTemplate<String> DB_OPERATION_PARAMETER
      A database operation parameter, with <key> being the parameter name, and the attribute value being a string representation of the parameter value.

      Notes:

      For example, a client-side maximum number of rows to read from the database MAY be recorded as the db.operation.parameter.max_rows attribute.

      db.query.text parameters SHOULD be captured using db.query.parameter.<key> instead of db.operation.parameter.<key>.

    • DB_QUERY_PARAMETER

      public static final io.opentelemetry.semconv.AttributeKeyTemplate<String> DB_QUERY_PARAMETER
      A database query parameter, with <key> being the parameter name, and the attribute value being a string representation of the parameter value.

      Notes:

      If a query parameter has no name and instead is referenced only by index, then <key> SHOULD be the 0-based index.

      db.query.parameter.<key> SHOULD match up with the parameterized placeholders present in db.query.text.

      db.query.parameter.<key> SHOULD NOT be captured on batch operations.

      Examples:

      • For a query SELECT * FROM users where username = %s with the parameter "jdoe", the attribute db.query.parameter.0 SHOULD be set to "jdoe".
      • For a query "SELECT * FROM users WHERE username = %(username)s; with parameter username = "jdoe", the attribute db.query.parameter.username SHOULD be set to "jdoe".

    • DB_QUERY_SUMMARY

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_QUERY_SUMMARY
      Deprecated.
      deprecated in favor of stable DbAttributes.DB_QUERY_SUMMARY attribute.
      Low cardinality summary of a database query.

      Notes:

      The query summary describes a class of database queries and is useful as a grouping key, especially when analyzing telemetry for database calls involving complex queries.

      Summary may be available to the instrumentation through instrumentation hooks or other means. If it is not available, instrumentations that support query parsing SHOULD generate a summary following Generating query summary section.

    • DB_QUERY_TEXT

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_QUERY_TEXT
      Deprecated.
      deprecated in favor of stable DbAttributes.DB_QUERY_TEXT attribute.
      The database query being executed.

      Notes:

      For sanitization see Sanitization of db.query.text. For batch operations, if the individual operations are known to have the same query text then that query text SHOULD be used, otherwise all of the individual query texts SHOULD be concatenated with separator ; or some other database system specific separator if more applicable. Parameterized query text SHOULD NOT be sanitized. Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk.

    • DB_REDIS_DATABASE_INDEX

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> DB_REDIS_DATABASE_INDEX
      Deprecated.
      Replaced by db.namespace.
      Deprecated, use db.namespace instead.

    • DB_RESPONSE_RETURNED_ROWS

      public static final io.opentelemetry.api.common.AttributeKey<Long> DB_RESPONSE_RETURNED_ROWS
      Number of rows returned by the operation.

    • DB_RESPONSE_STATUS_CODE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_RESPONSE_STATUS_CODE
      Deprecated.
      deprecated in favor of stable DbAttributes.DB_RESPONSE_STATUS_CODE attribute.
      Database response status code.

      Notes:

      The status code returned by the database. Usually it represents an error code, but may also represent partial success, warning, or differentiate between various types of successful outcomes. Semantic conventions for individual database systems SHOULD document what db.response.status_code means in the context of that system.

    • DB_SQL_TABLE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_SQL_TABLE
      Deprecated.
      Replaced by db.collection.name, but only if not extracting the value from db.query.text.
      Deprecated, use db.collection.name instead.

    • DB_STATEMENT

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_STATEMENT
      Deprecated.
      Replaced by db.query.text.
      The database statement being executed.

    • DB_STORED_PROCEDURE_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_STORED_PROCEDURE_NAME
      Deprecated.
      deprecated in favor of stable DbAttributes.DB_STORED_PROCEDURE_NAME attribute.
      The name of a stored procedure within the database.

      Notes:

      It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization.

      For batch operations, if the individual operations are known to have the same stored procedure name then that stored procedure name SHOULD be used.

    • DB_SYSTEM

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_SYSTEM
      Deprecated.
      Replaced by db.system.name.
      Deprecated, use db.system.name instead.

    • DB_SYSTEM_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_SYSTEM_NAME
      Deprecated.
      deprecated in favor of stable DbAttributes.DB_SYSTEM_NAME attribute.
      The database management system (DBMS) product as identified by the client instrumentation.

      Notes:

      The actual DBMS may differ from the one identified by the client. For example, when using PostgreSQL client libraries to connect to a CockroachDB, the db.system.name is set to postgresql based on the instrumentation's best knowledge.

    • DB_USER

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