From 8ca7478bf7cdce4db0097b6042e73678d90a904d Mon Sep 17 00:00:00 2001 From: Cijo Thomas Date: Mon, 26 Feb 2024 21:48:46 -0800 Subject: [PATCH 1/2] Reade fixes part2 --- .cspell.json | 3 +++ CONTRIBUTING.md | 7 ++++--- README.md | 28 ++++++++++++++++------------ precommit.sh | 1 - 4 files changed, 23 insertions(+), 16 deletions(-) delete mode 100755 precommit.sh diff --git a/.cspell.json b/.cspell.json index be20dea3d4..a8337489b0 100644 --- a/.cspell.json +++ b/.cspell.json @@ -30,6 +30,7 @@ "appenders", "Bhasin", "Cijo", + "clippy", "codecov", "deque", "Dirkjan", @@ -40,6 +41,7 @@ "Kühle", "Kumar", "Lalit", + "LIBCLANG", "msrv", "Ochtman", "opentelemetry", @@ -48,6 +50,7 @@ "quantile", "Redelmeier", "reqwest", + "runtimes", "rustc", "Tescher", "tracerprovider", diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 34a8159ac6..4d0d9e9e9b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,7 +74,7 @@ Open a pull request against the main repo. > **Note** -> It is recommended to run [pre-commit script](precommit.sh) from the root of +> It is recommended to run [pre-commit script](scripts/precommit.sh) from the root of the repo to catch any issues locally. ### How to Receive Comments @@ -146,7 +146,7 @@ OpenTelemetry supports multiple ways to configure the API, SDK and other compone - Environment variables - Compiling time configurations provided in the source code -### Experimental/Unstable features: +### Experimental/Unstable features Use `otel_unstable` feature flag for implementation of specification with [experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.27.0/specification/document-status.md) status. This approach ensures clear demarcation and safe integration of new or evolving features. Utilize the following structure: @@ -156,9 +156,10 @@ Use `otel_unstable` feature flag for implementation of specification with [exper // Your feature implementation } ``` + It's important to regularly review and remove the `otel_unstable` flag from the code once the feature becomes stable. This cleanup process is crucial to maintain the overall code quality and to ensure that stable features are accurately reflected in the main build. -### Optional features: +### Optional features The potential features include: diff --git a/README.md b/README.md index f79c381536..efd6ff8ae3 100644 --- a/README.md +++ b/README.md @@ -94,22 +94,26 @@ See the [examples](./examples) directory for different integration patterns. The following crates are maintained in this repo: * [`opentelemetry`] This is the OpenTelemetry API crate, and is the crate - required to instrument libraries and applications. It contains Logging Bridge - API, Metrics API, and Tracing API. + required to instrument libraries and applications. It contains Context API, + Baggage API, Propagators API, Logging Bridge API, Metrics API, and Tracing + API. * [`opentelemetry-sdk`] This is the OpenTelemetry SDK crate, and contains the official OpenTelemetry SDK implementation. It contains Logging SDK, Metrics - SDK, and Tracing SDK. + SDK, and Tracing SDK. It also contains propagator implementations. * [`opentelemetry-otlp`] exporter for sending logs, metrics and traces in the - OTLP format to an endpoint accepting OTLP, typically the OpenTelemetry - collector. + OTLP format to an endpoint accepting OTLP, like the [OpenTelemetry + collector](https://opentelemetry.io/docs/collector/), or [vendor specific + endpoints](https://opentelemetry.io/ecosystem/vendors/). * [`opentelemetry-stdout`] exporter for sending logs, metrics and traces to stdout, for learning/debugging purposes. * [`opentelemetry-http`] This crate contains utility functions to help with exporting telemetry, propagation, over [`http`]. * [`opentelemetry-appender-log`] This crate provides logging appender to route - logs emitted using the `log` crate to opentelemetry. -* [`opentelemetry-appender-tracing`] This crate provides logging appender to route - logs emitted using the `tracing` crate to opentelemetry. + logs emitted using the [log](https://docs.rs/log/latest/log/) crate to + opentelemetry. +* [`opentelemetry-appender-tracing`] This crate provides logging appender to + route logs emitted using the [tracing](https://crates.io/crates/tracing) crate + to opentelemetry. * [`opentelemetry-jaeger-propagator`] provides context propagation using [jaeger propagation format](https://www.jaegertracing.io/docs/1.18/client-libraries/#propagation-format). @@ -159,9 +163,9 @@ this policy. See the [contributing file](CONTRIBUTING.md). The Rust special interest group (SIG) meets weekly on Tuesdays at 9 AM Pacific -Time. The meeting is subject to change depending on contributors' -availability. Check the [OpenTelemetry community -calendar](https://calendar.google.com/calendar/embed?src=google.com_b79e3e90j7bbsa2n2p5an5lf60%40group.calendar.google.com) +Time. The meeting is subject to change depending on contributors' availability. +Check the [OpenTelemetry community +calendar](https://github.com/open-telemetry/community?tab=readme-ov-file#calendar) for specific dates and for Zoom meeting links. "OTel Rust SIG" is the name of meeting for this group. @@ -200,4 +204,4 @@ For GitHub groups see the [code owners](CODEOWNERS) file. ### Thanks to all the people who have contributed -[![contributors](https://contributors-img.web.app/image?repo=open-telemetry/opentelemetry-rust)](https://github.com/open-telemetry/opentelemetry-rust/graphs/contributors) \ No newline at end of file +[![contributors](https://contributors-img.web.app/image?repo=open-telemetry/opentelemetry-rust)](https://github.com/open-telemetry/opentelemetry-rust/graphs/contributors) diff --git a/precommit.sh b/precommit.sh deleted file mode 100755 index 0144ba8a36..0000000000 --- a/precommit.sh +++ /dev/null @@ -1 +0,0 @@ -cargo update && cargo fmt --all && ./scripts/lint.sh && ./scripts/test.sh \ No newline at end of file From d984a13071b55d2af09400f5d4c5b850a536d6ce Mon Sep 17 00:00:00 2001 From: Cijo Thomas Date: Mon, 26 Feb 2024 21:51:37 -0800 Subject: [PATCH 2/2] add --- scripts/precommit.sh | 1 + 1 file changed, 1 insertion(+) create mode 100755 scripts/precommit.sh diff --git a/scripts/precommit.sh b/scripts/precommit.sh new file mode 100755 index 0000000000..0144ba8a36 --- /dev/null +++ b/scripts/precommit.sh @@ -0,0 +1 @@ +cargo update && cargo fmt --all && ./scripts/lint.sh && ./scripts/test.sh \ No newline at end of file