diff --git a/CHANGELOG.md b/CHANGELOG.md index 0c4e013ef6..6cdf796830 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,8 @@ Main (unreleased) - Add `validate` command to alloy that will perform limited validation of alloy configuration files. (@kalleep) +- Add `otelcol.receiver.splunkhec` component to receive events in splunk hec format and forward them to other `otelcol.*` components. (@kalleep) + ### Enhancements - Add binary version to constants exposed in configuration file syntatx. (@adlots) diff --git a/docs/sources/reference/compatibility/_index.md b/docs/sources/reference/compatibility/_index.md index 3a0ac187d2..1e18179022 100644 --- a/docs/sources/reference/compatibility/_index.md +++ b/docs/sources/reference/compatibility/_index.md @@ -379,6 +379,7 @@ The following components, grouped by namespace, _consume_ OpenTelemetry `otelcol - [otelcol.receiver.otlp](../components/otelcol/otelcol.receiver.otlp) - [otelcol.receiver.prometheus](../components/otelcol/otelcol.receiver.prometheus) - [otelcol.receiver.solace](../components/otelcol/otelcol.receiver.solace) +- [otelcol.receiver.splunkhec](../components/otelcol/otelcol.receiver.splunkhec) - [otelcol.receiver.syslog](../components/otelcol/otelcol.receiver.syslog) - [otelcol.receiver.tcplog](../components/otelcol/otelcol.receiver.tcplog) - [otelcol.receiver.vcenter](../components/otelcol/otelcol.receiver.vcenter) diff --git a/docs/sources/reference/components/otelcol/otelcol.receiver.influxdb.md b/docs/sources/reference/components/otelcol/otelcol.receiver.influxdb.md index c0e3883273..145a374db1 100644 --- a/docs/sources/reference/components/otelcol/otelcol.receiver.influxdb.md +++ b/docs/sources/reference/components/otelcol/otelcol.receiver.influxdb.md @@ -26,13 +26,13 @@ otelcol.receiver.influxdb "influxdb_metrics" { `otelcol.receiver.influxdb` supports the following arguments: -| Name | Type | Description | Default | Required | -| ------------------------ | -------------- | --------------------------------------------------------------- | ---------------------------------------------------------- | -------- | -| `endpoint` | `string` | `host:port` to listen for traffic on. | `"localhost:8086"` | no | -| `max_request_body_size` | `string` | Maximum request body size the server will allow. | `20MiB` | no | -| `include_metadata` | `boolean` | Propagate incoming connection metadata to downstream consumers. | | no | -| `compression_algorithms` | `list(string)` | A list of compression algorithms the server can accept. | `["", "gzip", "zstd", "zlib", "snappy", "deflate", "lz4"]` | no | -`auth` | `capsule(otelcol.Handler)` | Handler from an `otelcol.auth` component to use for authenticating requests. | | no +| Name | Type | Description | Default | Required | +| ------------------------ | -------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------- | -------- | +| `auth` | `capsule(otelcol.Handler)` | Handler from an `otelcol.auth` component to use for authenticating requests. | | no | +| `compression_algorithms` | `list(string)` | A list of compression algorithms the server can accept. | `["", "gzip", "zstd", "zlib", "snappy", "deflate", "lz4"]` | no | +| `endpoint` | `string` | `host:port` to listen for traffic on. | `"localhost:8086"` | no | +| `include_metadata` | `boolean` | Propagate incoming connection metadata to downstream consumers. | | no | +| `max_request_body_size` | `string` | Maximum request body size the server will allow. | `20MiB` | no | By default, `otelcol.receiver.influxdb` listens for HTTP connections on `localhost`. To expose the HTTP server to other machines on your network, configure `endpoint` with the IP address to listen on, or `0.0.0.0:8086` to listen on all network interfaces. diff --git a/docs/sources/reference/components/otelcol/otelcol.receiver.splunkhec.md b/docs/sources/reference/components/otelcol/otelcol.receiver.splunkhec.md new file mode 100644 index 0000000000..3198a23ef4 --- /dev/null +++ b/docs/sources/reference/components/otelcol/otelcol.receiver.splunkhec.md @@ -0,0 +1,213 @@ +--- +canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol/otelcol.receiver.splunkhec/ +description: Learn about otelcol.receiver.splunkhec +labels: + stage: public-preview + products: + - oss +title: otelcol.receiver.splunkhec +--- + +# `otelcol.receiver.splunkhec` + +{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="" >}} + +`otelcol.receiver.splunkhec` accepts events in the [Splunk HEC format](https://docs.splunk.com/Documentation/Splunk/8.0.5/Data/FormateventsforHTTPEventCollector) and forwards them to other `otelcol.*` components. +The receiver accepts data formatted as JSON HEC events under any path or as EOL separated log raw data if sent to the `raw_path` path. + +{{< admonition type="note" >}} +`otelcol.receiver.splunkhec` is a wrapper over the upstream OpenTelemetry Collector `splunkhec` receiver. +Bug reports or feature requests will be redirected to the upstream repository, if necessary. +{{< /admonition >}} + +You can specify multiple `otelcol.receiver.splunkhec` components by giving them different labels. + +## Usage + +```alloy +otelcol.receiver.splunkhec "