Apply feedback. Describe sampled_logger config

open-telemetry · Aug 28, 2023 · b6ac5ac · b6ac5ac
1 parent 9778c88
commit b6ac5ac
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/exporter/exporterhelper/README.md b/exporter/exporterhelper/README.md
@@ -24,8 +24,9 @@ The following configuration options can be modified:
       [the batch processor](https://github.com/open-telemetry/opentelemetry-collector/tree/main/processor/batchprocessor)
       is used, the metric `batch_send_size` can be used for estimation)
 - `timeout` (default = 5s): Time to wait per individual attempt to send data to a backend
-- `sampled_logger`: Enables/disables sampling of logging messages.
-  - `enabled` (default = true). When setting `debug` log level the sampling will be disabled regardless of the value of this property.
+- `sampled_logger`: The logger sampler configuration. It caps the CPU and I/O load of logging while keeping a representative subset of your logs.
+  - `enabled` (default = true). Enables/disables sampling of logging messages.
+    When setting `debug` log level the sampling will be disabled regardless of the value of this property.
 
 The `initial_interval`, `max_interval`, `max_elapsed_time`, and `timeout` options accept 
 [duration strings](https://pkg.go.dev/time#ParseDuration),

diff --git a/exporter/otlphttpexporter/README.md b/exporter/otlphttpexporter/README.md
@@ -31,8 +31,9 @@ The following settings can be optionally configured:
 - `timeout` (default = 30s): HTTP request time limit. For details see https://golang.org/pkg/net/http/#Client
 - `read_buffer_size` (default = 0): ReadBufferSize for HTTP client.
 - `write_buffer_size` (default = 512 * 1024): WriteBufferSize for HTTP client.
-- `sampled_logger`: Enables/disables sampling of logging messages.
-    - `enabled` (default = true). When setting `debug` log level the sampling will be disabled regardless of the value of this property.
+- `sampled_logger`: The logger sampler configuration. It caps the CPU and I/O load of logging while keeping a representative subset of your logs.
+    - `enabled` (default = true). Enables/disables sampling of logging messages. 
+        When setting `debug` log level the sampling will be disabled regardless of the value of this property.
 
 Example: