Node JS version

node_modules/cassandra-driver/lib/metrics/client-metrics.js

@@ -0,0 +1,129 @@
+/*
+ * Copyright DataStax, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+/**
+ * Represents a base class that is used to measure events from the server and the client as seen by the driver.
+ * @alias module:metrics~ClientMetrics
+ * @interface
+ */
+class ClientMetrics {
+  /**
+   * Method invoked when an authentication error is obtained from the server.
+   * @param {AuthenticationError|Error} e The error encountered.
+   */
+  onAuthenticationError(e) {}
+
+  /**
+   * Method invoked when an error (different than a server or client timeout, authentication or connection error) is
+   * encountered when executing a request.
+   * @param {OperationTimedOutError} e The timeout error.
+   */
+  onClientTimeoutError(e) {}
+
+  /**
+   * Method invoked when there is a connection error.
+   * @param {Error} e The error encountered.
+   */
+  onConnectionError(e) {}
+
+  /**
+   * Method invoked when an error (different than a server or client timeout, authentication or connection error) is
+   * encountered when executing a request.
+   * @param {Error} e The error encountered.
+   */
+  onOtherError(e) {}
+
+  /**
+   * Method invoked when a read timeout error is obtained from the server.
+   * @param {ResponseError} e The error encountered.
+   */
+  onReadTimeoutError(e) {}
+
+  /**
+   * Method invoked when a write timeout error is obtained from the server.
+   * @param {ResponseError} e The error encountered.
+   */
+  onWriteTimeoutError(e) {}
+
+  /**
+   * Method invoked when an unavailable error is obtained from the server.
+   * @param {ResponseError} e The error encountered.
+   */
+  onUnavailableError(e) {}
+
+  /**
+   * Method invoked when an execution is retried as a result of a client-level timeout.
+   * @param {Error} e The error that caused the retry.
+   */
+  onClientTimeoutRetry(e) {}
+
+  /**
+   * Method invoked when an error (other than a server or client timeout) is retried.
+   * @param {Error} e The error that caused the retry.
+   */
+  onOtherErrorRetry(e) {}
+
+  /**
+   * Method invoked when an execution is retried as a result of a read timeout from the server (coordinator to replica).
+   * @param {Error} e The error that caused the retry.
+   */
+  onReadTimeoutRetry(e) {}
+
+  /**
+   * Method invoked when an execution is retried as a result of an unavailable error from the server.
+   * @param {Error} e The error that caused the retry.
+   */
+  onUnavailableRetry(e) {}
+
+  /**
+   * Method invoked when an execution is retried as a result of a write timeout from the server (coordinator to
+   * replica).
+   * @param {Error} e The error that caused the retry.
+   */
+  onWriteTimeoutRetry(e) {}
+
+  /**
+   * Method invoked when an error is marked as ignored by the retry policy.
+   * @param {Error} e The error that was ignored by the retry policy.
+   */
+  onIgnoreError(e) {}
+
+  /**
+   * Method invoked when a speculative execution is started.
+   */
+  onSpeculativeExecution() {}
+
+  /**
+   * Method invoked when a response is obtained successfully.
+   * @param {Array<Number>} latency The latency represented in a <code>[seconds, nanoseconds]</code> tuple
+   * Array, where nanoseconds is the remaining part of the real time that can't be represented in second precision.
+   */
+  onSuccessfulResponse(latency) {}
+
+  /**
+   * Method invoked when any response is obtained, the response can be the result of a successful execution or a
+   * server-side error.
+   * @param {Array<Number>} latency The latency represented in a <code>[seconds, nanoseconds]</code> tuple
+   * Array, where nanoseconds is the remaining part of the real time that can't be represented in second precision.
+   */
+  onResponse(latency) {
+
+  }
+}
+
+module.exports = ClientMetrics;

node_modules/cassandra-driver/lib/metrics/default-metrics.js

