53 lines
2.1 KiB
TypeScript
53 lines
2.1 KiB
TypeScript
|
import { MeterProvider as IMeterProvider, Meter as IMeter, MeterOptions } from '@opentelemetry/api';
|
||
|
|
import { IResource } from '@opentelemetry/resources';
|
||
|
|
import { MetricReader } from './export/MetricReader';
|
||
|
|
import { ForceFlushOptions, ShutdownOptions } from './types';
|
||
|
|
import { View } from './view/View';
|
||
|
|
/**
|
||
|
|
* MeterProviderOptions provides an interface for configuring a MeterProvider.
|
||
|
|
*/
|
||
|
|
export interface MeterProviderOptions {
|
||
|
|
/** Resource associated with metric telemetry */
|
||
|
|
resource?: IResource;
|
||
|
|
views?: View[];
|
||
|
|
readers?: MetricReader[];
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* This class implements the {@link MeterProvider} interface.
|
||
|
|
*/
|
||
|
|
export declare class MeterProvider implements IMeterProvider {
|
||
|
|
private _sharedState;
|
||
|
|
private _shutdown;
|
||
|
|
constructor(options?: MeterProviderOptions);
|
||
|
|
/**
|
||
|
|
* Get a meter with the configuration of the MeterProvider.
|
||
|
|
*/
|
||
|
|
getMeter(name: string, version?: string, options?: MeterOptions): IMeter;
|
||
|
|
/**
|
||
|
|
* Register a {@link MetricReader} to the meter provider. After the
|
||
|
|
* registration, the MetricReader can start metrics collection.
|
||
|
|
*
|
||
|
|
* <p> NOTE: {@link MetricReader} instances MUST be added before creating any instruments.
|
||
|
|
* A {@link MetricReader} instance registered later may receive no or incomplete metric data.
|
||
|
|
*
|
||
|
|
* @param metricReader the metric reader to be registered.
|
||
|
|
*
|
||
|
|
* @deprecated This method will be removed in SDK 2.0. Please use
|
||
|
|
* {@link MeterProviderOptions.readers} via the {@link MeterProvider} constructor instead
|
||
|
|
*/
|
||
|
|
addMetricReader(metricReader: MetricReader): void;
|
||
|
|
/**
|
||
|
|
* Flush all buffered data and shut down the MeterProvider and all registered
|
||
|
|
* MetricReaders.
|
||
|
|
*
|
||
|
|
* Returns a promise which is resolved when all flushes are complete.
|
||
|
|
*/
|
||
|
|
shutdown(options?: ShutdownOptions): Promise<void>;
|
||
|
|
/**
|
||
|
|
* Notifies all registered MetricReaders to flush any buffered data.
|
||
|
|
*
|
||
|
|
* Returns a promise which is resolved when all flushes are complete.
|
||
|
|
*/
|
||
|
|
forceFlush(options?: ForceFlushOptions): Promise<void>;
|
||
|
|
}
|
||
|
|
//# sourceMappingURL=MeterProvider.d.ts.map
|