From 9de6369f3e860fa9200be9b633cd6677d87a72bb Mon Sep 17 00:00:00 2001 From: Michael Graeb Date: Tue, 15 Oct 2024 10:30:55 -0700 Subject: [PATCH] comment purpose of large files --- runners/s3-benchrunner-rust/src/telemetry/common.rs | 6 +++++- .../s3-benchrunner-rust/src/telemetry/trace/transform.rs | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/runners/s3-benchrunner-rust/src/telemetry/common.rs b/runners/s3-benchrunner-rust/src/telemetry/common.rs index 76373512..bfa86f79 100644 --- 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 index a5d19c6f..a7e57905 100644 --- 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,