Skip to content

Commit

Permalink
Inline incubating constants from semantic-conventions
Browse files Browse the repository at this point in the history
  • Loading branch information
nwalters512 committed Dec 11, 2024
1 parent a27311d commit 3a42a6a
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ import {
METRIC_DB_CLIENT_OPERATION_DURATION,
ATTR_DB_NAMESPACE,
ATTR_DB_OPERATION_NAME,
} from '@opentelemetry/semantic-conventions/incubating';
} from './semantic-conventions';

export class PgInstrumentation extends InstrumentationBase<PgInstrumentationConfig> {
private _operationDuration!: Histogram;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
/**
* These constants are considered experimental exports of `@opentelemetry/semantic-conventions`.
* They're being inlined until they're officially exported by `@opentelemetry/semantic-conventions`.
*/

/**
* The number of connections that are currently in state described by the `state` attribute
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export declare const METRIC_DB_CLIENT_CONNECTION_COUNT: 'db.client.connection.count';

/**
* The number of pending requests for an open connection, cumulative for the entire pool
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export declare const METRIC_DB_CLIENT_CONNECTION_PENDING_REQUESTS: 'db.client.connection.pending_requests';

/**
* Duration of database client operations.
*
* @note Batch operations **SHOULD** be recorded as a single operation.
*
* @experimental This metric is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export declare const METRIC_DB_CLIENT_OPERATION_DURATION: 'db.client.operation.duration';

/**
* The name of the database, fully qualified within the server address and port.
*
* @example customers
*
* @example test.users
*
* @note 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.
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export declare const ATTR_DB_NAMESPACE: 'db.namespace';

/**
* The name of the operation or command being executed.
*
* @example findAndModify
*
* @example HMSET
*
* @example SELECT
*
* @note It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization.
* If the operation name is parsed from the query text, it **SHOULD** be the first operation name found in the query.
* 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.
*
* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
*/
export declare const ATTR_DB_OPERATION_NAME: 'db.operation.name';

0 comments on commit 3a42a6a

Please sign in to comment.