logzioexporter

README

Logz.io Exporter

Status
Stability	beta: traces, logs
Distributions	contrib
Issues
Code coverage
Code Owners	@yotamloe

This exporter supports sending trace and log data to Logz.io

The following configuration options are supported:

Logz.io exporter is utilizing opentelemetry exporter helper for retry_on_failure,sending_queue and timeout settings

• account_token (Required): Your logz.io account token for your tracing or logs account.
• region Your logz.io account region code. Defaults to us. Required only if your logz.io region is different than US.
• endpoint Custom endpoint, mostly used for dev or testing. This will override the region parameter.
• retry_on_failure
  • enabled (default = true)
  • initial_interval: Time to wait after the first failure before retrying; ignored if enabled is false (default = 5s)
  • max_interval: Is the upper bound on backoff; ignored if enabled is false (default = 30s)
  • max_elapsed_time: Is the maximum amount of time spent trying to send a batch; ignored if enabled is false (default = 300s)
• sending_queue
  • enabled (default = true)
  • num_consumers: Number of consumers that dequeue batches; ignored if enabled is false (default = 10)
  • queue_size: Maximum number of batches kept in memory before dropping; ignored if enabled is false User should calculate this as num_seconds * requests_per_second where:
    • num_seconds is the number of seconds to buffer in case of a backend outage
    • requests_per_second is the average number of requests per seconds.
    • default = 1000
• timeout: Time to wait per individual attempt to send data to a backend. default = 30s

Tracing example:

• We recommend using sending_queue::batch option. Batching helps better compress the data and reduce the number of outgoing connections required to transmit the data.

receivers:
  otlp:
    protocols:
      grpc:
        endpoint: "0.0.0.0:4317"
      http:
        endpoint: "0.0.0.0:4318"
  jaeger:
    protocols:
      thrift_compact:
        endpoint: "0.0.0.0:6831"
      thrift_binary:
        endpoint: "0.0.0.0:6832"
      grpc:
        endpoint: "0.0.0.0:14250"
      thrift_http:
        endpoint: "0.0.0.0:14268"
exporters:
  logzio/traces:
    account_token: "LOGZIOtraceTOKEN"
    region: "us"
service:
  pipelines:
    traces:
      receivers: [ otlp,jaeger ]
      exporters: [ logzio/traces ]
  telemetry:
    logs:
      level: "debug"

Logs example:

• We recommend using sending_queue::batch option. Batching helps better compress the data and reduce the number of outgoing connections required to transmit the data.
• We recommend adding type attribute to classify your log records
• We recommend adding resourcedetection processor to add metadata to your log records

receivers:
  file_log:
    include: [ "/private/var/log/*.log" ] # MacOs system logs
    include_file_name: false
    include_file_path: true 
    operators:
      - type: move
        from: attributes["log.file.path"]
        to: attributes["log_file_path"]
    attributes:
      type: <<your-logzio-type>>
processors:
  resourcedetection/system:
    detectors: [ "system" ]
    system:
      hostname_sources: [ "os" ]
exporters:
  logzio/logs:
    account_token: "LOGZIOlogsTOKEN"
    region: "us"
service:
  pipelines:
    logs:
      receivers: [file_log]
      processors: [ resourcedetection/system ]
      exporters: [logzio/logs]
  telemetry:
    logs:
      level: "debug"

Metrics:

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 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/traces:
    account_token: "LOGZIOtraceTOKEN"
    region: "us"

  prometheusremotewrite:
    endpoint: "https://listener.logz.io:8053"
    headers:
      Authorization: "Bearer LOGZIOprometheusTOKEN"
    
service:
  pipelines:
    traces:
      receivers: [jaeger]
      exporters: [logzio/traces]

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

Scope Name

When using the logs exporter with logs originating from instrumentation library (i.e opentelemetry log4j2 appender), the scopeName field will be added (if the field is populated in the original log).

Documentation

Index

• func NewFactory() exporter.Factory
• type Config
  • func (c *Config) Validate() error

Functions

func NewFactory

func NewFactory() exporter.Factory

NewFactory creates a factory for Logz.io exporter.

Types

type Config

type Config struct {
	confighttp.ClientConfig   `mapstructure:",squash"`                                 // confighttp client settings https://pkg.go.dev/go.opentelemetry.io/collector/config/confighttp#ClientConfig
	QueueSettings             configoptional.Optional[exporterhelper.QueueBatchConfig] `mapstructure:"sending_queue"` // exporter helper queue settings https://pkg.go.dev/go.opentelemetry.io/collector/exporter/exporterhelper#QueueSettings
	configretry.BackOffConfig `mapstructure:"retry_on_failure"`                        // exporter helper retry settings https://pkg.go.dev/go.opentelemetry.io/collector/exporter/exporterhelper#RetrySettings
	Token                     configopaque.String                                      `mapstructure:"account_token"`    // Your Logz.io Account Token, can be found at https://app.logz.io/#/dashboard/settings/general
	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"`  // **Deprecation** Custom endpoint to ship traces to. Use only for dev and tests.
	DrainInterval             int                                                      `mapstructure:"drain_interval"`   // **Deprecation** Queue drain interval in seconds. Defaults to `3`.
	QueueCapacity             int64                                                    `mapstructure:"queue_capacity"`   // **Deprecation** Queue capacity in bytes. Defaults to `20 * 1024 * 1024` ~ 20mb.
	QueueMaxLength            int                                                      `mapstructure:"queue_max_length"` // **Deprecation** Max number of items allowed in the queue. Defaults to `500000`.
}

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

func (*Config) Validate

func (c *Config) Validate() error