Skip to content

fixes before release#334

Merged
davidB merged 6 commits into
mainfrom
db-branch-2
Apr 27, 2026
Merged

fixes before release#334
davidB merged 6 commits into
mainfrom
db-branch-2

Conversation

@davidB

@davidB davidB commented Apr 27, 2026

Copy link
Copy Markdown
Owner

No description provided.

@github-actions

github-actions Bot commented Apr 27, 2026

Copy link
Copy Markdown
Contributor

MegaLinter analysis: Success

Descriptor Linter Files Fixed Errors Warnings Elapsed time
✅ EDITORCONFIG editorconfig-checker 10 0 0 0.06s
✅ MARKDOWN markdownlint 1 0 0 0 0.74s
✅ MARKDOWN markdown-table-formatter 1 0 0 0 0.32s
✅ REPOSITORY checkov yes no no 16.16s
✅ REPOSITORY gitleaks yes no no 0.83s
✅ REPOSITORY git_diff yes no no 0.01s
✅ REPOSITORY grype yes no no 37.2s
✅ REPOSITORY secretlint yes no no 1.39s
✅ REPOSITORY syft yes no no 2.11s
✅ REPOSITORY trivy-sbom yes no no 0.18s
✅ REPOSITORY trufflehog yes no no 3.93s

See detailed reports in MegaLinter artifacts
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by OX Security
Show us your support by starring ⭐ the repository

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds 'wit-bindgen' to the crate skip list in 'deny.toml' and updates the 'init-tracing-opentelemetry' README with a more detailed logging example and a Grafana screenshot. Review feedback highlights that the 'init_subscriber()' call in the documentation should assign its return value to a variable to prevent the tracing guard from being dropped immediately, and suggests using a relative path for the newly added image.

Comment on lines +288 to +289
.init_subscriber()
.expect("valid tracing configuration");

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The Guard returned by init_subscriber() must be assigned to a variable (e.g., let _guard = ...) to ensure it remains in scope for the duration of the application. If the guard is dropped immediately (as in this example), the tracing subscriber and OpenTelemetry exporters will be shut down, and pending traces or logs may not be flushed. Note that the Guard struct is annotated with #[must_use] to help prevent this mistake.

```
> Traces are automatically attached to logs as well, so if the logs are queried in Grafana (for example), the trace automatically links to the log line.

![screenshot of grafana logs](https://raw.githubusercontent.com/davidB/tracing-opentelemetry-instrumentation-sdk/refs/heads/main/examples/logging/screenshot_grafana.png)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Consider using a relative path for the image link. This ensures the image displays correctly when viewing the README on different branches or forks of the repository, and is generally more robust than an absolute URL to the main branch.

Suggested change
![screenshot of grafana logs](https://raw.githubusercontent.com/davidB/tracing-opentelemetry-instrumentation-sdk/refs/heads/main/examples/logging/screenshot_grafana.png)
![screenshot of grafana logs](../examples/logging/screenshot_grafana.png)

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

except when the README is imported into a documentation system (crates.io, docs.rs) that only retreive the project repository, not the full repo

@davidB davidB merged commit 3282314 into main Apr 27, 2026
2 checks passed
@davidB davidB deleted the db-branch-2 branch April 27, 2026 10:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant