Class PrometheusExporter

A registered reader of metrics that, when linked to a MetricProducer, offers global control over metrics.

Hierarchy (View Summary)

metrics.MetricReader
- PrometheusExporter

Index

Constructors

constructor

new PrometheusExporter(
config?: ExporterConfig,
callback?: (error: void | Error) => void,
): PrometheusExporter
Constructor
Parameters
- config: ExporterConfig = {}
  Exporter configuration
- callback: (error: void | Error) => void = ...
  Callback to be called after a server was started
Returns PrometheusExporter
Overrides MetricReader.constructor
- Defined in experimental/packages/opentelemetry-exporter-prometheus/src/PrometheusExporter.ts:59

Properties

`Static` `Readonly`DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    appendTimestamp: boolean;
    endpoint: string;
    host: undefined;
    port: number;
    prefix: string;
    withResourceConstantLabels: undefined;
} = ...

Methods

collect

collect(options?: CommonReaderOptions): Promise<metrics.CollectionResult>
Collect all metrics from the associated MetricProducer
Parameters
- Optionaloptions: CommonReaderOptions
Returns Promise<metrics.CollectionResult>
Inherited from MetricReader.collect
- Defined in packages/sdk-metrics/build/src/export/MetricReader.d.ts:130

forceFlush

forceFlush(options?: CommonReaderOptions): Promise<void>
Flushes metrics read by this reader, the promise will reject after the optional timeout or resolve after completion.

NOTE: this operation MAY continue even after the promise rejects due to a timeout.
Parameters
- Optionaloptions: CommonReaderOptions
  options with timeout.
Returns Promise<void>
Inherited from MetricReader.forceFlush
- Defined in packages/sdk-metrics/build/src/export/MetricReader.d.ts:132

getMetricsRequestHandler

getMetricsRequestHandler(
_request: IncomingMessage,
response: ServerResponse,
): void
Request handler that responds with the current state of metrics
Parameters
- _request: IncomingMessage
  Incoming HTTP request of server instance
- response: ServerResponse
  HTTP response object used to response to request
Returns void
- Defined in experimental/packages/opentelemetry-exporter-prometheus/src/PrometheusExporter.ts:180

`Protected`onForceFlush

onForceFlush(): Promise<void>
Protected
Handle a force flush signal by the SDK.

In all scenarios metrics should be collected via ().
For push exporters, this should collect and report metrics.
Returns Promise<void>
Overrides MetricReader.onForceFlush
- Defined in experimental/packages/opentelemetry-exporter-prometheus/src/PrometheusExporter.ts:113

`Protected`onInitialized

onInitialized(): void
Handle once the SDK has initialized this MetricReader Overriding this method is optional.

Returns void
Inherited from MetricReader.onInitialized
- Defined in packages/sdk-metrics/build/src/export/MetricReader.d.ts:114

onShutdown

onShutdown(): Promise<void>
Shuts down the export server and clears the registry

Returns Promise<void>
Overrides MetricReader.onShutdown
- Defined in experimental/packages/opentelemetry-exporter-prometheus/src/PrometheusExporter.ts:120

selectAggregation

selectAggregation(
instrumentType: metrics.InstrumentType,
): metrics.AggregationOption
Select the AggregationOption for the given InstrumentType for this reader.

NOTE: implementations MUST be pure
Parameters
- instrumentType: metrics.InstrumentType
Returns metrics.AggregationOption
Inherited from MetricReader.selectAggregation
- Defined in packages/sdk-metrics/build/src/export/MetricReader.d.ts:107

selectAggregationTemporality

selectAggregationTemporality(
instrumentType: metrics.InstrumentType,
): metrics.AggregationTemporality
Select the AggregationTemporality for the given InstrumentType for this reader.

NOTE: implementations MUST be pure
Parameters
- instrumentType: metrics.InstrumentType
Returns metrics.AggregationTemporality
Inherited from MetricReader.selectAggregationTemporality
- Defined in packages/sdk-metrics/build/src/export/MetricReader.d.ts:108

selectCardinalityLimit

selectCardinalityLimit(instrumentType: metrics.InstrumentType): number
Select the cardinality limit for the given InstrumentType for this reader.

NOTE: implementations MUST be pure
Parameters
- instrumentType: metrics.InstrumentType
Returns number
Inherited from MetricReader.selectCardinalityLimit
- Defined in packages/sdk-metrics/build/src/export/MetricReader.d.ts:109

setMetricProducer

setMetricProducer(metricProducer: metrics.MetricProducer): void
Set the MetricProducer used by this instance. This should only be called once by the SDK and should be considered internal.

NOTE: implementations MUST throw when called more than once
Parameters
- metricProducer: metrics.MetricProducer
Returns void
Inherited from MetricReader.setMetricProducer
- Defined in packages/sdk-metrics/build/src/export/MetricReader.d.ts:106

shutdown

shutdown(options?: CommonReaderOptions): Promise<void>
Shuts down the metric reader, the promise will reject after the optional timeout or resolve after completion.

NOTE: this operation MAY continue even after the promise rejects due to a timeout.
Parameters
- Optionaloptions: CommonReaderOptions
  options with timeout.
Returns Promise<void>
Inherited from MetricReader.shutdown
- Defined in packages/sdk-metrics/build/src/export/MetricReader.d.ts:131

startServer

startServer(): Promise<void>
Starts the Prometheus export server

Returns Promise<void>
- Defined in experimental/packages/opentelemetry-exporter-prometheus/src/PrometheusExporter.ts:155

stopServer

stopServer(): Promise<void>
Stops the Prometheus export server

Returns Promise<void>
- Defined in experimental/packages/opentelemetry-exporter-prometheus/src/PrometheusExporter.ts:127

Class PrometheusExporter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PrometheusExporter

Properties

Static ReadonlyDEFAULT_OPTIONS

Methods

collect

Parameters

Returns Promise<metrics.CollectionResult>

forceFlush

Parameters

Returns Promise<void>

getMetricsRequestHandler

Parameters

Returns void

ProtectedonForceFlush

Returns Promise<void>

ProtectedonInitialized

Returns void

onShutdown

Returns Promise<void>

selectAggregation

Parameters

Returns metrics.AggregationOption

selectAggregationTemporality

Parameters

Returns metrics.AggregationTemporality

selectCardinalityLimit

Parameters

Returns number

setMetricProducer

Parameters

Returns void

shutdown

Parameters

Returns Promise<void>

startServer

Returns Promise<void>

stopServer

Returns Promise<void>

Settings

On This Page

`Static` `Readonly`DEFAULT_OPTIONS

`Protected`onForceFlush

`Protected`onInitialized