OpenTelemetry.Exporter.InfluxDB 1.0.0-alpha.5

InfluxDB Exporter for OpenTelemetry .NET

The InfluxDB exporter converts OpenTelemetry metrics into the InfluxDB model following the OpenTelemetry->InfluxDB conversion schema.

This exporter can be used with InfluxDB 2.x and InfluxDB 1.8+ (see details).

Prerequisite

• Get InfluxDB

Step 1: Install Package

dotnet add package --prerelease OpenTelemetry.Exporter.InfluxDB

Step 2: Configure OpenTelemetry MeterProvider

• When using the OpenTelemetry.Extensions.Hosting package on .NET 6.0+:

  services.AddOpenTelemetry()
    .WithMetrics(builder => builder
        .AddInfluxDBMetricsExporter(options =>
        {
            options.Org = "org";
            options.Bucket = "bucket";
            options.Token = "token";
            options.Endpoint = new Uri("http://localhost:8086");
            options.MetricsSchema = MetricsSchema.TelegrafPrometheusV2;
        }));

• Or configure directly:

  Call the MeterProviderBuilder.AddInfluxDBMetricsExporter extension to register the Prometheus exporter.

    var meterProvider = Sdk.CreateMeterProviderBuilder()
    .AddInfluxDBMetricsExporter(options =>
    {
        options.Org = "org";
        options.Bucket = "bucket";
        options.Token = "token";
        options.Endpoint = new Uri("http://localhost:8086");
        options.MetricsSchema = MetricsSchema.TelegrafPrometheusV2;
    })
    .Build();
    builder.Services.AddSingleton(meterProvider);

Configuration

You can configure the InfluxDBMetricsExporter through InfluxDBMetricsExporterOptions.

Endpoint

HTTP/S destination for the line protocol.

Org

The name of the InfluxDB organization that owns the destination bucket.

Bucket

The name of the InfluxDB bucket to which signals will be written.

Token

The authentication token for InfluxDB.

MetricsSchema

The chosen metrics schema to write. Default value is MetricsSchema.TelegrafPrometheusV1.

FlushInterval

The time to wait at most (in milliseconds) with the write. Default value is 1000.

InfluxDB 1.8 API Compatibility

InfluxDB 1.8.0 introduced forward compatibility APIs for InfluxDB 2.0, allowing you to easily transition from InfluxDB 1.x to InfluxDB 2.0 Cloud or open source.

Here's a summary of the client API usage differences:

• Token

Use the format username:password for an authentication token, e.g., my-user:my-password. If the server doesn't require authentication, use an empty string ("").

• Org

The organization parameter is not used in InfluxDB 1.8. Use a hyphen ("-") where necessary.

• Bucket

Use the format database/retention-policy where a bucket is required. If the default retention policy should be used, skip the retention policy. Examples: telegraf/autogen, telegraf.

When using InfluxDB 1.8, modify the AddInfluxDBMetricsExporter options accordingly:

    services.AddOpenTelemetry()
    .WithMetrics(builder => builder
        .AddInfluxDBMetricsExporter(options =>
        {
            options.Org = "-";
            options.Bucket = "telegraf/autogen";
            options.Token = "my-user:my-password";
            options.Endpoint = new Uri("http://localhost:8086");
            options.MetricsSchema = MetricsSchema.TelegrafPrometheusV2;
        }));

Troubleshooting

This component uses an EventSource with the name "OpenTelemetry-Exporter-InfluxDB" for its internal logging. Please refer to SDK troubleshooting for instructions on seeing these internal logs.