skywalkingreceiver

README

Skywalking Receiver

Status
Stability	beta
Supported pipeline types	traces
Distributions	contrib

Receives trace data in Skywalking format.

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)

Examples:

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

service:
  pipelines:
    traces:
      receivers: [skywalking]

Documentation

Index

• Constants
• func NewFactory() component.ReceiverFactory
• func ResponseWithJSON(rsp http.ResponseWriter, response *Response, code int)
• func SkywalkingToTraces(segment *agentV3.SegmentObject) ptrace.Traces
• type Config
  • func (cfg *Config) Unmarshal(componentParser *confmap.Conf) error
  • func (cfg *Config) Validate() error
• type Protocols
• type Response

Constants

const (
	AttributeRefType                   = "refType"
	AttributeParentService             = "parent.service"
	AttributeParentInstance            = "parent.service.instance"
	AttributeParentEndpoint            = "parent.endpoint"
	AttributeSkywalkingSpanID          = "sw8.span_id"
	AttributeSkywalkingTraceID         = "sw8.trace_id"
	AttributeSkywalkingSegmentID       = "sw8.segment_id"
	AttributeSkywalkingParentSpanID    = "sw8.parent_span_id"
	AttributeSkywalkingParentSegmentID = "sw8.parent_segment_id"
	AttributeNetworkAddressUsedAtPeer  = "network.AddressUsedAtPeer"
)

Functions

func NewFactory

func NewFactory() component.ReceiverFactory

NewFactory creates a new Skywalking receiver factory.

func ResponseWithJSON

func ResponseWithJSON(rsp http.ResponseWriter, response *Response, code int)

func SkywalkingToTraces

func SkywalkingToTraces(segment *agentV3.SegmentObject) ptrace.Traces

Types

type Config

type Config struct {
	config.ReceiverSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded 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.GRPCServerSettings `mapstructure:"grpc"`
	HTTP *confighttp.HTTPServerSettings `mapstructure:"http"`
}

Protocols is the configuration for the supported protocols.

type Response

type Response struct {
	Status string `json:"status"`
	Msg    string `json:"msg"`
}