Webhook Event Receiver
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 eventshealth_path
(default: '/health_check'): Path available for checking receiver statusread_timeout
(default: '500ms'): Maximum wait time while attempting to read a received eventwrite_timeout
(default: '500ms'): Maximum wait time while attempting to write a responserequired_header
(optional):
key
(required if required_header
config option is set): Represents the key portion of the required header.value
(required if required_header
config option is set): Represents the value portion of the required header.
Example:
receivers:
webhookevent:
endpoint: localhost:8088
read_timeout: "500ms"
path: "eventsource/receiver"
health_path: "eventreceiver/healthcheck"
required_header:
key: "required-header-key"
value: "required-header-value"
The full list of settings exposed for this receiver are documented here with a detailed sample configuration here