webhookeventreceiver

README

Webhook Event Receiver

Status
Stability	alpha: logs
Distributions	[]

The Webhook Event Receiver is a push based event collector component meant to act as a generally available receiver for any webhook style data source. It is designed to work alongside other pipeline components like the transform processor to allow the ingestion of generic events as logs into the opentelemetry collector.

Configuration

The following settings are required:

• endpoint (no default): The endpoint where you may point your webhook to emit events to

The following settings are optional:

• path (default: '/events'): Path where the receiver instance will accept events
• health_path (default: '/health_check'): Path available for checking receiver status
• read_timeout (default: '500ms'): Maximum wait time while attempting to read a received event
• write_timeout (default: '500ms'): Maximum wait time while attempting to write a response

Example:

receivers:
    webhookevent:
        endpoint: localhost:8088
        read_timeout: "500ms"
        path: "eventsource/receiver"
        health_path: "eventreceiver/healthcheck"

The full list of settings exposed for this receiver are documented here with a detailed sample configuration here

Documentation

Index

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

Functions

func NewFactory

func NewFactory() receiver.Factory

NewFactory creates a factory for Generic Webhook Receiver.

Types

type Config

type Config struct {
	confighttp.HTTPServerSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
	ReadTimeout                   string                   `mapstructure:"read_timeout"`  // wait time for reading request headers in ms. Default is twenty seconds.
	WriteTimeout                  string                   `mapstructure:"write_timeout"` // wait time for writing request response in ms. Default is twenty seconds.
	Path                          string                   `mapstructure:"path"`          // path for data collection. Default is <host>:<port>/services/collector
	HealthPath                    string                   `mapstructure:"health_path"`   // path for health check api. Default is /services/collector/health
}

Config defines configuration for the Generic Webhook receiver.

func (*Config) Validate

func (cfg *Config) Validate() error