Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/irvingpop/dbt_otel_export
Takes dbt runs and turns them into OpenTelemetry traces
https://github.com/irvingpop/dbt_otel_export
Last synced: about 9 hours ago
JSON representation
Takes dbt runs and turns them into OpenTelemetry traces
- Host: GitHub
- URL: https://github.com/irvingpop/dbt_otel_export
- Owner: irvingpop
- License: apache-2.0
- Created: 2024-01-01T20:58:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-31T15:31:56.000Z (9 months ago)
- Last Synced: 2025-02-07T08:46:29.364Z (5 days ago)
- Language: PLpgSQL
- Size: 693 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-dbt - dbt_otel_export - Takes dbt runs and turns them into OpenTelemetry traces. (Packages)
README
## dbt_otel_export
This project is built on the `dbt_artifacts` package for dbt. It takes the output of `dbt_artifacts` and prepares it for consumption by the OpenTelemetry Collector's sqlqueryreceiver
### Using it
1. Add the package to your current dbt project's `packages.yml` file:
```yaml
packages:
- git: "https://github.com/irvingpop/dbt_otel_export.git"
revision: v1.1.2
```
2. Run `dbt deps` to install the package
3. Add an on-run-end hook to your `dbt_project.yml`
```yml
# during the development cycle
on-run-end:
- "{{ dbt_artifacts.upload_results(results) }}"
# later, when in production
on-run-end:
- "{% if target.name == 'prod' %}{{ dbt_artifacts.upload_results(results) }}{% endif %}"
```
3. Run the initial setup for dbt_artifacts
```
dbt run --select dbt_artifacts
```
4. Do a `dbt run` as normal
5. Download the latest OpenTelemetry Collector Contrib binary (`otelcol-contrib`) for your platform from: https://github.com/open-telemetry/opentelemetry-collector-releases/releases/tag/v0.91.0
6. Write out the provided [otel-collector-config.yaml](/examples/otel-collector-config.yaml) file, updating your `datasource` line (Snowflake example provided) and `otlp` endpoint (Honeycomb example provided) as needed:
7. Run the OpenTelemetry Collector service:
```bash
SNOWFLAKE_USERNAME='' \
SNOWFLAKE_PASSWORD='' \
SNOWFLAKE_INSTANCE='my_snowflake_instance.us-east-1' \
SNOWFLAKE_DATABASE='analytics' \
SNOWFLAKE_SCHEMA='prod' \
SNOWFLAKE_WAREHOUSE='DEV' \
SNOWFLAKE_ROLE='TRANSFORMER' \
HONEYCOMB_API_KEY='a_very_secure_token' \
HONEYCOMB_DATASET='dbt_runs' \
./otelcol-contrib --config examples/otel-collector-config.yaml
```
8. Now you should have traces available to view! Example screenshots from Honeycomb:
## For more information
- The dbt_artifacts package: https://github.com/brooklyn-data/dbt_artifacts
- The OpenTelemetry Collector: https://opentelemetry.io/docs/collector/
- The collector's sqlquery receiver: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/sqlqueryreceiver
## Troubleshooting, etc
random stuff to try:
- `select * from export_otel_traces order by "timestamp" asc` should show stuff after at least one dbt run. If not, maybe `on-run-end` hook didn't fire?
- `select * from export_otel_traces_pos` should show 1 result for each time `get_latest_otel_traces()` has been called
- Run `call get_latest_otel_traces()` yourself (note, this will advance the position)
- Look at the otel collector log and/or try enabling detailed debugging
build a slim/dedicated otel collector.
1. Download otel collector builder (`ocb`) from here: https://github.com/open-telemetry/opentelemetry-collector/releases/tag/cmd%2Fbuilder%2Fv0.91.0
2. Use the provided config in [examples/collector-builder-config.yaml](/examples/collector-builder-config.yaml)
3. Run `./ocb --config examples/collector-builder-config.yaml`