@@ -0,0 +1,198 @@
+/*
+ * Copyright DataStax, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+const ClientMetrics = require('./client-metrics');
+const EventEmitter = require('events');
+
+/**
+ * A default implementation of [ClientMetrics]{@link module:metrics~ClientMetrics} that exposes the driver events as
+ * Node.js events.
+ * <p>
+ *   An instance of [DefaultMetrics]{@link module:metrics~DefaultMetrics} is configured by default in the client,
+ *   you can access this instance using [Client#metrics]{@link Client#metrics} property.
+ * </p>
+ * @implements {module:metrics~ClientMetrics}
+ * @alias module:metrics~DefaultMetrics
+ * @example <caption>Listening to events emitted</caption>
+ * defaultMetrics.errors.on('increment', err => totalErrors++);
+ * defaultMetrics.errors.clientTimeout.on('increment', () => clientTimeoutErrors++);
+ * defaultMetrics.speculativeRetries.on('increment', () => specExecsCount++);
+ * defaultMetrics.responses.on('increment', latency => myHistogram.record(latency));
+ */
+class DefaultMetrics extends ClientMetrics {
+  /**
+   * Creates a new instance of [DefaultMetrics]{@link module:metrics~DefaultMetrics}.
+   */
+  constructor() {
+    super();
+
+    /**
+     * Emits all the error events.
+     * <p>Use each of the properties to measure events of specific errors.</p>
+     * @type {EventEmitter}
+     * @property {EventEmitter} authentication Emits the authentication timeout error events.
+     * @property {EventEmitter} clientTimeout Emits the client timeout error events.
+     * @property {EventEmitter} connection Emits the connection error events.
+     * @property {EventEmitter} readTimeout Emits the read timeout error events obtained from the server.
+     * @property {EventEmitter} other Emits the error events, that are not part of the other categories.
+     * @property {EventEmitter} unavailable Emits the unavailable error events obtained from the server.
+     * @property {EventEmitter} writeTimeout Emits the write timeout error events obtained from the server
+     */
+    this.errors = new EventEmitter();
+    this.errors.authentication = new EventEmitter();
+    this.errors.clientTimeout = new EventEmitter();
+    this.errors.connection = new EventEmitter();
+    this.errors.other = new EventEmitter();
+    this.errors.readTimeout = new EventEmitter();
+    this.errors.unavailable = new EventEmitter();
+    this.errors.writeTimeout = new EventEmitter();
+
+    /**
+     * Emits all the retry events.
+     * <p>Use each of the properties to measure events of specific retries.</p>
+     * @type {EventEmitter}
+     * @property {EventEmitter} clientTimeout Emits when an execution is retried as a result of an client timeout.
+     * @property {EventEmitter} other Emits the error events, that are not part of the other categories.
+     * @property {EventEmitter} readTimeout Emits an execution is retried as a result of an read timeout error from the
+     * server (coordinator to replica).
+     * @property {EventEmitter} unavailable Emits an execution is retried as a result of an unavailable error from the
+     * server.
+     * @property {EventEmitter} writeTimeout Emits an execution is retried as a result of a write timeout error from the
+     * server (coordinator to replica).
+     */
+    this.retries = new EventEmitter();
+    this.retries.clientTimeout = new EventEmitter();
+    this.retries.other = new EventEmitter();
+    this.retries.readTimeout = new EventEmitter();
+    this.retries.unavailable = new EventEmitter();
+    this.retries.writeTimeout = new EventEmitter();
+
+    /**
+     * Emits events when a speculative execution is started.
+     * @type {EventEmitter}
+     */
+    this.speculativeExecutions = new EventEmitter();
+
+    /**
+     * Emits events when an error is ignored by the retry policy.
+     * @type {EventEmitter}
+     */
+    this.ignoredErrors = new EventEmitter();
+
+    /**
+     * Emits events when a response message is obtained.
+     * @type {EventEmitter}
+     * @property {EventEmitter} success Emits when a response was obtained as the result of a successful execution.
+     */
+    this.responses = new EventEmitter();
+    this.responses.success = new EventEmitter();
+  }
+
+  /** @override */
+  onAuthenticationError(e) {
+    this.errors.authentication.emit('increment', e);
+    this.errors.emit('increment', e);}
+
+  /** @override */
+  onConnectionError(e) {
+    this.errors.connection.emit('increment', e);
+    this.errors.emit('increment', e);
+  }
+
+  /** @override */
+  onReadTimeoutError(e) {
+    this.errors.readTimeout.emit('increment', e);
+    this.errors.emit('increment', e);
+  }
+
+  /** @override */
+  onWriteTimeoutError(e) {
+    this.errors.writeTimeout.emit('increment', e);
+    this.errors.emit('increment', e);
+  }
+
+  /** @override */
+  onUnavailableError(e) {
+    this.errors.unavailable.emit('increment', e);
+    this.errors.emit('increment', e);
+  }
+
+  /** @override */
+  onClientTimeoutError(e) {
+    this.errors.clientTimeout.emit('increment', e);
+    this.errors.emit('increment', e);
+  }
+
+  /** @override */
+  onOtherError(e) {
+    this.errors.other.emit('increment', e);
+    this.errors.emit('increment', e);
+  }
+
+  /** @override */
+  onClientTimeoutRetry(e) {
+    this.retries.clientTimeout.emit('increment', e);
+    this.retries.emit('increment', e);
+  }
+
+  /** @override */
+  onOtherErrorRetry(e) {
+    this.retries.other.emit('increment', e);
+    this.retries.emit('increment', e);
+  }
+
+  /** @override */
+  onReadTimeoutRetry(e) {
+    this.retries.readTimeout.emit('increment', e);
+    this.retries.emit('increment', e);
+  }
+
+  /** @override */
+  onUnavailableRetry(e) {
+    this.retries.unavailable.emit('increment', e);
+    this.retries.emit('increment', e);
+  }
+
+  /** @override */
+  onWriteTimeoutRetry(e) {
+    this.retries.writeTimeout.emit('increment', e);
+    this.retries.emit('increment', e);
+  }
+
+  /** @override */
+  onIgnoreError(e) {
+    this.ignoredErrors.emit('increment', e);
+  }
+
+  /** @override */
+  onSpeculativeExecution() {
+    this.speculativeExecutions.emit('increment');
+  }
+
+  /** @override */
+  onSuccessfulResponse(latency) {
+    this.responses.success.emit('increment', latency);
+  }
+
+  /** @override */
+  onResponse(latency) {
+    this.responses.emit('increment', latency);
+  }
+}
+
+module.exports = DefaultMetrics;

