skywalkingexporter

README

SkyWalking gRPC Exporter

Status
Stability	beta: metrics, logs
Distributions	contrib
Issues
Code Owners	@liqiangz

Exports data via gRPC using skywalking-data-collect-protocol format. By default, this exporter requires TLS and offers queued retry capabilities.

Getting Started

The following settings are required:

• endpoint (no default): host:port to which the exporter is going to send SkyWalking log data, using the gRPC protocol. The valid syntax is described here. If a scheme of https is used then client transport security is enabled and overrides the insecure setting.

• num_streams (default = 2): the number of grpc streams that send the gRPC requests.

By default, TLS is enabled and must be configured under tls::

• insecure (default = false): whether to enable client transport security for the exporter's connection.

As a result, the following parameters are also required under tls::

• cert_file (no default): path to the TLS cert to use for TLS required connections. Should only be used if insecure is set to false.
• key_file (no default): path to the TLS key to use for TLS required connections. Should only be used if insecure is set to false.

Example:

exporters:
  skywalking:
    endpoint: "192.168.1.5:11800"
    tls:
      insecure: true  
    num_streams: 5  
  skywalking/2:
    endpoint: "10.18.7.4:11800"
    compression: "gzip"
    tls:
      cert_file: file.cert
      key_file: file.key
    timeout: 10s

Advanced Configuration

Several helper files are leveraged to provide additional capabilities automatically:

• gRPC settings
• TLS and mTLS settings
• Queuing, retry and timeout settings

Documentation

Overview

Package skywalkingexporter exports data by using SkyWalking data collect protocol to a gPRC endpoint.

Index

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

Functions

func NewFactory

func NewFactory() exporter.Factory

NewFactory creates a factory for Skywalking exporter.

Types

type Config

type Config struct {
	configgrpc.GRPCClientSettings  `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct.
	exporterhelper.QueueSettings   `mapstructure:"sending_queue"`
	exporterhelper.RetrySettings   `mapstructure:"retry_on_failure"`
	exporterhelper.TimeoutSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct.

	// The number of grpc streams that send the gRPC requests.
	NumStreams int `mapstructure:"num_streams"`
}

Config defines configuration for SkyWalking exporter.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks if the exporter configuration is valid