index.d.ts

/*
 * 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 { ExecutionOptions, Host } from '../../';

export namespace tracker {
  interface RequestTracker {
    onError(
      host: Host,
      query: string | Array<{ query: string, params?: any }>,
      parameters: any[] | { [key: string]: any } | null,
      executionOptions: ExecutionOptions,
      requestLength: number,
      err: Error,
      latency: number[]): void;

    onSuccess(
      host: Host,
      query: string | Array<{ query: string, params?: any }>,
      parameters: any[] | { [key: string]: any } | null,
      executionOptions: ExecutionOptions,
      requestLength: number,
      responseLength: number,
      latency: number[]): void;

    shutdown(): void;
  }

  class RequestLogger implements RequestTracker {
    constructor(options: {
      slowThreshold?: number;
      logNormalRequests?: boolean;
      logErroredRequests?: boolean;
      messageMaxQueryLength?: number;
      messageMaxParameterValueLength?: number;
      messageMaxErrorStackTraceLength?: number;
    });

    onError(host: Host, query: string | Array<{ query: string; params?: any }>, parameters: any[] | { [p: string]: any } | null, executionOptions: ExecutionOptions, requestLength: number, err: Error, latency: number[]): void;

    onSuccess(host: Host, query: string | Array<{ query: string; params?: any }>, parameters: any[] | { [p: string]: any } | null, executionOptions: ExecutionOptions, requestLength: number, responseLength: number, latency: number[]): void;

    shutdown(): void;
  }
}