Merge branch 'main' into modify-batchProcessor-test-use-flush-instead-of-sleeptime

Author: cijothomas

.github/workflows/pr_naming.yml

@@ -0,0 +1,15 @@
+name: PR Conventional Commit Validation
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, edited]
+
+jobs:
+  validate-pr-title:
+    runs-on: ubuntu-latest
+    steps:
+      - name: PR Conventional Commit Validation
+        uses:  ytanikin/[email protected]
+        with:
+          task_types: '["build","chore","ci","docs","feat","fix","perf","refactor","revert","test"]'
+          add_label: 'false'

CONTRIBUTING.md

@@ -78,6 +78,11 @@ Open a pull request against the main
 [opentelemetry-rust](https://github.com/open-telemetry/opentelemetry-rust)
 repo.
 
+Your pull request should be named according to the
+[conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard. This ensures that
+when the PR is squashed into `main`, the resulting commit message is consistent and makes it easier
+for us to generate a changelog  standard. 
+
 > **Note**
 > It is recommended to run [pre-commit script](scripts/precommit.sh) to catch any issues locally.
 

Cargo.toml

@@ -53,6 +53,31 @@ tracing = { version = ">=0.1.40", default-features = false }
 tracing-core = { version = ">=0.1.33", default-features = false } 
 tracing-subscriber = { version = "0.3", default-features = false }
 url = { version = "2.5", default-features = false }
+anyhow = "1.0.94"
+base64 = "0.22.1"
+chrono = { version = "0.4.34", default-features = false }
+ctor = "0.2.9"
+ctrlc = "3.2.5"
+futures-channel = "0.3"
+futures-sink = "0.3"
+glob = "0.3.1"
+hex = "0.4.3"
+lazy_static = "1.4.0"
+num-format = "0.4.4"
+num_cpus = "1.15.0"
+opentelemetry-appender-tracing = { path = "opentelemetry-appender-tracing", default-features = false }
+opentelemetry-otlp = { path = "opentelemetry-otlp" }
+opentelemetry-stdout = { path = "opentelemetry-stdout" }
+percent-encoding = "2.0"
+rstest = "0.23.0"
+schemars = "0.8"
+sysinfo = "0.32"
+tempfile = "3.3.0"
+testcontainers = "0.23.1"
+tracing-log = "0.2"
+tracing-opentelemetry = "0.29"
+typed-builder = "0.20"
+uuid = "1.3"
 
 # Aviod use of crates.io version of these crates through the tracing-opentelemetry dependencies
 [patch.crates-io]

README.md

@@ -186,6 +186,7 @@ you're more than welcome to participate!
 ### Approvers
 
 * [Shaun Cox](https://github.com/shaun-cox)
+* [Scott Gerring](https://github.com/scottgerring)
 
 ### Emeritus
 

docs/design/logs.md

@@ -280,6 +280,22 @@ this crate.
 ## Performance
 
 // Call out things done specifically for performance
+// Rough draft
+
+1. `LogRecord` is stack allocated and not Boxed unless required by the component
+needing to store it beyond the logging call. (eg: BatchProcessor)
+2. LogRecords's Attribute storage is specially designed struct, that holds up to
+five attributes in stack.
+3. When passing `LogRecord`s to processor, a mutable ref is passed. This allows
+calling multiple processors one after another, without the need for cloning.
+4. `Logger` provides a `Enabled` check which can optimize performance when
+no-one is interested in the log. The check is passed from `Logger` to the
+processor, which may consult its exporter to make the decision. An example use
+case - an ETW or user-events exporter can check for the presence of listener and
+convey that decision back to logger, allowing appender to avoid even the cost of
+creating a `LogRecord` in the first place if there is no listener. This check is
+done for each log emission, and can react dynamically to changes in interest, by
+enabling/disabling ETW/user-event listener.
 
 ### Perf test - benchmarks
 
@@ -289,6 +305,23 @@ this crate.
 
 // Share ~~ numbers
 
+## Internal logs
+
+OTel itself is instrumented with `tracing` crate to emit internal logs about its
+operations. This is feature gated under "internal-logs", and is enabled by
+default for all components. The `opentelemetry` provide few helper macros
+`otel_warn` etc., which in turn invokes various `tracing` macros like `warn!`
+etc. The cargo package name will be set as `target` when using `tracing`. For
+example, logs from `opentelemetry-otlp` will have target set to
+"opentelemetry-otlp".
+
+The helper macros are part of public API, so can be used by anyone. But it is
+only meant for OTel components itself and anyone writing extensions like custom
+Exporters etc.
+
+// TODO: Document the principles followed when selecting severity for internal
+logs // TODO: Document how this can cause circular loop and plans to address it.
+
 ## Summary
 
 - OpenTelemetry Logs does not provide a user-facing logging API.

examples/logs-basic/Cargo.toml

@@ -7,7 +7,7 @@ publish = false
 
 [dependencies]
 opentelemetry_sdk = { path = "../../opentelemetry-sdk", features = ["logs"] }
-opentelemetry-stdout = { path = "../../opentelemetry-stdout", features = ["logs"]}
-opentelemetry-appender-tracing = { path = "../../opentelemetry-appender-tracing", default-features = false}
+opentelemetry-stdout = { workspace = true, features = ["logs"] }
+opentelemetry-appender-tracing = { workspace = true }
 tracing = { workspace = true, features = ["std"]}
 tracing-subscriber = { workspace = true, features = ["env-filter","registry", "std", "fmt"] }

examples/metrics-advanced/Cargo.toml

@@ -8,5 +8,5 @@ publish = false
 [dependencies]
 opentelemetry = { path = "../../opentelemetry", features = ["metrics"] }
 opentelemetry_sdk = { path = "../../opentelemetry-sdk", features = ["spec_unstable_metrics_views", "rt-tokio"] }
-opentelemetry-stdout = { path = "../../opentelemetry-stdout", features = ["metrics"] }
+opentelemetry-stdout = { workspace = true, features = ["metrics"] }
 tokio = { workspace = true, features = ["full"] }

examples/metrics-basic/Cargo.toml

@@ -8,6 +8,6 @@ publish = false
 [dependencies]
 opentelemetry = { path = "../../opentelemetry", features = ["metrics"] }
 opentelemetry_sdk = { path = "../../opentelemetry-sdk", features = ["metrics", "rt-tokio"] }
-opentelemetry-stdout = { path = "../../opentelemetry-stdout", features = ["metrics"]}
+opentelemetry-stdout = { workspace = true, features = ["metrics"] }
 tokio = { workspace = true, features = ["full"] }
 

examples/tracing-grpc/Cargo.toml

@@ -16,7 +16,7 @@ path = "src/client.rs"
 [dependencies]
 opentelemetry = { path = "../../opentelemetry" }
 opentelemetry_sdk = { path = "../../opentelemetry-sdk", features = ["rt-tokio"] }
-opentelemetry-stdout = { path = "../../opentelemetry-stdout", features = ["trace"] }
+opentelemetry-stdout = { workspace = true, features = ["trace"] }
 prost = { workspace = true }
 tokio = { workspace = true, features = ["full"] }
 tonic = { workspace = true, features = ["server"] }

examples/tracing-http-propagator/Cargo.toml

@@ -23,5 +23,5 @@ tokio = { workspace = true, features = ["full"] }
 opentelemetry = { path = "../../opentelemetry" }
 opentelemetry_sdk = { path = "../../opentelemetry-sdk" }
 opentelemetry-http = { path = "../../opentelemetry-http" }
-opentelemetry-stdout = { path = "../../opentelemetry-stdout", features = ["trace"] }
+opentelemetry-stdout = { workspace = true, features = ["trace"] }
 opentelemetry-semantic-conventions = { path = "../../opentelemetry-semantic-conventions" }