Interface OTLPMetricExporterOptions

interface OTLPMetricExporterOptions {
    aggregationPreference?: metrics.AggregationSelector;
    concurrencyLimit?: number;
    headers?: Record<string, string> | HeadersFactory;
    temporalityPreference?:
        | AggregationTemporalityPreference
        | metrics.AggregationTemporality;
    timeoutMillis?: number;
    url?: string;
}

Hierarchy

  • OTLPExporterConfigBase
    • OTLPMetricExporterOptions

Properties

aggregationPreference? concurrencyLimit? headers? temporalityPreference? timeoutMillis? url?

Properties

OptionalaggregationPreference

aggregationPreference?: metrics.AggregationSelector

OptionalconcurrencyLimit

concurrencyLimit?: number

Optionalheaders

headers?: Record<string, string> | HeadersFactory

Custom headers that will be attached to the HTTP request that's sent to the endpoint.

Remarks

Prefer using a plain object over a factory function wherever possible. If using a factory function (HttpAgentFactory), do not import http or https at the top of the file Instead, use dynamic import() or require() to load the module. This ensures that the http or https module is not loaded before @opentelemetry/instrumentation-http can instrument it.

Functions passed to the exporter MUST NOT throw errors.

Example: Using headers options directly: 

headers: {
 Authorization: "Api-Token my-secret-token",
}

Example: Using a custom factory function 

headers: async () => {
  // ... do whatever you need to obtain the headers, ensuring you `await import('your-library')` to avoid breaking instrumentations ...
  return {
    Authorization: `Bearer ${token}`,
  };
};

OptionaltemporalityPreference

temporalityPreference?:
    | AggregationTemporalityPreference
    | metrics.AggregationTemporality

OptionaltimeoutMillis

timeoutMillis?: number

Maximum time the OTLP exporter will wait for each batch export. The default value is 10000ms.

Optionalurl

url?: string

Settings

Member Visibility

On This Page

Properties