Merge branch 'main' into build-profiles

Author: cijothomas

opentelemetry-proto/src/transform/metrics.rs

@@ -114,9 +114,13 @@ pub mod tonic {
         fn from(rm: &ResourceMetrics) -> Self {
             ExportMetricsServiceRequest {
                 resource_metrics: vec![TonicResourceMetrics {
-                    resource: Some((&rm.resource).into()),
+                    resource: Some((rm.resource()).into()),
                     scope_metrics: rm.scope_metrics().map(Into::into).collect(),
-                    schema_url: rm.resource.schema_url().map(Into::into).unwrap_or_default(),
+                    schema_url: rm
+                        .resource()
+                        .schema_url()
+                        .map(Into::into)
+                        .unwrap_or_default(),
                 }],
             }
         }
@@ -135,10 +139,10 @@ pub mod tonic {
     impl From<&SdkScopeMetrics> for TonicScopeMetrics {
         fn from(sm: &SdkScopeMetrics) -> Self {
             TonicScopeMetrics {
-                scope: Some((&sm.scope, None).into()),
+                scope: Some((sm.scope(), None).into()),
                 metrics: sm.metrics().map(Into::into).collect(),
                 schema_url: sm
-                    .scope
+                    .scope()
                     .schema_url()
                     .map(ToOwned::to_owned)
                     .unwrap_or_default(),
@@ -149,11 +153,11 @@ pub mod tonic {
     impl From<&SdkMetric> for TonicMetric {
         fn from(metric: &SdkMetric) -> Self {
             TonicMetric {
-                name: metric.name.to_string(),
-                description: metric.description.to_string(),
-                unit: metric.unit.to_string(),
+                name: metric.name().to_string(),
+                description: metric.description().to_string(),
+                unit: metric.unit().to_string(),
                 metadata: vec![], // internal and currently unused
-                data: Some(match &metric.data {
+                data: Some(match metric.data() {
                     AggregatedMetrics::F64(data) => data.into(),
                     AggregatedMetrics::U64(data) => data.into(),
                     AggregatedMetrics::I64(data) => data.into(),

opentelemetry-sdk/CHANGELOG.md

@@ -42,6 +42,10 @@ also modified to suppress telemetry before invoking exporters.
   behind feature flag "experimental_metrics_custom_reader".
   [#2928](https://github.com/open-telemetry/opentelemetry-rust/pull/2928)
 
+- TODO: Placeholder for View related changelog. Polish this after all
+  changes are done.
+  Hide public fields from `Stream` struct.
+
 - *Breaking* `Aggregation` enum moved behind feature flag
   "spec_unstable_metrics_views". This was only required when using Views.
   [#2928](https://github.com/open-telemetry/opentelemetry-rust/pull/2928)
@@ -65,6 +69,12 @@ also modified to suppress telemetry before invoking exporters.
   - `HistogramDataPoint` no longer exposes `bounds` and `bucket_counts`, but
     instead offers `bounds()` and `bucket_counts()` methods that returns an
     iterator over the same.
+  - `Metric` no longer exposes `name`, `description`, `unit`, `data` fields, but
+    instead offers `name()`, `description()`, `unit()`, and `data()` accessor methods.
+  - `ResourceMetrics` no longer exposes `resource` field, but instead offers
+    a `resource()` accessor method.
+  - `ScopeMetrics` no longer exposes `scope` field, but instead offers
+    a `scope()` accessor method.
 
 ## 0.29.0
 

opentelemetry-sdk/src/metrics/data/mod.rs

@@ -12,7 +12,7 @@ use super::Temporality;
 #[derive(Debug)]
 pub struct ResourceMetrics {
     /// The entity that collected the metrics.
-    pub resource: Resource,
+    pub(crate) resource: Resource,
     /// The collection of metrics with unique [InstrumentationScope]s.
     pub(crate) scope_metrics: Vec<ScopeMetrics>,
 }
@@ -27,6 +27,11 @@ impl Default for ResourceMetrics {
 }
 
 impl ResourceMetrics {
+    /// Returns a reference to the [Resource] in [ResourceMetrics].
+    pub fn resource(&self) -> &Resource {
+        &self.resource
+    }
+
     /// Returns an iterator over the [ScopeMetrics] in [ResourceMetrics].
     pub fn scope_metrics(&self) -> impl Iterator<Item = &ScopeMetrics> {
         self.scope_metrics.iter()
@@ -37,12 +42,17 @@ impl ResourceMetrics {
 #[derive(Default, Debug)]
 pub struct ScopeMetrics {
     /// The [InstrumentationScope] that the meter was created with.
-    pub scope: InstrumentationScope,
+    pub(crate) scope: InstrumentationScope,
     /// The list of aggregations created by the meter.
     pub(crate) metrics: Vec<Metric>,
 }
 
 impl ScopeMetrics {
+    /// Returns a reference to the [InstrumentationScope] in [ScopeMetrics].
+    pub fn scope(&self) -> &InstrumentationScope {
+        &self.scope
+    }
+
     /// Returns an iterator over the [Metric]s in [ScopeMetrics].
     pub fn metrics(&self) -> impl Iterator<Item = &Metric> {
         self.metrics.iter()
@@ -55,13 +65,35 @@ impl ScopeMetrics {
 #[derive(Debug)]
 pub struct Metric {
     /// The name of the instrument that created this data.
-    pub name: Cow<'static, str>,
+    pub(crate) name: Cow<'static, str>,
     /// The description of the instrument, which can be used in documentation.
-    pub description: Cow<'static, str>,
+    pub(crate) description: Cow<'static, str>,
     /// The unit in which the instrument reports.
-    pub unit: Cow<'static, str>,
+    pub(crate) unit: Cow<'static, str>,
     /// The aggregated data from an instrument.
-    pub data: AggregatedMetrics,
+    pub(crate) data: AggregatedMetrics,
+}
+
+impl Metric {
+    /// Returns the name of the instrument that created this data.
+    pub fn name(&self) -> &str {
+        &self.name
+    }
+
+    /// Returns the description of the instrument.
+    pub fn description(&self) -> &str {
+        &self.description
+    }
+
+    /// Returns the unit in which the instrument reports.
+    pub fn unit(&self) -> &str {
+        &self.unit
+    }
+
+    /// Returns the aggregated data from the instrument.
+    pub fn data(&self) -> &AggregatedMetrics {
+        &self.data
+    }
 }
 
 /// Aggregated metrics data from an instrument

opentelemetry-sdk/src/metrics/instrument.rs

@@ -190,22 +190,22 @@ impl Instrument {
 #[allow(unreachable_pub)]
 pub struct Stream {
     /// The human-readable identifier of the stream.
-    pub name: Cow<'static, str>,
+    pub(crate) name: Option<Cow<'static, str>>,
     /// Describes the purpose of the data.
-    pub description: Cow<'static, str>,
+    pub(crate) description: Option<Cow<'static, str>>,
     /// the unit of measurement recorded.
-    pub unit: Cow<'static, str>,
+    pub(crate) unit: Option<Cow<'static, str>>,
     /// Aggregation the stream uses for an instrument.
-    pub aggregation: Option<Aggregation>,
+    pub(crate) aggregation: Option<Aggregation>,
     /// An allow-list of attribute keys that will be preserved for the stream.
     ///
     /// Any attribute recorded for the stream with a key not in this set will be
     /// dropped. If the set is empty, all attributes will be dropped, if `None` all
     /// attributes will be kept.
-    pub allowed_attribute_keys: Option<Arc<HashSet<Key>>>,
+    pub(crate) allowed_attribute_keys: Option<Arc<HashSet<Key>>>,
 
     /// Cardinality limit for the stream.
-    pub cardinality_limit: Option<usize>,
+    pub(crate) cardinality_limit: Option<usize>,
 }
 
 #[cfg(feature = "spec_unstable_metrics_views")]
@@ -217,19 +217,19 @@ impl Stream {
 
     /// Set the stream name.
     pub fn name(mut self, name: impl Into<Cow<'static, str>>) -> Self {
-        self.name = name.into();
+        self.name = Some(name.into());
         self
     }
 
     /// Set the stream description.
     pub fn description(mut self, description: impl Into<Cow<'static, str>>) -> Self {
-        self.description = description.into();
+        self.description = Some(description.into());
         self
     }
 
     /// Set the stream unit.
     pub fn unit(mut self, unit: impl Into<Cow<'static, str>>) -> Self {
-        self.unit = unit.into();
+        self.unit = Some(unit.into());
         self
     }