import { AttributesProcessor } from './AttributesProcessor'; import { InstrumentSelector } from './InstrumentSelector'; import { MeterSelector } from './MeterSelector'; import { Aggregation } from './Aggregation'; import { InstrumentType } from '../InstrumentDescriptor'; export declare type ViewOptions = { /** * Alters the metric stream: * This will be used as the name of the metrics stream. * If not provided, the original Instrument name will be used. */ name?: string; /** * Alters the metric stream: * This will be used as the description of the metrics stream. * If not provided, the original Instrument description will be used by default. * * @example changes the description of all selected instruments to 'sample description' * description: 'sample description' */ description?: string; /** * Alters the metric stream: * If provided, the attributes that are not in the list will be ignored. * If not provided, all attribute keys will be used by default. * * @example drops all attributes with top-level keys except for 'myAttr' and 'myOtherAttr' * attributeKeys: ['myAttr', 'myOtherAttr'] * @example drops all attributes * attributeKeys: [] */ attributeKeys?: string[]; /** * Alters the metric stream: * Alters the {@link Aggregation} of the metric stream. * * @example changes the aggregation of the selected instrument(s) to ExplicitBucketHistogramAggregation * aggregation: new ExplicitBucketHistogramAggregation([1, 10, 100]) * @example changes the aggregation of the selected instrument(s) to LastValueAggregation * aggregation: new LastValueAggregation() */ aggregation?: Aggregation; /** * Alters the metric stream: * Sets a limit on the number of unique attribute combinations (cardinality) that can be aggregated. * If not provided, the default limit will be used. * * @example sets the cardinality limit to 1000 * aggregationCardinalityLimit: 1000 */ aggregationCardinalityLimit?: number; /** * Instrument selection criteria: * The original type of the Instrument(s). * * @example selects all counters * instrumentType: InstrumentType.COUNTER * @example selects all histograms * instrumentType: InstrumentType.HISTOGRAM */ instrumentType?: InstrumentType; /** * Instrument selection criteria: * Original name of the Instrument(s) with wildcard support. * * @example select all instruments * instrumentName: '*' * @example select all instruments starting with 'my.instruments.' * instrumentName: 'my.instruments.*' * @example select all instruments named 'my.instrument.requests' exactly * instrumentName: 'my.instruments.requests' */ instrumentName?: string; /** * Instrument selection criteria: * The unit of the Instrument(s). * * @example select all instruments with unit 'ms' * instrumentUnit: 'ms' */ instrumentUnit?: string; /** * Instrument selection criteria: * The name of the Meter. No wildcard support, name must match the meter exactly. * * @example select all meters named 'example.component.app' exactly * meterName: 'example.component.app' */ meterName?: string; /** * Instrument selection criteria: * The version of the Meter. No wildcard support, version must match exactly. * * @example * meterVersion: '1.0.1' */ meterVersion?: string; /** * Instrument selection criteria: * The schema URL of the Meter. No wildcard support, schema URL must match exactly. * * @example Select all meters with schema URL 'https://example.com/schema' exactly. * meterSchemaUrl: 'https://example.com/schema' */ meterSchemaUrl?: string; }; /** * Can be passed to a {@link MeterProvider} to select instruments and alter their metric stream. */ export declare class View { readonly name?: string; readonly description?: string; readonly aggregation: Aggregation; readonly attributesProcessor: AttributesProcessor; readonly instrumentSelector: InstrumentSelector; readonly meterSelector: MeterSelector; readonly aggregationCardinalityLimit?: number; /** * Create a new {@link View} instance. * * Parameters can be categorized as two types: * Instrument selection criteria: Used to describe the instrument(s) this view will be applied to. * Will be treated as additive (the Instrument has to meet all the provided criteria to be selected). * * Metric stream altering: Alter the metric stream of instruments selected by instrument selection criteria. * * @param viewOptions {@link ViewOptions} for altering the metric stream and instrument selection. * @param viewOptions.name * Alters the metric stream: * This will be used as the name of the metrics stream. * If not provided, the original Instrument name will be used. * @param viewOptions.description * Alters the metric stream: * This will be used as the description of the metrics stream. * If not provided, the original Instrument description will be used by default. * @param viewOptions.attributeKeys * Alters the metric stream: * If provided, the attributes that are not in the list will be ignored. * If not provided, all attribute keys will be used by default. * @param viewOptions.aggregationCardinalityLimit * Alters the metric stream: * Sets a limit on the number of unique attribute combinations (cardinality) that can be aggregated. * If not provided, the default limit of 2000 will be used. * @param viewOptions.aggregation * Alters the metric stream: * Alters the {@link Aggregation} of the metric stream. * @param viewOptions.instrumentName * Instrument selection criteria: * Original name of the Instrument(s) with wildcard support. * @param viewOptions.instrumentType * Instrument selection criteria: * The original type of the Instrument(s). * @param viewOptions.instrumentUnit * Instrument selection criteria: * The unit of the Instrument(s). * @param viewOptions.meterName * Instrument selection criteria: * The name of the Meter. No wildcard support, name must match the meter exactly. * @param viewOptions.meterVersion * Instrument selection criteria: * The version of the Meter. No wildcard support, version must match exactly. * @param viewOptions.meterSchemaUrl * Instrument selection criteria: * The schema URL of the Meter. No wildcard support, schema URL must match exactly. * * @example * // Create a view that changes the Instrument 'my.instrument' to use to an * // ExplicitBucketHistogramAggregation with the boundaries [20, 30, 40] * new View({ * aggregation: new ExplicitBucketHistogramAggregation([20, 30, 40]), * instrumentName: 'my.instrument' * }) */ constructor(viewOptions: ViewOptions); } //# sourceMappingURL=View.d.ts.map