Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
69 lines
3.9 KiB
Plaintext
69 lines
3.9 KiB
Plaintext
import { Span, Tracer, UpDownCounter, Attributes } from '@opentelemetry/api';
|
|
import { PgClientExtended, PostgresCallback, PgPoolCallback, PgPoolExtended, PgParsedConnectionParams, PgPoolOptionsParams } from './internal-types';
|
|
import { PgInstrumentationConfig } from './types';
|
|
import type * as pgTypes from 'pg';
|
|
import { SemconvStability } from '@opentelemetry/instrumentation';
|
|
/**
|
|
* Helper function to get a low cardinality span name from whatever info we have
|
|
* about the query.
|
|
*
|
|
* This is tricky, because we don't have most of the information (table name,
|
|
* operation name, etc) the spec recommends using to build a low-cardinality
|
|
* value w/o parsing. So, we use db.name and assume that, if the query's a named
|
|
* prepared statement, those `name` values will be low cardinality. If we don't
|
|
* have a named prepared statement, we try to parse an operation (despite the
|
|
* spec's warnings).
|
|
*
|
|
* @params dbName The name of the db against which this query is being issued,
|
|
* which could be missing if no db name was given at the time that the
|
|
* connection was established.
|
|
* @params queryConfig Information we have about the query being issued, typed
|
|
* to reflect only the validation we've actually done on the args to
|
|
* `client.query()`. This will be undefined if `client.query()` was called
|
|
* with invalid arguments.
|
|
*/
|
|
export declare function getQuerySpanName(dbName: string | undefined, queryConfig?: {
|
|
text: string;
|
|
name?: unknown;
|
|
}): string;
|
|
export declare function parseNormalizedOperationName(queryText: string): string;
|
|
export declare function parseAndMaskConnectionString(connectionString: string): string;
|
|
export declare function getConnectionString(params: PgParsedConnectionParams | PgPoolOptionsParams): string;
|
|
export declare function getSemanticAttributesFromConnection(params: PgParsedConnectionParams, semconvStability: SemconvStability): Attributes;
|
|
export declare function getSemanticAttributesFromPoolConnection(params: PgPoolOptionsParams, semconvStability: SemconvStability): Attributes;
|
|
export declare function shouldSkipInstrumentation(instrumentationConfig: PgInstrumentationConfig): boolean;
|
|
export declare function handleConfigQuery(this: PgClientExtended, tracer: Tracer, instrumentationConfig: PgInstrumentationConfig, semconvStability: SemconvStability, queryConfig?: {
|
|
text: string;
|
|
values?: unknown;
|
|
name?: unknown;
|
|
}): Span;
|
|
export declare function handleExecutionResult(config: PgInstrumentationConfig, span: Span, pgResult: pgTypes.QueryResult | pgTypes.QueryArrayResult | unknown): void;
|
|
export declare function patchCallback(instrumentationConfig: PgInstrumentationConfig, span: Span, cb: PostgresCallback, attributes: Attributes, recordDuration: {
|
|
(): void;
|
|
}): PostgresCallback;
|
|
export declare function getPoolName(pool: PgPoolOptionsParams): string;
|
|
export interface poolConnectionsCounter {
|
|
used: number;
|
|
idle: number;
|
|
pending: number;
|
|
}
|
|
export declare function updateCounter(poolName: string, pool: PgPoolExtended, connectionCount: UpDownCounter, connectionPendingRequests: UpDownCounter, latestCounter: poolConnectionsCounter): poolConnectionsCounter;
|
|
export declare function patchCallbackPGPool(span: Span, cb: PgPoolCallback): PgPoolCallback;
|
|
export declare function patchClientConnectCallback(span: Span, cb: Function): Function;
|
|
/**
|
|
* Attempt to get a message string from a thrown value, while being quite
|
|
* defensive, to recognize the fact that, in JS, any kind of value (even
|
|
* primitives) can be thrown.
|
|
*/
|
|
export declare function getErrorMessage(e: unknown): string | undefined;
|
|
export declare function isObjectWithTextString(it: unknown): it is ObjectWithText;
|
|
export type ObjectWithText = {
|
|
text: string;
|
|
[k: string]: unknown;
|
|
};
|
|
/**
|
|
* Generates a sanitized message for the error.
|
|
* Only includes the error type and PostgreSQL error code, omitting any sensitive details.
|
|
*/
|
|
export declare function sanitizedErrorMessage(error: unknown): string;
|
|
//# sourceMappingURL=utils.d.ts.map |