Skip to content

chore: improves OTEL docs a bit #2044

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 20, 2025
Merged

chore: improves OTEL docs a bit #2044

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/otel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ while DevOps manage its configuration, deployment, and backend integration.

We are focusing on the signals: **traces** and **metrics**.

## To enable traces, follow the instructions below
## Enabling Traces

* Clone Trustify
* Open a terminal and run the command below to start OTEL Collector, Tempo, Prometheus, and Grafana:
Expand All @@ -36,9 +36,9 @@ RUST_LOG=info OTEL_TRACES_SAMPLER_ARG=1 cargo run --bin trustd api --devmode --d

>[!NOTE]
> You can select `traces` or `metrics` individually, or both, as shown in the command above.
> For `metrics` only, the extra environment variables `RUST_LOG=info` and `OTEL_TRACES_SAMPLER_ARG=1` are not needed.
> When using `metrics` only, the extra environment variables `RUST_LOG=info` and `OTEL_TRACES_SAMPLER_ARG=1` are not required.

* For the importer use the command below to enable traces:
* To enable traces for the importer, use the command below:

```shell
RUST_LOG=info OTEL_TRACES_SAMPLER_ARG=1 cargo run --bin trustd importer --db-port 5432 --tracing enabled
Expand All @@ -54,7 +54,7 @@ To view Trustify's metrics in the Prometheus expression browser, use the followi

## Diagrams

The diagrams below reflect the **current state** of both Trustify and [Trustify Helm Charts](https://github.com/trustification/trustify-helm-charts)
The diagrams below reflect the **current state** of both Trustify and the [Trustify Helm Charts](https://github.com/trustification/trustify-helm-charts).

### Scenarios

Expand Down