couchbase 4.6.0 → 4.7.0-dev.1

package/dist/cluster.js

@@ -14,10 +14,15 @@ const configProfile_1 = require("./configProfile");
 const connspec_1 = require("./connspec");
 const diagnosticsexecutor_1 = require("./diagnosticsexecutor");
 const eventingfunctionmanager_1 = require("./eventingfunctionmanager");
+const logger_1 = require("./logger");
+const loggingmeter_1 = require("./loggingmeter");
+const observability_1 = require("./observability");
+const observabilitytypes_1 = require("./observabilitytypes");
 const queryexecutor_1 = require("./queryexecutor");
 const queryindexmanager_1 = require("./queryindexmanager");
 const searchexecutor_1 = require("./searchexecutor");
 const searchindexmanager_1 = require("./searchindexmanager");
+const thresholdlogging_1 = require("./thresholdlogging");
 const transactions_1 = require("./transactions");
 const transcoders_1 = require("./transcoders");
 const usermanager_1 = require("./usermanager");
@@ -104,11 +109,22 @@ class Cluster {
     get resolveTimeout() {
         return this._resolveTimeout;
     }
+    /**
+    @internal
+    */
+    get logger() {
+        return this._logger;
+    }
+    /**
+     * @internal
+     */
+    get observabilityInstruments() {
+        return this._observabilityInstruments;
+    }
     /**
      * @internal
      */
     [util_1.inspect.custom]() {
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
         const { _auth, ...rest } = this;
         return { ...rest, _auth: '***hidden***' };
     }
@@ -116,7 +132,6 @@ class Cluster {
      * @internal
      */
     toJSON() {
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
         const { _auth, ...rest } = this;
         return { ...rest, _auth: '***hidden***' };
     }
@@ -208,6 +223,9 @@ class Cluster {
         else {
             this._appTelemetryConfig = null;
         }
+        if (options.tracer) {
+            this._tracer = options.tracer;
+        }
         if (options.tracingConfig) {
             this._tracingConfig = {
                 enableTracing: options.tracingConfig.enableTracing,
@@ -226,8 +244,8 @@ class Cluster {
             this._tracingConfig = null;
         }
         if (options.orphanReporterConfig) {
-            // TODO(JSCBC-1364):  Add enableReporting to config when supported in C++ core
             this._orphanReporterConfig = {
+                enableOrphanReporting: options.orphanReporterConfig.enableOrphanReporting,
                 emitInterval: options.orphanReporterConfig.emitInterval,
                 sampleSize: options.orphanReporterConfig.sampleSize,
             };
@@ -235,6 +253,9 @@ class Cluster {
         else {
             this._orphanReporterConfig = null;
         }
+        if (options.meter) {
+            this._meter = options.meter;
+        }
         if (options.metricsConfig) {
             this._metricsConfig = {
                 enableMetrics: options.metricsConfig.enableMetrics,
@@ -244,6 +265,27 @@ class Cluster {
         else {
             this._metricsConfig = null;
         }
+        if (!options.logger) {
+            const envLogLevel = process.env.CNLOGLEVEL;
+            if (envLogLevel) {
+                const level = (0, logger_1.parseLogLevel)(envLogLevel);
+                if (level !== undefined) {
+                    this._logger = (0, logger_1.createConsoleLogger)(level);
+                }
+                else {
+                    this._logger = new logger_1.CouchbaseLogger(new logger_1.NoOpLogger());
+                }
+            }
+            else {
+                this._logger = new logger_1.CouchbaseLogger(new logger_1.NoOpLogger());
+            }
+        }
+        else {
+            this._logger =
+                options.logger instanceof logger_1.CouchbaseLogger
+                    ? options.logger
+                    : new logger_1.CouchbaseLogger(options.logger);
+        }
         this._openBuckets = [];
         this._conn = new binding_1.default.Connection();
     }
@@ -267,7 +309,7 @@ class Cluster {
             this._conn.openBucket(bucketName, (err) => {
                 if (err) {
                     // BUG(JSCBC-1011): Move this to log framework once it is implemented.
-                    console.error('failed to open bucket: %O', err);
+                    console.error(`failed to open bucket: ${bucketName}`, err);
                 }
             });
             this._openBuckets.push(bucketName);
@@ -455,12 +497,93 @@ class Cluster {
             await this._transactions._close();
             this._transactions = undefined;
         }
+        if (this._tracer instanceof thresholdlogging_1.ThresholdLoggingTracer) {
+            this._tracer.cleanup();
+        }
+        if (this._meter instanceof loggingmeter_1.LoggingMeter) {
+            this._meter.cleanup();
+        }
         return utilities_1.PromiseHelper.wrap((wrapCallback) => {
             this._conn.shutdown((cppErr) => {
                 wrapCallback((0, bindingutilities_1.errorFromCpp)(cppErr));
             });
         }, callback);
     }
+    /**
+     * Update the credentials used by this cluster.
+     *
+     * @param auth The new credentials to use.
+     */
+    updateCredentials(auth) {
+        const cppErr = this._conn.updateCredentials(this._getCppCredentials(auth));
+        if (cppErr) {
+            const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+            throw err;
+        }
+    }
+    /**
+     * @internal
+     */
+    _getClusterLabels() {
+        const resp = this._conn.getClusterLabels();
+        return { clusterName: resp.clusterName, clusterUUID: resp.clusterUUID };
+    }
+    _getCppCredentials(auth, saslMechanisms) {
+        const authOpts = {};
+        if (auth) {
+            const passAuth = auth;
+            if (passAuth.username || passAuth.password) {
+                authOpts.username = passAuth.username;
+                authOpts.password = passAuth.password;
+                if (saslMechanisms) {
+                    authOpts.allowed_sasl_mechanisms = saslMechanisms;
+                }
+            }
+            const certAuth = auth;
+            if (certAuth.certificatePath || certAuth.keyPath) {
+                authOpts.certificate_path = certAuth.certificatePath;
+                authOpts.key_path = certAuth.keyPath;
+            }
+            const jwtAuth = auth;
+            if (jwtAuth.token) {
+                authOpts.jwt_token = jwtAuth.token;
+            }
+        }
+        return authOpts;
+    }
+    _setupObservability() {
+        // [tracing|metrics] is explicitly disabled IFF:
+        //            we have a [tracing|metrics]Config AND [tracing|metrics]Config.enable[Tracing|Metrics] === false
+        // _[tracing|metrics]Config = null                          => FALSE
+        // _[tracing|metrics]Config = undefined                     => FALSE
+        // _[tracing|metrics]Config.enable[Tracing|Metrics] = true  => FALSE
+        // _[tracing|metrics]Config.enable[Tracing|Metrics] = false => TRUE
+        var _a, _b, _c, _d, _e;
+        const tracingExplicitlyDisabled = ((_a = this._tracingConfig) !== null && _a !== void 0 ? _a : false) && !((_b = this._tracingConfig) === null || _b === void 0 ? void 0 : _b.enableTracing);
+        // we want to enable tracing IFF we don't have a tracer && tracing was NOT explicitly disabled
+        const enableTracing = typeof this._tracer !== 'undefined' || !tracingExplicitlyDisabled;
+        // if tracing is enabled, but we don't have a tracer, default to the ThresholdLoggingTracer
+        if (enableTracing && !this._tracer) {
+            this._tracer = new thresholdlogging_1.ThresholdLoggingTracer(this._logger, this._tracingConfig);
+        }
+        // if we don't have a tracer at this point, tracing is NOT enabled, use the NoOpTracer
+        if (!this._tracer) {
+            this._tracer = new observability_1.NoOpTracer();
+        }
+        const metricsExplicitlyDisabled = ((_c = this._metricsConfig) !== null && _c !== void 0 ? _c : false) && !((_d = this._metricsConfig) === null || _d === void 0 ? void 0 : _d.enableMetrics);
+        // we want to enable metrics IFF we don't have a meter && metrics was NOT explicitly disabled
+        const enableMetrics = typeof this._meter !== 'undefined' || !metricsExplicitlyDisabled;
+        // if metrics is enabled, but we don't have a meter, default to the LoggingMeter
+        if (enableMetrics && !this._meter) {
+            this._meter = new loggingmeter_1.LoggingMeter(this._logger, (_e = this._metricsConfig) === null || _e === void 0 ? void 0 : _e.emitInterval);
+        }
+        // if we don't have a meter at this point, metrics is NOT enabled, use the NoOpMeter
+        if (!this._meter) {
+            this._meter = new observability_1.NoOpMeter();
+        }
+        this._observabilityInstruments = new observabilitytypes_1.ObservabilityInstruments(this._tracer, this._meter, () => this._getClusterLabels());
+        return [enableTracing, enableMetrics];
+    }
     async _connect() {
         return new Promise((resolve, reject) => {
             const dsnObj = connspec_1.ConnSpec.parse(this._connStr);
@@ -488,36 +611,23 @@ class Cluster {
                 dsnObj.options['server_group'] = this._preferredServerGroup;
             }
             const connStr = dsnObj.toString();
-            const authOpts = {};
             // lets allow `allowed_sasl_mechanisms` to override legacy connstr option
+            let saslMechansims;
             for (const saslKey of ['sasl_mech_force', 'allowed_sasl_mechanisms']) {
                 if (!(saslKey in dsnObj.options)) {
                     continue;
                 }
                 if (typeof dsnObj.options[saslKey] === 'string') {
-                    authOpts.allowed_sasl_mechanisms = [dsnObj.options[saslKey]];
+                    saslMechansims = [dsnObj.options[saslKey]];
                 }
                 else {
-                    authOpts.allowed_sasl_mechanisms = dsnObj.options[saslKey];
+                    saslMechansims = dsnObj.options[saslKey];
                 }
                 delete dsnObj.options[saslKey];
             }
-            if (this._auth) {
-                const passAuth = this._auth;
-                if (passAuth.username || passAuth.password) {
-                    authOpts.username = passAuth.username;
-                    authOpts.password = passAuth.password;
-                    if (passAuth.allowed_sasl_mechanisms) {
-                        authOpts.allowed_sasl_mechanisms = passAuth.allowed_sasl_mechanisms;
-                    }
-                }
-                const certAuth = this._auth;
-                if (certAuth.certificatePath || certAuth.keyPath) {
-                    authOpts.certificate_path = certAuth.certificatePath;
-                    authOpts.key_path = certAuth.keyPath;
-                }
-            }
-            this._conn.connect(connStr, authOpts, this._dnsConfig, this._appTelemetryConfig, this._tracingConfig, this._orphanReporterConfig, this._metricsConfig, (cppErr) => {
+            const authOpts = this._getCppCredentials(this._auth, saslMechansims);
+            const [enableTracing, _enableMetrics] = this._setupObservability();
+            this._conn.connect(connStr, authOpts, this._dnsConfig, this._appTelemetryConfig, enableTracing, this._orphanReporterConfig, (cppErr) => {
                 if (cppErr) {
                     const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
                     return reject(err);

package/dist/collection.d.ts

@@ -7,11 +7,14 @@ import { CounterResult, ExistsResult, GetReplicaResult, GetResult, LookupInResul
 import { CouchbaseList, CouchbaseMap, CouchbaseQueue, CouchbaseSet } from './datastructures';
 import { DurabilityLevel, ReadPreference, StoreSemantics } from './generaltypes';
 import { MutationState } from './mutationstate';
+import { ObservableRequestHandler } from './observabilityhandler';
+import { ObservabilityInstruments } from './observabilitytypes';
 import { CollectionQueryIndexManager } from './queryindexmanager';
 import { RangeScan, SamplingScan, PrefixScan } from './rangeScan';
 import { Scope } from './scope';
 import { LookupInSpec, MutateInSpec } from './sdspecs';
 import { StreamableReplicasPromise, StreamableScanPromise } from './streamablepromises';
+import { RequestSpan } from './tracing';
 import { Transcoder } from './transcoders';
 import { NodeCallback, CasInput } from './utilities';
 /**
@@ -37,6 +40,10 @@ export interface GetOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Key-Value
@@ -46,6 +53,10 @@ export interface ExistsOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Key-Value
@@ -85,6 +96,10 @@ export interface InsertOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Key-Value
@@ -128,6 +143,10 @@ export interface UpsertOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Key-Value
@@ -176,6 +195,10 @@ export interface ReplaceOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Key-Value
@@ -206,6 +229,10 @@ export interface RemoveOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Key-Value
@@ -223,6 +250,10 @@ export interface GetAnyReplicaOptions {
      * Specifies how replica nodes will be filtered.
      */
     readPreference?: ReadPreference;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Key-Value
@@ -240,6 +271,10 @@ export interface GetAllReplicasOptions {
      * Specifies how replica nodes will be filtered.
      */
     readPreference?: ReadPreference;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Key-Value
@@ -253,6 +288,10 @@ export interface TouchOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Key-Value
@@ -266,6 +305,10 @@ export interface GetAndTouchOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Key-Value
@@ -279,6 +322,10 @@ export interface GetAndLockOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Key-Value
@@ -288,6 +335,10 @@ export interface UnlockOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Key-Value
@@ -303,6 +354,10 @@ export interface LookupInOptions {
      * @internal
      */
     accessDeleted?: boolean;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Key-Value
@@ -316,6 +371,10 @@ export interface LookupInAnyReplicaOptions {
      * Specifies how replica nodes will be filtered.
      */
     readPreference?: ReadPreference;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Key-Value
@@ -329,6 +388,10 @@ export interface LookupInAllReplicasOptions {
      * Specifies how replica nodes will be filtered.
      */
     readPreference?: ReadPreference;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Key-Value
@@ -384,6 +447,10 @@ export interface MutateInOptions {
      * @deprecated Use {@link MutateInOptions.storeSemantics} instead.
      */
     upsertDocument?: boolean;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Key-Value
@@ -459,6 +526,10 @@ export declare class Collection {
     @internal
     */
     get transcoder(): Transcoder;
+    /**
+     * @internal
+     */
+    get observabilityInstruments(): ObservabilityInstruments;
     /**
     @internal
     */
@@ -507,10 +578,11 @@ export declare class Collection {
     /**
      * @internal
      */
-    _getReplica(key: string, getAllReplicas: boolean, options?: {
+    _getReplica(key: string, obsReqHandler: ObservableRequestHandler, options: {
         transcoder?: Transcoder;
         timeout?: number;
         readPreference?: ReadPreference;
+        parentSpan?: RequestSpan;
     }, callback?: NodeCallback<GetReplicaResult[]>): StreamableReplicasPromise<GetReplicaResult[], GetReplicaResult>;
     /**
      * Retrieves the value of the document from any of the available replicas.  This
@@ -646,9 +718,10 @@ export declare class Collection {
     /**
      * @internal
      */
-    _lookupInReplica(key: string, lookupInAllReplicas: boolean, specs: LookupInSpec[], options?: {
+    _lookupInReplica(key: string, obsReqHandler: ObservableRequestHandler, specs: LookupInSpec[], options: {
         timeout?: number;
         readPreference?: ReadPreference;
+        parentSpan?: RequestSpan;
     }, callback?: NodeCallback<LookupInReplicaResult[]>): StreamableReplicasPromise<LookupInReplicaResult[], LookupInReplicaResult>;
     /**
      * Performs a lookup-in operation against a document, fetching individual fields or