node_modules/cassandra-driver/lib/metrics/index.d.ts

@@ -0,0 +1,89 @@
+/*
+ * Copyright DataStax, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { errors } from '../../';
+
+export namespace metrics {
+  interface ClientMetrics {
+    onAuthenticationError(e: Error | errors.AuthenticationError): void;
+
+    onClientTimeoutError(e: errors.OperationTimedOutError): void;
+
+    onClientTimeoutRetry(e: Error): void;
+
+    onConnectionError(e: Error): void;
+
+    onIgnoreError(e: Error): void;
+
+    onOtherError(e: Error): void;
+
+    onOtherErrorRetry(e: Error): void;
+
+    onReadTimeoutError(e: errors.ResponseError): void;
+
+    onReadTimeoutRetry(e: Error): void;
+
+    onResponse(latency: number[]): void;
+
+    onSpeculativeExecution(): void;
+
+    onSuccessfulResponse(latency: number[]): void;
+
+    onUnavailableError(e: errors.ResponseError): void;
+
+    onUnavailableRetry(e: Error): void;
+
+    onWriteTimeoutError(e: errors.ResponseError): void;
+
+    onWriteTimeoutRetry(e: Error): void;
+  }
+
+  class DefaultMetrics implements ClientMetrics {
+    constructor();
+
+    onAuthenticationError(e: Error | errors.AuthenticationError): void;
+
+    onClientTimeoutError(e: errors.OperationTimedOutError): void;
+
+    onClientTimeoutRetry(e: Error): void;
+
+    onConnectionError(e: Error): void;
+
+    onIgnoreError(e: Error): void;
+
+    onOtherError(e: Error): void;
+
+    onOtherErrorRetry(e: Error): void;
+
+    onReadTimeoutError(e: errors.ResponseError): void;
+
+    onReadTimeoutRetry(e: Error): void;
+
+    onResponse(latency: number[]): void;
+
+    onSpeculativeExecution(): void;
+
+    onSuccessfulResponse(latency: number[]): void;
+
+    onUnavailableError(e: errors.ResponseError): void;
+
+    onUnavailableRetry(e: Error): void;
+
+    onWriteTimeoutError(e: errors.ResponseError): void;
+
+    onWriteTimeoutRetry(e: Error): void;
+  }
+}

node_modules/cassandra-driver/lib/metrics/index.js

@@ -0,0 +1,28 @@
+/*
+ * Copyright DataStax, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+const ClientMetrics = require('./client-metrics');
+const DefaultMetrics = require('./default-metrics');
+
+/**
+ * The <code>metrics</code> module contains interfaces and implementations used by the driver to expose
+ * measurements of its internal behavior and of the server as seen from the driver side.
+ * @module metrics
+ */
+
+module.exports = { ClientMetrics, DefaultMetrics };