logzioexporter

README

Logzio Exporter

This exporter supports sending trace data to Logz.io

The following configuration options are supported:

• account_token (Required): Your logz.io account token for your tracing account.
• metrics_token (Optional): This is deprecated, but may be used for the OpenSearch/ElasticSearch based Metrics backend.
• region (Optional): Your logz.io account region code. Defaults to us. Required only if your logz.io region is different than US.
• custom_endpoint (Optional): Custom endpoint, mostly used for dev or testing. This will override the region parameter.
• drain_interval (Optional): Queue drain interval in seconds. Defaults to 3.
• queue_capacity (Optional): Queue capacity in bytes. Defaults to 20 * 1024 * 1024 ~ 20mb.
• queue_max_length (Optional): Max number of items allowed in the queue. Defaults to 500000.

Example:

exporters:
  logzio:
    account_token: "LOGZIOtraceTOKEN"
    metrics_token: "LOGZIOmetricsTOKEN"
    region: "eu"
    drain_interval: 3
    queue_capacity: 5000000
    queue_max_length: 500000

In order to use the Prometheus backend you must use the standard prometheusremotewrite exporter as well. The following regions are supported and configured as follows. The Logz.io Listener URL for for your region, configured to use port 8052 for http traffic, or port 8053 for https traffic.

Example:

exporters:
  prometheusremotewrite:
    endpoint: "https://listener.logz.io:8053"
    headers:
      Authorization: "Bearer LOGZIOprometheusTOKEN"

Putting these both together it would look like this in a full configuration:

receivers:
  jaeger:
    protocols:
      thrift_http:
        endpoint: "0.0.0.0:14278"

  prometheus:
    config:
      scrape_configs:
      - job_name: 'ratelimiter'
        scrape_interval: 15s
        static_configs:
          - targets: [ "0.0.0.0:8889" ]

exporters:
  logzio:
    account_token: "LOGZIOtraceTOKEN"
    region: "us"

  prometheusremotewrite:
    endpoint: "https://listener.logz.io:8053"
    headers:
      Authorization: "Bearer LOGZIOprometheusTOKEN"

service:
  pipelines:
    traces:
      receivers: [jaeger]
      exporters: [logzio]

    metrics:
      receivers: [prometheus]
      exporters: [prometheusremotewrite]
  
  telemetry:
    logs:
      level: debug #activate debug mode

Documentation

Index

• func NewFactory() component.ExporterFactory
• type Config

Functions

func NewFactory

func NewFactory() component.ExporterFactory

NewFactory creates a factory for Logz.io exporter.

Types

type Config

type Config struct {
	config.ExporterSettings `mapstructure:",squash"`
	TracesToken             string `mapstructure:"account_token"`    // Your Logz.io Account Token, can be found at https://app.logz.io/#/dashboard/settings/general
	MetricsToken            string `mapstructure:"metrics_token"`    // Your Logz.io Metrics Token, can be found at https://docs.logz.io/user-guide/accounts/finding-your-metrics-account-token/
	Region                  string `mapstructure:"region"`           // Your Logz.io 2-letter region code, can be found at https://docs.logz.io/user-guide/accounts/account-region.html#available-regions
	CustomEndpoint          string `mapstructure:"custom_endpoint"`  // Custom endpoint to ship traces to. Use only for dev and tests.
	DrainInterval           int    `mapstructure:"drain_interval"`   // Queue drain interval in seconds. Defaults to `3`.
	QueueCapacity           int64  `mapstructure:"queue_capacity"`   // Queue capacity in bytes. Defaults to `20 * 1024 * 1024` ~ 20mb.
	QueueMaxLength          int    `mapstructure:"queue_max_length"` // Max number of items allowed in the queue. Defaults to `500000`.
}

Config contains Logz.io specific configuration such as Account TracesToken, Region, etc.