# Semantic conventions for HBase client operations Site [llms.txt](/llms.txt) --- **Status**: [Development][DocumentStatus] - [Spans](#spans) - [Metrics](#metrics) The Semantic Conventions for [HBase](https://hbase.apache.org/) extend and override the [Database Semantic Conventions](README.md). ## Spans **Status:** ![Development](https://img.shields.io/badge/-development-blue) Spans representing calls to an HBase database adhere to the general [Semantic Conventions for Database Client Spans](/docs/specs/semconv/db/database-spans.md). **Span name** SHOULD follow the general [database span name convention](/docs/specs/semconv/db/database-spans.md#name) **Span kind** SHOULD be `CLIENT`. **Span status** SHOULD follow the [Recording Errors](/docs/specs/semconv/general/recording-errors.md) document. **Attributes:** | Key | Stability | [Requirement Level](/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`db.operation.name`](/docs/specs/semconv/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Required` | string | The name of the operation or command being executed. [1] | `findAndModify`; `HMSET`; `SELECT` | | [`db.system.name`](/docs/specs/semconv/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Required` | string | The database management system (DBMS) product as identified by the client instrumentation. [2] | `hbase` | | [`db.collection.name`](/docs/specs/semconv/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` If applicable. | string | The HBase table name. [3] | `mytable`; `ns:table` | | [`db.namespace`](/docs/specs/semconv/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` If applicable. | string | The HBase namespace. [4] | `mynamespace` | | [`db.response.status_code`](/docs/specs/semconv/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` If response was received. | string | Protocol-specific response code recorded as a string. [5] | `200`; `409`; `14` | | [`error.type`](/docs/specs/semconv/registry/attributes/error.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` If and only if the operation failed. | string | Describes a class of error the operation ended with. [6] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | | [`server.port`](/docs/specs/semconv/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` [7] | int | Server port number. [8] | `80`; `8080`; `443` | | [`db.operation.batch.size`](/docs/specs/semconv/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | int | The number of database operations included in a batch operation. [9] | `2`; `3`; `4` | | [`server.address`](/docs/specs/semconv/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | The database address specified in the client configuration. [10] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | **[1] `db.operation.name`:** 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 would all have the same `db.operation.name` when executed as non-batch operations, then that operation name SHOULD be used prepended by `BATCH `. Otherwise, `db.operation.name` SHOULD be `BATCH`. **[2] `db.system.name`:** MUST be set to `"hbase"`. **[3] `db.collection.name`:** It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization. If table name includes the namespace, the `db.collection.name` SHOULD be set to the full table name. **[4] `db.namespace`:** 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. **[5] `db.response.status_code`:** 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. The value MAY use a standardized string representation of a numeric status code, if one exists, instead of the numeric code. The value MAY be a synthetic status provided by the client library rather than returned by the remote service. Semantic conventions for individual database systems SHOULD document what `db.response.status_code` means in the context of that system. **[6] `error.type`:** The `error.type` SHOULD match the `db.response.status_code` returned by the database or the client library, or the canonical name of exception that occurred. When using canonical exception type name, instrumentation SHOULD do the best effort to report the most relevant type. For example, if the original exception is wrapped into a generic one, the original exception SHOULD be preferred. Instrumentations SHOULD document how `error.type` is populated. **[7] `server.port`:** If `server.address` is set and the client is configured with a single database server endpoint that uses a non-default port. **[8] `server.port`:** `server.port` SHOULD reflect the database port specified in the client configuration. It SHOULD NOT be derived from the server selected for an operation. **[9] `db.operation.batch.size`:** Except for empty batch requests described below, a batch operation contains two or more database operations explicitly submitted as separate operations in a single client call, protocol message, or database command. Requests to batch APIs that contain only one operation SHOULD be modeled as single operations, not as batch operations. A database call is not a batch operation solely because one operation accepts multiple operands, such as keys, rows, documents, points, or other data elements, including Redis [`MGET`](https://redis.io/docs/latest/commands/mget/) with multiple keys. In batch APIs that execute the same parameterized operation with parameter sets, each parameter set represents one database operation for determining whether the request is a batch operation. Requests with only one parameter set SHOULD be modeled as single operations, not as batch operations. `db.operation.batch.size` SHOULD be set to the number of operations in the batch. It SHOULD NOT be set for non-batch operations. A request to execute a batch operation with no operations SHOULD also be treated as a batch operation, and `db.operation.batch.size` SHOULD be set to `0`. **[10] `server.address`:** Instrumentation SHOULD set `server.address` to the database address specified in the client configuration. It SHOULD NOT derive the value from the server selected for an operation. > [!WARNING] > > `server.address` MUST NOT contain credentials or other sensitive information. See [Database server address](/docs/specs/semconv/db/database-spans.md#database-server-address) for guidance and examples. The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): * [`db.collection.name`](/docs/specs/semconv/registry/attributes/db.md) * [`db.namespace`](/docs/specs/semconv/registry/attributes/db.md) * [`db.operation.name`](/docs/specs/semconv/registry/attributes/db.md) * [`db.system.name`](/docs/specs/semconv/registry/attributes/db.md) * [`server.address`](/docs/specs/semconv/registry/attributes/server.md) * [`server.port`](/docs/specs/semconv/registry/attributes/server.md) ## Metrics HBase client instrumentations SHOULD collect metrics according to the general [Semantic Conventions for Database Client Metrics](database-metrics.md). `db.system.name` MUST be set to `"hbase"`. [DocumentStatus]: /docs/specs/otel/document-status/