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

Moving LogRecord implementation to SDK #1702

Merged
merged 23 commits into from
May 8, 2024
Merged

Moving LogRecord implementation to SDK #1702

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
f1b6e17
initial commit
lalitb May 1, 2024
b8c91c8
initial commit
lalitb May 2, 2024
bdba90e
logrecord trait
lalitb May 2, 2024
80bab96
add builder
lalitb May 2, 2024
10945f0
fix tracinglayer
lalitb May 2, 2024
4bf49c3
revert proto
lalitb May 2, 2024
bc1095d
fix lint and doc
lalitb May 2, 2024
2f3d8c6
Merge branch 'main' into logrecord-to-sdk
lalitb May 2, 2024
97ccf71
remove builder
lalitb May 3, 2024
edd9258
remove extra AnyValue
lalitb May 3, 2024
3a9e732
add tests
lalitb May 6, 2024
2c54e26
Merge branch 'main' into logrecord-to-sdk
TommyCpp May 6, 2024
f6ce7ac
rename SdkLogRecord to LogRecord
lalitb May 6, 2024
229fbf5
Merge branch 'main' into logrecord-to-sdk
lalitb May 6, 2024
a07acb2
inline noop's
lalitb May 7, 2024
162d7b1
Update opentelemetry-sdk/src/logs/record.rs
lalitb May 7, 2024
0febbd8
Update opentelemetry/src/logs/record.rs
lalitb May 7, 2024
aba3367
Merge branch 'main' into logrecord-to-sdk
lalitb May 7, 2024
97428ea
review comments
lalitb May 7, 2024
f4aec19
fix doc test
lalitb May 7, 2024
451688b
Merge branch 'main' into logrecord-to-sdk
cijothomas May 8, 2024
f6c7e28
doc test
lalitb May 8, 2024
cc5b4f7
Merge branch 'main' into logrecord-to-sdk
cijothomas May 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
19 changes: 8 additions & 11 deletions opentelemetry-appender-log/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@

use log::{Level, Metadata, Record};
use opentelemetry::{
logs::{AnyValue, LogRecordBuilder, Logger, LoggerProvider, Severity},
logs::{AnyValue, LogRecord, Logger, LoggerProvider, Severity},
Key,
};
use std::borrow::Cow;
Expand Down Expand Up @@ -126,16 +126,13 @@ where

fn log(&self, record: &Record) {
if self.enabled(record.metadata()) {
self.logger.emit(
LogRecordBuilder::new()
.with_severity_number(severity_of_level(record.level()))
.with_severity_text(record.level().as_str())
// Not populating ObservedTimestamp, instead relying on OpenTelemetry
// API to populate it with current time.
.with_body(AnyValue::from(record.args().to_string()))
.with_attributes(log_attributes(record.key_values()))
.build(),
);
let mut log_record = self.logger.create_log_record();
log_record.set_severity_number(severity_of_level(record.level()));
log_record.set_severity_text(record.level().as_str().into());
log_record.set_body(AnyValue::from(record.args().to_string()));
log_record.set_attributes(log_attributes(record.key_values()));

self.logger.emit(log_record);
}
}

Expand Down
18 changes: 9 additions & 9 deletions opentelemetry-appender-tracing/src/layer.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,11 @@ impl EventVisitor {
}
}

fn push_to_otel_log_record(self, log_record: &mut LogRecord) {
log_record.body = self.log_record_body;
log_record.attributes = Some(self.log_record_attributes);
fn push_to_otel_log_record<LR: LogRecord>(self, log_record: &mut LR) {
if let Some(body) = self.log_record_body {
log_record.set_body(body);
}
log_record.set_attributes(self.log_record_attributes);
}
}

Expand Down Expand Up @@ -166,12 +168,10 @@ where
#[cfg(not(feature = "experimental_metadata_attributes"))]
let meta = event.metadata();

let mut log_record: LogRecord = LogRecord::default();
log_record.severity_number = Some(severity_of_level(meta.level()));
log_record.severity_text = Some(meta.level().to_string().into());

// Not populating ObservedTimestamp, instead relying on OpenTelemetry
// API to populate it with current time.
//let mut log_record: LogRecord = LogRecord::default();
let mut log_record = self.logger.create_log_record();
log_record.set_severity_number(severity_of_level(meta.level()));
log_record.set_severity_text(meta.level().to_string().into());

