-
Notifications
You must be signed in to change notification settings - Fork 238
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* initial commit for influxdb2otel receiver * changelog * Update docs/sources/reference/components/otelcol/otelcol.receiver.influxdb.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/reference/components/otelcol/otelcol.receiver.influxdb.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/reference/components/otelcol/otelcol.receiver.influxdb.md Co-authored-by: Clayton Cornell <[email protected]> * convert logic * Update CHANGELOG.md Co-authored-by: William Dumont <[email protected]> * Update docs/sources/reference/components/otelcol/otelcol.receiver.influxdb.md Co-authored-by: William Dumont <[email protected]> * Update docs/sources/reference/components/otelcol/otelcol.receiver.influxdb.md Co-authored-by: William Dumont <[email protected]> * Update internal/component/all/all.go Co-authored-by: William Dumont <[email protected]> * fixes from review * unrelated build failures - kick * caught issue along with compression change * caught issue along with compression change * Update docs/sources/reference/components/otelcol/otelcol.receiver.influxdb.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/reference/components/otelcol/otelcol.receiver.influxdb.md Co-authored-by: Clayton Cornell <[email protected]> * compression test fix and suggestions * compression added in docs * changelog fix * changelog fix * changelog fix * changelog fix * format doc * docs --------- Co-authored-by: Clayton Cornell <[email protected]> Co-authored-by: William Dumont <[email protected]>
- Loading branch information
3 people
authored
Dec 2, 2024
1 parent
385ac8f
commit 145aabb
Showing
11 changed files
with
629 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
167 changes: 167 additions & 0 deletions
167
docs/sources/reference/components/otelcol/otelcol.receiver.influxdb.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| --- | ||
| canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol/otelcol.receiver.influxdb/ | ||
| description: Learn about otelcol.receiver.influxdb | ||
| title: otelcol.receiver.influxdb | ||
| --- | ||
|
|
||
| # otelcol.receiver.influxdb | ||
|
|
||
| `otelcol.receiver.influxdb` receives InfluxDB metrics, converts them into OpenTelemetry (OTEL) format, and forwards them to other `otelcol.*` components over the network. | ||
|
|
||
| You can specify multiple `otelcol.receiver.influxdb` components by giving them different labels. | ||
|
|
||
| ## Usage | ||
|
|
||
| ```alloy | ||
| otelcol.receiver.influxdb "influxdb_metrics" { | ||
| endpoint = "localhost:8086" // InfluxDB metrics ingestion endpoint | ||
| output { | ||
| metrics = [...] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Arguments | ||
|
|
||
| `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 | | ||
|
|
||
| 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. | ||
|
|
||
| ## Blocks | ||
|
|
||
| The following blocks are supported inside the definition of `otelcol.receiver.influxdb`: | ||
|
|
||
| | Hierarchy | Block | Description | Required | | ||
| | ------------- | ----------------- | ----------------------------------------------------- | -------- | | ||
| | tls | [tls][] | Configures TLS for the HTTP server. | no | | ||
| | cors | [cors][] | Configures CORS for the HTTP server. | no | | ||
| | debug_metrics | [debug_metrics][] | Configures the metrics that this component generates. | no | | ||
| | output | [output][] | Configures where to send received metrics. | yes | | ||
|
|
||
| [tls]: #tls-block | ||
| [cors]: #cors-block | ||
| [debug_metrics]: #debug_metrics-block | ||
| [output]: #output-block | ||
|
|
||
| ### tls block | ||
|
|
||
| The `tls` block configures TLS settings used for a server. If the `tls` block | ||
| isn't provided, TLS won't be used for connections to the server. | ||
|
|
||
| {{< docs/shared lookup="reference/components/otelcol-tls-server-block.md" source="alloy" version="<ALLOY_VERSION>" >}} | ||
|
|
||
| ### cors block | ||
|
|
||
| The `cors` block configures CORS settings for an HTTP server. | ||
|
|
||
| The following arguments are supported: | ||
|
|
||
| | Name | Type | Description | Default | Required | | ||
| | ----------------- | -------------- | ---------------------------------------- | ---------------------- | -------- | | ||
| | `allowed_origins` | `list(string)` | Allowed values for the `Origin` header. | | no | | ||
| | `allowed_headers` | `list(string)` | Accepted headers from CORS requests. | `["X-Requested-With"]` | no | | ||
| | `max_age` | `number` | Configures the `Access-Control-Max-Age`. | | no | | ||
|
|
||
| The `allowed_headers` argument specifies which headers are acceptable from a | ||
| CORS request. The following headers are always implicitly allowed: | ||
|
|
||
| * `Accept` | ||
| * `Accept-Language` | ||
| * `Content-Type` | ||
| * `Content-Language` | ||
|
|
||
| If `allowed_headers` includes `"*"`, all headers are permitted. | ||
|
|
||
| ### debug_metrics block | ||
|
|
||
| {{< docs/shared lookup="reference/components/otelcol-debug-metrics-block.md" source="alloy" version="<ALLOY_VERSION>" >}} | ||
|
|
||
| ### output block | ||
|
|
||
| {{< docs/shared lookup="reference/components/output-block.md" source="alloy" version="<ALLOY_VERSION>" >}} | ||
|
|
||
| ## Exported fields | ||
|
|
||
| `otelcol.receiver.influxdb` doesn't export any fields. | ||
|
|
||
| ## Component health | ||
|
|
||
| `otelcol.receiver.influxdb` is only reported as unhealthy if given an invalid configuration. | ||
|
|
||
| ## Debug information | ||
|
|
||
| `otelcol.receiver.influxdb` doesn't expose any component-specific debug information. | ||
|
|
||
| ## Example | ||
|
|
||
| This example forwards received telemetry through a batch processor before finally sending it to an OTLP-capable endpoint: | ||
|
|
||
| ```alloy | ||
| otelcol.receiver.influxdb "influxdb_metrics" { | ||
| output { | ||
| metrics = [otelcol.processor.batch.default.input] | ||
| } | ||
| } | ||
| otelcol.processor.batch "default" { | ||
| output { | ||
| metrics = [otelcol.exporter.otlp.default.input] | ||
| } | ||
| } | ||
| otelcol.exporter.otlp "default" { | ||
| client { | ||
| endpoint = sys.env("OTLP_ENDPOINT") | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| This example forwards received telemetry to Prometheus Remote Write (Mimir): | ||
|
|
||
| ```alloy | ||
| otelcol.receiver.influxdb "influxdb_metrics" { | ||
| output { | ||
| metrics = [otelcol.exporter.prometheus.influx_output.input] // Forward metrics to Prometheus exporter | ||
| } | ||
| } | ||
| otelcol.exporter.prometheus "influx_output" { | ||
| forward_to = [prometheus.remote_write.mimir.receiver] // Forward metrics to Prometheus remote write (Mimir) | ||
| } | ||
| prometheus.remote_write "mimir" { | ||
| endpoint { | ||
| url = "https://prometheus-xxx.grafana.net/api/prom/push" | ||
| basic_auth { | ||
| username = "xxxxx" | ||
| password = "xxxx==" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| <!-- START GENERATED COMPATIBLE COMPONENTS --> | ||
|
|
||
| ## Compatible components | ||
|
|
||
| `otelcol.receiver.influxdb` can accept arguments from the following components: | ||
|
|
||
| - Components that export [OpenTelemetry `otelcol.Consumer`](../../../compatibility/#opentelemetry-otelcolconsumer-exporters) | ||
|
|
||
|
|
||
| {{< admonition type="note" >}} | ||
| Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. | ||
| Refer to the linked documentation for more details. | ||
| {{< /admonition >}} | ||
|
|
||
| <!-- END GENERATED COMPATIBLE COMPONENTS --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.