skywalkingreceiver

README

Skywalking Receiver

Status
Stability	development: metrics
	beta: traces
Distributions	contrib
Issues
Code Owners	@JaredTan95

Receives trace data and metric data in Skywalking format.

Note: The current metrics receiver only supports receiving JVM data.

Getting Started

By default, the Skywalking receiver will not serve any protocol. A protocol must be named under the protocols object for the Skywalking receiver to start. The below protocols are supported, each supports an optional endpoint object configuration parameter.

• grpc (default endpoint = 0.0.0.0:11800)
• http (default endpoint = 0.0.0.0:12800)

The component.UseLocalHostAsDefaultHost feature gate changes endpoints to localhost:11800 and localhost:12800 respectively. This will become the default in a future release.

Examples:

receivers:
  skywalking:
    protocols:
      grpc:
        endpoint: 0.0.0.0:11800
      http:
        endpoint: 0.0.0.0:12800

service:
  pipelines:
    traces:
      receivers: [skywalking]
    metrics:
      receivers: [skywalking]
      

Documentation

Index

• func NewFactory() receiver.Factory
• type Config
  • func (cfg *Config) Unmarshal(componentParser *confmap.Conf) error
  • func (cfg *Config) Validate() error
• type Protocols

Functions

func NewFactory

func NewFactory() receiver.Factory

NewFactory creates a new Skywalking receiver factory.

Types

type Config

type Config struct {
	Protocols `mapstructure:"protocols"`
}

Config defines configuration for skywalking receiver.

func (*Config) Unmarshal

func (cfg *Config) Unmarshal(componentParser *confmap.Conf) error

Unmarshal a config.Parser into the config struct.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks the receiver configuration is valid

type Protocols

type Protocols struct {
	GRPC *configgrpc.ServerConfig `mapstructure:"grpc"`
	HTTP *confighttp.ServerConfig `mapstructure:"http"`
}

Protocols is the configuration for the supported protocols.