let mut visitor = EventVisitor::default();
visitor.visit_metadata(meta);
Expand Down
6 changes: 3 additions & 3 deletions opentelemetry-proto/src/transform/logs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ pub mod tonic {
}
}

impl From<opentelemetry::logs::LogRecord> for LogRecord {
fn from(log_record: opentelemetry::logs::LogRecord) -> Self {
impl From<opentelemetry_sdk::logs::SdkLogRecord> for LogRecord {
fn from(log_record: opentelemetry_sdk::logs::SdkLogRecord) -> Self {
let trace_context = log_record.trace_context.as_ref();
let severity_number = match log_record.severity_number {
Some(Severity::Trace) => SeverityNumber::Trace,
Expand Down Expand Up @@ -83,7 +83,7 @@ pub mod tonic {

LogRecord {
time_unix_nano: log_record.timestamp.map(to_nanos).unwrap_or_default(),
observed_time_unix_nano: to_nanos(log_record.observed_timestamp),
observed_time_unix_nano: to_nanos(log_record.observed_timestamp.unwrap()),
severity_number: severity_number.into(),
severity_text: log_record.severity_text.map(Into::into).unwrap_or_default(),
body: log_record.body.map(Into::into),
Expand Down
208 changes: 93 additions & 115 deletions opentelemetry-sdk/benches/log.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ use std::time::SystemTime;
use async_trait::async_trait;
use criterion::{criterion_group, criterion_main, Criterion};

use opentelemetry::logs::{AnyValue, LogRecord, LogResult, Logger, LoggerProvider as _, Severity};
use opentelemetry::logs::{
AnyValue, LogRecord as _, LogResult, Logger as _, LoggerProvider as _, Severity,
};
use opentelemetry::trace::Tracer;
use opentelemetry::trace::TracerProvider as _;
use opentelemetry::Key;
use opentelemetry_sdk::export::logs::{LogData, LogExporter};
use opentelemetry_sdk::logs::LoggerProvider;
use opentelemetry_sdk::logs::{Logger, LoggerProvider};
use opentelemetry_sdk::trace::{config, Sampler, TracerProvider};

#[derive(Debug)]
Expand All @@ -22,7 +24,7 @@ impl LogExporter for VoidExporter {
}
}

fn log_benchmark_group<F: Fn(&dyn Logger)>(c: &mut Criterion, name: &str, f: F) {
fn log_benchmark_group<F: Fn(&Logger)>(c: &mut Criterion, name: &str, f: F) {
let mut group = c.benchmark_group(name);

group.bench_function("no-context", |b| {
Expand Down Expand Up @@ -59,53 +61,45 @@ fn log_benchmark_group<F: Fn(&dyn Logger)>(c: &mut Criterion, name: &str, f: F)

fn criterion_benchmark(c: &mut Criterion) {
log_benchmark_group(c, "simple-log", |logger| {
logger.emit(LogRecord::builder().with_body("simple log").build())
let mut log_record = logger.create_log_record();
log_record.set_body("simple log".into());
logger.emit(log_record);
});

log_benchmark_group(c, "simple-log-with-int", |logger| {
logger.emit(
LogRecord::builder()
.with_body("simple log")
.with_attribute("testint", 2)
.build(),
)
let mut log_record = logger.create_log_record();
log_record.set_body("simple log".into());
log_record.set_attribute("testint", 2);
logger.emit(log_record);
});

log_benchmark_group(c, "simple-log-with-double", |logger| {
logger.emit(
LogRecord::builder()
.with_body("simple log")
.with_attribute("testdouble", 2.2)
.build(),
)
let mut log_record = logger.create_log_record();
log_record.set_body("simple log".into());
log_record.set_attribute("testdouble", 2.2);
logger.emit(log_record);
});

log_benchmark_group(c, "simple-log-with-string", |logger| {
logger.emit(
LogRecord::builder()
.with_body("simple log")
.with_attribute("teststring", "test")
.build(),
)
let mut log_record = logger.create_log_record();
log_record.set_body("simple log".into());
log_record.set_attribute("teststring", "test");
logger.emit(log_record);
});

log_benchmark_group(c, "simple-log-with-bool", |logger| {
logger.emit(
LogRecord::builder()
.with_body("simple log")
.with_attribute("testbool", AnyValue::Boolean(true))
.build(),
)
let mut log_record = logger.create_log_record();
log_record.set_body("simple log".into());
log_record.set_attribute("testbool", AnyValue::Boolean(true));
logger.emit(log_record);
});

let bytes = AnyValue::Bytes(vec![25u8, 30u8, 40u8]);
log_benchmark_group(c, "simple-log-with-bytes", |logger| {
logger.emit(
LogRecord::builder()
.with_body("simple log")
.with_attribute("testbytes", bytes.clone())
.build(),
)
let mut log_record = logger.create_log_record();
log_record.set_body("simple log".into());
log_record.set_attribute("testbytes", bytes.clone());
logger.emit(log_record);
});

let bytes = AnyValue::Bytes(vec![
Expand All @@ -117,22 +111,18 @@ fn criterion_benchmark(c: &mut Criterion) {
30u8, 40u8, 30u8, 40u8, 30u8, 40u8, 30u8, 40u8, 30u8, 40u8,
]);
log_benchmark_group(c, "simple-log-with-a-lot-of-bytes", |logger| {
logger.emit(
LogRecord::builder()
.with_body("simple log")
.with_attribute("testbytes", bytes.clone())
.build(),
)
let mut log_record = logger.create_log_record();
log_record.set_body("simple log".into());
log_record.set_attribute("testbytes", bytes.clone());
logger.emit(log_record);
});

let vec_any_values = AnyValue::ListAny(vec![AnyValue::Int(25), "test".into(), true.into()]);
log_benchmark_group(c, "simple-log-with-vec-any-value", |logger| {
logger.emit(
LogRecord::builder()
.with_body("simple log")
.with_attribute("testvec", vec_any_values.clone())
.build(),
)
let mut log_record = logger.create_log_record();
log_record.set_body("simple log".into());
log_record.set_attribute("testvec", vec_any_values.clone());
logger.emit(log_record);
});

let vec_any_values = AnyValue::ListAny(vec![AnyValue::Int(25), "test".into(), true.into()]);
Expand All @@ -143,12 +133,10 @@ fn criterion_benchmark(c: &mut Criterion) {
vec_any_values,
]);
log_benchmark_group(c, "simple-log-with-inner-vec-any-value", |logger| {
logger.emit(
LogRecord::builder()
.with_body("simple log")
.with_attribute("testvec", vec_any_values.clone())
.build(),
)
let mut log_record = logger.create_log_record();
log_record.set_body("simple log".into());
log_record.set_attribute("testvec", vec_any_values.clone());
logger.emit(log_record);
});

let map_any_values = AnyValue::Map(HashMap::from([
Expand All @@ -157,12 +145,10 @@ fn criterion_benchmark(c: &mut Criterion) {
("teststring".into(), "test".into()),
]));
log_benchmark_group(c, "simple-log-with-map-any-value", |logger| {
logger.emit(
LogRecord::builder()
.with_body("simple log")
.with_attribute("testmap", map_any_values.clone())
.build(),
)
let mut log_record = logger.create_log_record();
log_record.set_body("simple log".into());
log_record.set_attribute("testmap", map_any_values.clone());
logger.emit(log_record);
});

let map_any_values = AnyValue::Map(HashMap::from([
Expand All @@ -177,66 +163,60 @@ fn criterion_benchmark(c: &mut Criterion) {
("testmap".into(), map_any_values),
]));
log_benchmark_group(c, "simple-log-with-inner-map-any-value", |logger| {
logger.emit(
LogRecord::builder()
.with_body("simple log")
.with_attribute("testmap", map_any_values.clone())
.build(),
)
let mut log_record = logger.create_log_record();
log_record.set_body("simple log".into());
log_record.set_attribute("testmap", map_any_values.clone());
logger.emit(log_record);
});

log_benchmark_group(c, "long-log", |logger| {
logger.emit(LogRecord::builder().with_body("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Gravida in fermentum et sollicitudin ac orci phasellus. Ullamcorper dignissim cras tincidunt lobortis feugiat vivamus at augue. Magna etiam tempor orci eu. Sed tempus urna et pharetra pharetra massa.").build())
let mut log_record = logger.create_log_record();
log_record.set_body("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Gravida in fermentum et sollicitudin ac orci phasellus. Ullamcorper dignissim cras tincidunt lobortis feugiat vivamus at augue. Magna etiam tempor orci eu. Sed tempus urna et pharetra pharetra massa.".into());
logger.emit(log_record);
});

let now = SystemTime::now();
log_benchmark_group(c, "full-log", |logger| {
logger.emit(
LogRecord::builder()
.with_body("full log")
.with_timestamp(now)
.with_observed_timestamp(now)
.with_severity_number(Severity::Warn)
.with_severity_text(Severity::Warn.name())
.build(),
)
let mut log_record = logger.create_log_record();
log_record.set_body("full log".into());
log_record.set_timestamp(now);
log_record.set_observed_timestamp(now);
log_record.set_severity_number(Severity::Warn);
log_record.set_severity_text(Severity::Warn.name().into());
logger.emit(log_record);
});

log_benchmark_group(c, "full-log-with-4-attributes", |logger| {
logger.emit(
LogRecord::builder()
.with_body("full log")
.with_timestamp(now)
.with_observed_timestamp(now)
.with_severity_number(Severity::Warn)
.with_severity_text(Severity::Warn.name())
.with_attribute("name", "my-event-name")
.with_attribute("event.id", 20)
.with_attribute("user.name", "otel")
.with_attribute("user.email", "otel@opentelemetry.io")
.build(),
)
let mut log_record = logger.create_log_record();
log_record.set_body("full log".into());
log_record.set_timestamp(now);
log_record.set_observed_timestamp(now);
log_record.set_severity_number(Severity::Warn);
log_record.set_severity_text(Severity::Warn.name().into());
log_record.set_attribute("name", "my-event-name");
log_record.set_attribute("event.id", 20);
log_record.set_attribute("user.name", "otel");
log_record.set_attribute("user.email", "otel@opentelemetry.io");
logger.emit(log_record);
});

log_benchmark_group(c, "full-log-with-9-attributes", |logger| {
logger.emit(
LogRecord::builder()
.with_body("full log")
.with_timestamp(now)
.with_observed_timestamp(now)
.with_severity_number(Severity::Warn)
.with_severity_text(Severity::Warn.name())
.with_attribute("name", "my-event-name")
.with_attribute("event.id", 20)
.with_attribute("user.name", "otel")
.with_attribute("user.email", "otel@opentelemetry.io")
.with_attribute("code.filename", "log.rs")
.with_attribute("code.filepath", "opentelemetry_sdk/benches/log.rs")
.with_attribute("code.lineno", 96)
.with_attribute("code.namespace", "opentelemetry_sdk::benches::log")
.with_attribute("log.target", "opentelemetry_sdk::benches::log")
.build(),
)
let mut log_record = logger.create_log_record();
log_record.set_body("full log".into());
log_record.set_timestamp(now);
log_record.set_observed_timestamp(now);
log_record.set_severity_number(Severity::Warn);
log_record.set_severity_text(Severity::Warn.name().into());
log_record.set_attribute("name", "my-event-name");
log_record.set_attribute("event.id", 20);
log_record.set_attribute("user.name", "otel");
log_record.set_attribute("user.email", "otel@opentelemetry.io");
log_record.set_attribute("code.filename", "log.rs");
log_record.set_attribute("code.filepath", "opentelemetry_sdk/benches/log.rs");
log_record.set_attribute("code.lineno", 96);
log_record.set_attribute("code.namespace", "opentelemetry_sdk::benches::log");
log_record.set_attribute("log.target", "opentelemetry_sdk::benches::log");
logger.emit(log_record);
});

let attributes: Vec<(Key, AnyValue)> = vec![
Expand All @@ -260,16 +240,14 @@ fn criterion_benchmark(c: &mut Criterion) {
),
];
log_benchmark_group(c, "full-log-with-attributes", |logger| {
logger.emit(
LogRecord::builder()
.with_body("full log")
.with_timestamp(now)
.with_observed_timestamp(now)
.with_severity_number(Severity::Warn)
.with_severity_text(Severity::Warn.name())
.with_attributes(attributes.clone())
.build(),
)
let mut log_record = logger.create_log_record();
log_record.set_body("full log".into());
log_record.set_timestamp(now);
log_record.set_observed_timestamp(now);
log_record.set_severity_number(Severity::Warn);
log_record.set_severity_text(Severity::Warn.name().into());
log_record.set_attributes(attributes.clone());
logger.emit(log_record);
});
}

Expand Down
Loading
Loading