Skip to content

Commit 0cc2cd5

Browse files
lalitbcijothomas
andauthored
Add usage doc comment for AnyValue type (#2293)
Co-authored-by: Cijo Thomas <[email protected]>
1 parent 845cf21 commit 0cc2cd5

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

opentelemetry/src/logs/record.rs

+8
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,14 @@ pub trait LogRecord {
6161
}
6262

6363
/// Value types for representing arbitrary values in a log record.
64+
/// Note: The `tracing` and `log` crates only support basic types that can be
65+
/// converted to these core variants: `i64`, `f64`, `StringValue`, and `bool`.
66+
/// Any complex and custom types are supported through their Debug implementation,
67+
/// and converted to String. More complex types (`Bytes`, `ListAny`, and `Map`) are
68+
/// included here to meet specification requirements and are available to support
69+
/// custom appenders that may be implemented for other logging crates.
70+
/// These types allow for handling dynamic data structures, so keep in mind the
71+
/// potential performance overhead of using boxed vectors and maps in appenders.
6472
#[derive(Debug, Clone, PartialEq)]
6573
#[non_exhaustive]
6674
pub enum AnyValue {

0 commit comments

Comments
 (0)