From 180128ecbeada3e3569680d39d778aad854558ce Mon Sep 17 00:00:00 2001 From: Fabian Lange Date: Tue, 17 Dec 2024 10:55:33 +0100 Subject: [PATCH 1/2] pipeline: outputs: dash0: Added Dash0 documentation Signed-off-by: Fabian Lange --- SUMMARY.md | 1 + administration/transport-security.md | 1 + pipeline/outputs/dash0.md | 64 +++++++++++++++++++ vale-styles/FluentBit/Spelling-exceptions.txt | 1 + 4 files changed, 67 insertions(+) create mode 100644 pipeline/outputs/dash0.md diff --git a/SUMMARY.md b/SUMMARY.md index 0994d3b04..78ef6620c 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -178,6 +178,7 @@ * [Azure Log Analytics](pipeline/outputs/azure.md) * [Azure Logs Ingestion API](pipeline/outputs/azure_logs_ingestion.md) * [Counter](pipeline/outputs/counter.md) + * [Dash0](pipeline/outputs/dash0.md) * [Datadog](pipeline/outputs/datadog.md) * [Dynatrace](pipeline/outputs/dynatrace.md) * [Elasticsearch](pipeline/outputs/elasticsearch.md) diff --git a/administration/transport-security.md b/administration/transport-security.md index 4443cfd70..384ecdfdf 100644 --- a/administration/transport-security.md +++ b/administration/transport-security.md @@ -31,6 +31,7 @@ The following **output** plugins can take advantage of the TLS feature: * [Azure Data Explorer (Kusto)](../pipeline/outputs/azure_kusto.md) * [Azure Logs Ingestion API](../pipeline/outputs/azure_logs_ingestion.md) * [BigQuery](../pipeline/outputs/bigquery.md) +* [Dash0](../pipeline/outputs/dash0.md) * [Datadog](../pipeline/outputs/datadog.md) * [Elasticsearch](../pipeline/outputs/elasticsearch.md) * [Forward](../pipeline/outputs/forward.md) diff --git a/pipeline/outputs/dash0.md b/pipeline/outputs/dash0.md new file mode 100644 index 000000000..66873a8a2 --- /dev/null +++ b/pipeline/outputs/dash0.md @@ -0,0 +1,64 @@ +--- +description: Send logs to Dash0 +--- + +# Dash0 + +Stream logs to [Dash0](https://www.dash0.com) by utilizing the [OpenTelemetry plugin](opentelemetry.md) to send data to the Dash0 log ingress. + +## Configuration parameters + +| Key | Description | Default | +| -------------------------- | ----------- | ------- | +| `header` | The specific header for bearer authorization, where {your-Auth-token-here} is your Dash0 Auth Token. | Authorization Bearer {your-Auth-token-here} | +| `host` | Your Dash0 ingress endpoint. | `ingress.eu-west-1.aws.dash0.com` | +| `port` | TCP port of your Dash0 ingress endpoint. | `443` | +| `metrics_uri` | Specify an optional HTTP URI for the target web server listening for metrics | `/v1/metrics` | +| `logs_uri` | Specify an optional HTTP URI for the target web server listening for logs | `/v1/logs` | +| `traces_uri` | Specify an optional HTTP URI for the target web server listening for traces | `/v1/traces` | + +### TLS / SSL + +The OpenTelemetry output plugin supports TLS/SSL. +For more details about the properties available and general configuration, see [TLS/SSL](../../administration/transport-security.md). + +## Getting started + +To get started with sending logs to Dash0: + +1. Get an [Auth Token](https://www.dash0.com/documentation/dash0/key-concepts/auth-tokens) from **Settings** > **Auth Tokens**. +1. In your main Fluent Bit configuration file, append the following `Output` section: + + {% tabs %} + {% tab title="fluent-bit.conf" %} + ```text + [OUTPUT] + Name opentelemetry + Match * + Host ingress.eu-west-1.aws.dash0.com + Port 443 + Header Authorization Bearer auth_vdOxPqcvSlBkhVQV95wU9TGXh2Fdjliq + Metrics_uri /v1/metrics + Logs_uri /v1/logs + Traces_uri /v1/traces + ``` + {% endtab %} + + {% tab title="fluent-bit.yaml" %} + ```yaml + [OUTPUT] + Name: opentelemetry + Match: * + Host: ingress.eu-west-1.aws.dash0.com + Port: 443 + Header: Authorization Bearer auth_vdOxPqcvSlBkhVQV95wU9TGXh2Fdjliq + Metrics_uri: /v1/metrics + Logs_uri: /v1/logs + Traces_uri: /v1/traces + ``` + {% endtab %} + {% endtabs %} + +## References + +- [Dash0 documentation](https://www.dash0.com/documentation/dash0) \ No newline at end of file diff --git a/vale-styles/FluentBit/Spelling-exceptions.txt b/vale-styles/FluentBit/Spelling-exceptions.txt index 2cbee98eb..7bcd9f212 100644 --- a/vale-styles/FluentBit/Spelling-exceptions.txt +++ b/vale-styles/FluentBit/Spelling-exceptions.txt @@ -25,6 +25,7 @@ coroutines Crowdstrike CRDs DaemonSet +Dash0 Datadog Datagen datapoint From 9a5befacf6e4deb97ed7e3c8b3a636f893d549f1 Mon Sep 17 00:00:00 2001 From: Fabian Lange Date: Tue, 17 Dec 2024 22:10:49 +0100 Subject: [PATCH 2/2] Unify the references to TLS, as proposed by esmerel Signed-off-by: Fabian Lange --- pipeline/outputs/elasticsearch.md | 4 ++-- pipeline/outputs/gelf.md | 3 ++- pipeline/outputs/http.md | 3 ++- pipeline/outputs/influxdb.md | 3 ++- pipeline/outputs/kafka-rest-proxy.md | 3 ++- pipeline/outputs/oci-logging-analytics.md | 3 ++- pipeline/outputs/opensearch.md | 3 ++- pipeline/outputs/skywalking.md | 3 ++- pipeline/outputs/splunk.md | 3 ++- pipeline/outputs/syslog.md | 2 +- 10 files changed, 19 insertions(+), 11 deletions(-) diff --git a/pipeline/outputs/elasticsearch.md b/pipeline/outputs/elasticsearch.md index 1bcb59529..8f09f678d 100644 --- a/pipeline/outputs/elasticsearch.md +++ b/pipeline/outputs/elasticsearch.md @@ -56,8 +56,8 @@ be compared to the `database` and `table` concepts. ### TLS / SSL -Elasticsearch output plugin supports TLS/SSL. For more details about the properties -available and general configuration, refer to[TLS/SSL](../../administration/transport-security.md). +The Elasticsearch output plugin supports TLS/SSL. +For more details about the properties available and general configuration, see [TLS/SSL](../../administration/transport-security.md). ### `write_operation` diff --git a/pipeline/outputs/gelf.md b/pipeline/outputs/gelf.md index 0aad41bff..db401075b 100644 --- a/pipeline/outputs/gelf.md +++ b/pipeline/outputs/gelf.md @@ -26,7 +26,8 @@ According to [GELF Payload Specification](https://go2docs.graylog.org/5-0/gettin ### TLS / SSL -GELF output plugin supports TLS/SSL, for more details about the properties available and general configuration, please refer to the [TLS/SSL](../../administration/transport-security.md) section. +The GELF output plugin supports TLS/SSL. +For more details about the properties available and general configuration, see [TLS/SSL](../../administration/transport-security.md). ## Notes diff --git a/pipeline/outputs/http.md b/pipeline/outputs/http.md index bbbdd8e79..02611730c 100644 --- a/pipeline/outputs/http.md +++ b/pipeline/outputs/http.md @@ -37,7 +37,8 @@ The **http** output plugin allows to flush your records into a HTTP endpoint. Fo ### TLS / SSL -HTTP output plugin supports TLS/SSL, for more details about the properties available and general configuration, please refer to the [TLS/SSL](../../administration/transport-security.md) section. +The HTTP output plugin supports TLS/SSL. +For more details about the properties available and general configuration, see [TLS/SSL](../../administration/transport-security.md). ## Getting Started diff --git a/pipeline/outputs/influxdb.md b/pipeline/outputs/influxdb.md index 475e8f304..19c7da4b2 100644 --- a/pipeline/outputs/influxdb.md +++ b/pipeline/outputs/influxdb.md @@ -24,7 +24,8 @@ The **influxdb** output plugin, allows to flush your records into a [InfluxDB](h ### TLS / SSL -InfluxDB output plugin supports TLS/SSL, for more details about the properties available and general configuration, please refer to the [TLS/SSL](../../administration/transport-security.md) section. +The InfluxDB output plugin supports TLS/SSL. +For more details about the properties available and general configuration, see [TLS/SSL](../../administration/transport-security.md). ## Getting Started diff --git a/pipeline/outputs/kafka-rest-proxy.md b/pipeline/outputs/kafka-rest-proxy.md index b03d49e9d..6d63cee19 100644 --- a/pipeline/outputs/kafka-rest-proxy.md +++ b/pipeline/outputs/kafka-rest-proxy.md @@ -19,7 +19,8 @@ The **kafka-rest** output plugin, allows to flush your records into a [Kafka RES ### TLS / SSL -Kafka REST Proxy output plugin supports TLS/SSL, for more details about the properties available and general configuration, please refer to the [TLS/SSL](../../administration/transport-security.md) section. +The Kafka REST Proxy output plugin supports TLS/SSL. +For more details about the properties available and general configuration, see [TLS/SSL](../../administration/transport-security.md). ## Getting Started diff --git a/pipeline/outputs/oci-logging-analytics.md b/pipeline/outputs/oci-logging-analytics.md index 4f8246ceb..253b86f12 100644 --- a/pipeline/outputs/oci-logging-analytics.md +++ b/pipeline/outputs/oci-logging-analytics.md @@ -37,7 +37,8 @@ The following parameters are to set the Logging Analytics resources that must be ## TLS/SSL -OCI Logging Analytics output plugin supports TLS/SSL, for more details about the properties available and general configuration, please refer to the [TLS/SSL](../../administration/transport-security.md) section. +The OCI Logging Analytics output plugin supports TLS/SSL. +For more details about the properties available and general configuration, see [TLS/SSL](../../administration/transport-security.md). ## Getting Started diff --git a/pipeline/outputs/opensearch.md b/pipeline/outputs/opensearch.md index 0b0142d3d..445504dd0 100644 --- a/pipeline/outputs/opensearch.md +++ b/pipeline/outputs/opensearch.md @@ -52,7 +52,8 @@ The following instructions assumes that you have a fully operational OpenSearch ### TLS / SSL -OpenSearch output plugin supports TLS/SSL, for more details about the properties available and general configuration, please refer to the [TLS/SSL](../../administration/transport-security.md) section. +The OpenSearch output plugin supports TLS/SSL. +For more details about the properties available and general configuration, see [TLS/SSL](../../administration/transport-security.md). ### write\_operation diff --git a/pipeline/outputs/skywalking.md b/pipeline/outputs/skywalking.md index 1d6206bf1..1d0f42925 100644 --- a/pipeline/outputs/skywalking.md +++ b/pipeline/outputs/skywalking.md @@ -15,7 +15,8 @@ The **Apache SkyWalking** output plugin, allows to flush your records to a [Apac ### TLS / SSL -Apache SkyWalking output plugin supports TLS/SSL, for more details about the properties available and general configuration, please refer to the [TLS/SSL](../../administration/transport-security.md) section. +The Apache SkyWalking output plugin supports TLS/SSL. +For more details about the properties available and general configuration, see [TLS/SSL](../../administration/transport-security.md). ## Getting Started diff --git a/pipeline/outputs/splunk.md b/pipeline/outputs/splunk.md index 545e85d4c..5c752409a 100644 --- a/pipeline/outputs/splunk.md +++ b/pipeline/outputs/splunk.md @@ -41,7 +41,8 @@ Content and Splunk metadata \(fields\) handling configuration properties: ### TLS / SSL -Splunk output plugin supports TLS/SSL, for more details about the properties available and general configuration, please refer to the [TLS/SSL](../../administration/transport-security.md) section. +The Splunk output plugin supports TLS/SSL. +For more details about the properties available and general configuration, see [TLS/SSL](../../administration/transport-security.md). ## Getting Started diff --git a/pipeline/outputs/syslog.md b/pipeline/outputs/syslog.md index 9c6f17e23..9cce9d2e5 100644 --- a/pipeline/outputs/syslog.md +++ b/pipeline/outputs/syslog.md @@ -36,7 +36,7 @@ You must be aware of the structure of your original record so you can configure ### TLS / SSL The Syslog output plugin supports TLS/SSL. -For more details about the properties available and general configuration, please refer to the [TLS/SSL](../../administration/transport-security.md) section. +For more details about the properties available and general configuration, see [TLS/SSL](../../administration/transport-security.md). ## Examples