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

      @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

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_COLLECTION_NAME
      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, unless the query format is known to only ever have a single collection name present.

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

      This attribute has stability level RELEASE CANDIDATE.

    • 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

      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_CONSISTENCY_LEVEL

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_COSMOSDB_CONSISTENCY_LEVEL
      Account or request consistency level.

    • 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.
      No replacement at this time.
      Deprecated, no replacement at this time.

    • DB_COSMOSDB_REGIONS_CONTACTED

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> DB_COSMOSDB_REGIONS_CONTACTED
      List of regions contacted during operation in the order that they were contacted. If there is more than one region listed, it indicates that the operation was performed on multiple regions i.e. cross-regional call.

      Notes:

      Region name matches the format of displayName in Azure Location API

    • DB_COSMOSDB_REQUEST_CHARGE

      public static final io.opentelemetry.api.common.AttributeKey<Double> DB_COSMOSDB_REQUEST_CHARGE
      Request units consumed for the 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

      @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

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

    • 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

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_ELASTICSEARCH_NODE_NAME
      Represents the human-readable identifier of the node/instance to which a request was routed.

    • 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

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_INSTANCE_ID
      Deprecated.
      Deprecated, 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 as not used.
      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.
      Deprecated, 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

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_NAMESPACE
      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 (potentially using database system specific conventions) from most general to most specific namespace component, and more specific namespaces SHOULD NOT be captured without the more general namespaces, to ensure that "startswith" queries for the more general namespaces will be valid. 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. This attribute has stability level RELEASE CANDIDATE.

    • 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

      public static final io.opentelemetry.api.common.AttributeKey<Long> DB_OPERATION_BATCH_SIZE
      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. This attribute has stability level RELEASE CANDIDATE.

    • DB_OPERATION_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_OPERATION_NAME
      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, unless the query format is known to only ever have a single operation name present.

      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.

      This attribute has stability level RELEASE CANDIDATE.

    • 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:

      If a parameter has no name and instead is referenced only by index, then <key> SHOULD be the 0-based index. If db.query.text is also captured, then db.operation.parameter.<key> SHOULD match up with the parameterized placeholders present in db.query.text. This attribute has stability level RELEASE CANDIDATE.

    • DB_QUERY_PARAMETER

      @Deprecated public static final io.opentelemetry.semconv.AttributeKeyTemplate<String> DB_QUERY_PARAMETER
      Deprecated.
      Replaced by db.operation.parameter.
      A query parameter used in db.query.text, with <key> being the parameter name, and the attribute value being a string representation of the parameter value.

    • DB_QUERY_SUMMARY

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_QUERY_SUMMARY
      Low cardinality representation of a database query text.

      Notes:

      db.query.summary provides static summary of the query text. It 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. This attribute has stability level RELEASE CANDIDATE.

    • DB_QUERY_TEXT

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_QUERY_TEXT
      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. 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. This attribute has stability level RELEASE CANDIDATE.

    • 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

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_RESPONSE_STATUS_CODE
      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. This attribute has stability level RELEASE CANDIDATE.

    • DB_SQL_TABLE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DB_SQL_TABLE
      Deprecated.
      Replaced by db.collection.name.
      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_SYSTEM

      public static final io.opentelemetry.api.common.AttributeKey<String> DB_SYSTEM
      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 is set to postgresql based on the instrumentation's best knowledge. This attribute has stability level RELEASE CANDIDATE.

    • DB_USER

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