fixes before release#334
Conversation
✅MegaLinter analysis: Success
See detailed reports in MegaLinter artifacts
|
There was a problem hiding this comment.
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.
| .init_subscriber() | ||
| .expect("valid tracing configuration"); |
There was a problem hiding this comment.
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. | ||
|
|
||
|  |
There was a problem hiding this comment.
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.
|  | |
|  |
There was a problem hiding this comment.
except when the README is imported into a documentation system (crates.io, docs.rs) that only retreive the project repository, not the full repo

No description provided.