Libraries
    Preparing search index...

    Interface InstrumentKnexOptions

    Configuration for instrumentKnex.

    interface InstrumentKnexOptions {
        dbSystem?: string;
        recordStatement?: boolean;
        sanitizeStatement?: (sql: string) => string;
        tracerName?: string;
    }
    Index

    Properties

    dbSystem? recordStatement? sanitizeStatement? tracerName?

    Properties

    dbSystem?: string

    Value to record as db.system.name (e.g. postgresql, mysql, sqlite). When omitted, inferred from the knex client.

    recordStatement?: boolean

    Whether to include the SQL statement as db.query.text.

    The statement is taken verbatim from knex (parameter placeholders are kept; bound values are not included). Disable if your SQL itself may contain sensitive identifiers.

    true
    sanitizeStatement?: (sql: string) => string

    Optional hook to redact / rewrite the SQL before it is recorded. Called only when recordStatement is enabled.

    tracerName?: string

    Tracer name used when resolving the OTel tracer.

    '@cleverbrush/otel/knex'

    Settings

    Member Visibility

    On This Page

    Properties