Skip to content
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

Add warning about Log API that is it not for app users #1502

Merged
merged 1 commit into from
Jan 30, 2024
Merged

Add warning about Log API that is it not for app users #1502

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions .cspell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
"reqwest",
"rustc",
"Tescher",
"tracerprovider",
"Zhongyang",
"zipkin"
],
Expand Down
3 changes: 1 addition & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,6 @@ above, please let us know! We'd love to add your project to the list!

[`open-telemetry/opentelemetry-rust`]: https://github.com/open-telemetry/opentelemetry-rust
[`opentelemetry-jaeger`]: https://crates.io/crates/opentelemetry-jaeger
[`Jaeger`]: https://www.jaegertracing.io
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure why you removed an associated project. They are also implementing OTLP.

Copy link
Member Author

Choose a reason for hiding this comment

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

This is not the list of associated project. Its just list of links used in the doc, and jaeger was duplicated (and so removed)

[`opentelemetry-otlp`]: https://crates.io/crates/opentelemetry-otlp
[`opentelemetry-http`]: https://crates.io/crates/opentelemetry-http
[`opentelemetry-prometheus`]: https://crates.io/crates/opentelemetry-prometheus
Expand All @@ -157,7 +156,7 @@ above, please let us know! We'd love to add your project to the list!
[`actix-web-opentelemetry`]: https://crates.io/crates/actix-web-opentelemetry
[`actix-web`]: https://crates.io/crates/actix-web
[`opentelemetry-application-insights`]: https://crates.io/crates/opentelemetry-application-insights
[Azure Application Insights]: https://docs.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview
[Azure Application Insights]: https://docs.microsoft.com/azure/azure-monitor/app/app-insights-overview
[`opentelemetry-tide`]: https://crates.io/crates/opentelemetry-tide
[`Tide`]: https://crates.io/crates/tide
[`opentelemetry-stackdriver`]: https://crates.io/crates/opentelemetry-stackdriver
Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Examples
This folder contains some examples that should help you get start crates from `opentelemetry-rust`.
This directory contains some examples that should help you get start crates from `opentelemetry-rust`.

## log-basic
**Logs**
Expand Down
2 changes: 1 addition & 1 deletion examples/tracing-http-propagator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ $ cargo run --bin http-server
$ cargo run --bin http-client

# The spans should be visible in stdout in the order that they were exported.
```
```
5 changes: 2 additions & 3 deletions examples/tracing-http-propagator/src/server.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,8 @@ async fn router(req: Request<Body>) -> Result<Response<Body>, Infallible> {
fn init_tracer() {
global::set_text_map_propagator(TraceContextPropagator::new());

// Install stdout exporter pipeline to be able to retrieve the collected spans.
// For the demonstration, use `Sampler::AlwaysOn` sampler to sample all traces. In a production
// application, use `Sampler::ParentBased` or `Sampler::TraceIdRatioBased` with a desired ratio.
// Setup tracerprovider with stdout exporter
// that prints the spans to stdout.
let provider = TracerProvider::builder()
.with_simple_exporter(SpanExporter::default())
.build();
Expand Down
2 changes: 1 addition & 1 deletion opentelemetry-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ observability tools.

## OpenTelemetry Benchmarks

From the root folder, run the following command:
From the root directory, run the following command:

```sh
cargo bench
Expand Down
5 changes: 3 additions & 2 deletions opentelemetry/src/logs/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
//! # OpenTelemetry Logs API

//! # OpenTelemetry Logs Bridge API
/// This API is not intended to be called by application developers directly. It
/// is provided for logging library authors to build log appenders.
use crate::ExportError;

use std::{sync::PoisonError, time::Duration};
Expand Down
2 changes: 1 addition & 1 deletion stress/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## Usage

Open a console, run the following command from the current folder:
Open a console, run the following command from the current directory:

```sh
cargo run --release --bin X
Expand Down