comment purpose of large files

awslabs · Oct 15, 2024 · 9de6369 · 9de6369
1 parent 06e4ca4
commit 9de6369
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/runners/s3-benchrunner-rust/src/telemetry/common.rs b/runners/s3-benchrunner-rust/src/telemetry/common.rs
@@ -1,4 +1,8 @@
-//! code adapted from: https://github.com/open-telemetry/opentelemetry-rust/blob/3193320fa6dc17e89a7bed6090000aef781ac29c/opentelemetry-stdout/src/common.rs
+//! This file is for mapping from `opentelemetry_sdk` structs, to serde-serializable
+//! structs that match the OpenTelemetry Protocol (OTLP) format.
+//! See: https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/common/v1/common.proto
+//!
+//! Code adapted from: https://github.com/open-telemetry/opentelemetry-rust/blob/3193320fa6dc17e89a7bed6090000aef781ac29c/opentelemetry-stdout/src/common.rs
 
 use std::{
     borrow::Cow,

diff --git a/runners/s3-benchrunner-rust/src/telemetry/trace/transform.rs b/runners/s3-benchrunner-rust/src/telemetry/trace/transform.rs
@@ -1,4 +1,8 @@
-//! code adapted from: https://github.com/open-telemetry/opentelemetry-rust/blob/3193320fa6dc17e89a7bed6090000aef781ac29c/opentelemetry-stdout/src/trace/exporter.rs
+//! This file is for mapping from `opentelemetry_sdk` structs, to serde-serializable
+//! structs that match the OpenTelemetry Protocol (OTLP) format.
+//! See: https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/trace/v1/trace.proto
+//!
+//! Code adapted from: https://github.com/open-telemetry/opentelemetry-rust/blob/3193320fa6dc17e89a7bed6090000aef781ac29c/opentelemetry-stdout/src/trace/exporter.rs
 
 use crate::telemetry::common::{
     as_human_readable, as_unix_nano, AttributeSet, KeyValue, Resource, Scope,