Skip to content

Add usage doc comment for AnyValue type #2293

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

Merged
lalitb merged 4 commits into from
Nov 8, 2024
Merged

Add usage doc comment for AnyValue type #2293

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
af0b7d1
add comment
lalitb Nov 8, 2024
a2b7a7e
add comment
lalitb Nov 8, 2024
3f368b6
Update opentelemetry/src/logs/record.rs
lalitb Nov 8, 2024
c44ce60
Merge branch 'main' into anyvalue-comment
lalitb Nov 8, 2024
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
8 changes: 8 additions & 0 deletions opentelemetry/src/logs/record.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,14 @@ pub trait LogRecord {
}

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