From 795030901088047aa5eb72c281fad2adecebc2b9 Mon Sep 17 00:00:00 2001 From: Pablo Abella Date: Thu, 31 Jul 2025 10:33:09 +0200 Subject: [PATCH 1/3] Change TEMPLATE.md --- README.md | 7 ++++--- TEMPLATE.md | 34 +++++++++++++++++++++++++--------- 2 files changed, 29 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 66dd59a..bbe256d 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,9 @@ Before you connect OpenTelemetry to Tinybird, ensure: - [GitHub Releases](https://github.com/open-telemetry/opentelemetry-collector-contrib/releases) - [Docker Hub](https://hub.docker.com/r/otel/opentelemetry-collector-contrib) + > [!TIP] -> The Tinybird OpenTelemetry Exporter is officially available in the OpenTelemetry Collector Contrib repository as of release v0.131.0. You can use the official OpenTelemetry Collector distributions that include the Tinybird exporter out of the box. +> The Tinybird OpenTelemetry Exporter is officially available in the [OpenTelemetry Collector Contrib repository](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/tinybirdexporter) as of release v0.131.0. You can use the official OpenTelemetry Collector distributions that include the Tinybird exporter out of the box. ## Use the Tinybird OpenTelemetry project template @@ -66,9 +67,9 @@ exporters: datasource: otel_metrics_exponential_histogram gauge: datasource: otel_metrics_gauge - traces: + traces: datasource: otel_traces - logs: + logs: datasource: otel_logs service: diff --git a/TEMPLATE.md b/TEMPLATE.md index f4729f8..bbe256d 100644 --- a/TEMPLATE.md +++ b/TEMPLATE.md @@ -1,4 +1,6 @@ -The Tinybird OpenTelemetry Template lets you instrument your apps using your pre-existing OpenTelemetry data while leveraging Tinybird's real-time features. +# Tinybird OpenTelemetry Template + +[OpenTelemetry](https://opentelemetry.io/) is an open-source observability framework for collecting, processing, and exporting telemetry data (metrics, traces, and logs) from your applications and infrastructure. By integrating OpenTelemetry with Tinybird, you can analyze observability data in real time, build dashboards, and enrich it with other data sources. @@ -12,16 +14,21 @@ Read on to learn how to send data from OpenTelemetry to Tinybird. ## Before you start -Before you connect OpenTelemetry to Tinybird, ensure you are running the Tinybird distribution of the OpenTelemetry Collector. +Before you connect OpenTelemetry to Tinybird, ensure: + +* You have a Tinybird workspace. +* You have a Tinybird Token with **append** permissions to the target Data Sources. +* You are running a release version of the OpenTelemetry Collector higher than release v0.131.0. -You can find the latest release of the Tinybird OpenTelemetry Collector here: +- [GitHub Releases](https://github.com/open-telemetry/opentelemetry-collector-contrib/releases) +- [Docker Hub](https://hub.docker.com/r/otel/opentelemetry-collector-contrib) -* [GitHub Releases](https://github.com/tinybirdco/opentelemetry-collector-contrib/releases) -* [Docker Hub](https://hub.docker.com/r/tinybirdco/opentelemetry-collector-contrib/tags) +> [!TIP] +> The Tinybird OpenTelemetry Exporter is officially available in the [OpenTelemetry Collector Contrib repository](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/tinybirdexporter) as of release v0.131.0. You can use the official OpenTelemetry Collector distributions that include the Tinybird exporter out of the box. -## Setup the template +## Use the Tinybird OpenTelemetry project template -Fork the GitHub repository and deploy the data project to Tinybird. +To get started quickly, you can use the [Tinybird OpenTelemetry project template](https://github.com/tinybirdco/tinybird-otel-template). This template provides ready-to-use Data Sources and Pipes for storing and analyzing your telemetry data in Tinybird. ```bash # select or create a new workspace @@ -60,9 +67,9 @@ exporters: datasource: otel_metrics_exponential_histogram gauge: datasource: otel_metrics_gauge - traces: + traces: datasource: otel_traces - logs: + logs: datasource: otel_logs service: @@ -87,3 +94,12 @@ service: * `OTEL_TINYBIRD_API_HOST`: The API host for your Tinybird workspace (e.g., `https://api.tinybird.co`). * `OTEL_TINYBIRD_TOKEN`: A Tinybird token with **append** permissions to the target Data Sources (`otel_metrics`, `otel_traces`, `otel_logs`). + +You can create a token in the Tinybird UI under **Tokens**. Make sure it has the required append permissions for the Data Sources you want to ingest into. + +## Next steps + +* Explore and customize the [Tinybird OpenTelemetry project template](https://github.com/tinybirdco/tinybird-otel-template) to fit your needs. +* Use the ingested data to build real-time analytics, dashboards, and alerts in Tinybird. + +For more details on the available configuration options, see the [Tinybird OpenTelemetry Collector documentation](https://github.com/tinybirdco/opentelemetry-collector-contrib). From 8f58b59d150eb294074e63593bb2947a369eb932 Mon Sep 17 00:00:00 2001 From: gnzjgo Date: Thu, 31 Jul 2025 10:51:26 +0200 Subject: [PATCH 2/3] Update TEMPLATE.md --- TEMPLATE.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/TEMPLATE.md b/TEMPLATE.md index bbe256d..78f0c97 100644 --- a/TEMPLATE.md +++ b/TEMPLATE.md @@ -96,10 +96,3 @@ service: * `OTEL_TINYBIRD_TOKEN`: A Tinybird token with **append** permissions to the target Data Sources (`otel_metrics`, `otel_traces`, `otel_logs`). You can create a token in the Tinybird UI under **Tokens**. Make sure it has the required append permissions for the Data Sources you want to ingest into. - -## Next steps - -* Explore and customize the [Tinybird OpenTelemetry project template](https://github.com/tinybirdco/tinybird-otel-template) to fit your needs. -* Use the ingested data to build real-time analytics, dashboards, and alerts in Tinybird. - -For more details on the available configuration options, see the [Tinybird OpenTelemetry Collector documentation](https://github.com/tinybirdco/opentelemetry-collector-contrib). From c9a6e293fb99b9fddfaac98649bf9f8c7ab65462 Mon Sep 17 00:00:00 2001 From: gnzjgo Date: Thu, 31 Jul 2025 10:51:32 +0200 Subject: [PATCH 3/3] Update TEMPLATE.md --- TEMPLATE.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/TEMPLATE.md b/TEMPLATE.md index 78f0c97..0fbc965 100644 --- a/TEMPLATE.md +++ b/TEMPLATE.md @@ -94,5 +94,3 @@ service: * `OTEL_TINYBIRD_API_HOST`: The API host for your Tinybird workspace (e.g., `https://api.tinybird.co`). * `OTEL_TINYBIRD_TOKEN`: A Tinybird token with **append** permissions to the target Data Sources (`otel_metrics`, `otel_traces`, `otel_logs`). - -You can create a token in the Tinybird UI under **Tokens**. Make sure it has the required append permissions for the Data Sources you want to ingest into.