Feat/add resource builder (#2322)

Co-authored-by: Lalit Kumar Bhasin <lalit_fin@yahoo.com>

Author: pitoniak32

.gitignore

@@ -5,4 +5,6 @@
 Cargo.lock
 /.idea/
 
-.cosine
+.cosine
+
+opentelemetry-otlp/tests/integration_test/result.json

examples/logs-basic/src/main.rs

@@ -1,4 +1,3 @@
-use opentelemetry::KeyValue;
 use opentelemetry_appender_tracing::layer;
 use opentelemetry_sdk::logs::LoggerProvider;
 use opentelemetry_sdk::Resource;
@@ -8,10 +7,11 @@ use tracing_subscriber::prelude::*;
 fn main() {
     let exporter = opentelemetry_stdout::LogExporter::default();
     let provider: LoggerProvider = LoggerProvider::builder()
-        .with_resource(Resource::new(vec![KeyValue::new(
-            "service.name",
-            "log-appender-tracing-example",
-        )]))
+        .with_resource(
+            Resource::builder()
+                .with_service_name("log-appender-tracing-example")
+                .build(),
+        )
         .with_simple_exporter(exporter)
         .build();
     let layer = layer::OpenTelemetryTracingBridge::new(&provider);

examples/metrics-advanced/src/main.rs

@@ -50,12 +50,14 @@ fn init_meter_provider() -> opentelemetry_sdk::metrics::SdkMeterProvider {
         .build();
 
     let reader = PeriodicReader::builder(exporter).build();
+
+    let resource = Resource::builder()
+        .with_service_name("metrics-advanced-example")
+        .build();
+
     let provider = SdkMeterProvider::builder()
         .with_reader(reader)
-        .with_resource(Resource::new([KeyValue::new(
-            "service.name",
-            "metrics-advanced-example",
-        )]))
+        .with_resource(resource)
         .with_view(my_view_rename_and_unit)
         .with_view(my_view_drop_attributes)
         .with_view(my_view_change_aggregation)

examples/metrics-basic/src/main.rs

@@ -12,10 +12,11 @@ fn init_meter_provider() -> opentelemetry_sdk::metrics::SdkMeterProvider {
     let reader = PeriodicReader::builder(exporter).build();
     let provider = SdkMeterProvider::builder()
         .with_reader(reader)
-        .with_resource(Resource::new([KeyValue::new(
-            "service.name",
-            "metrics-basic-example",
-        )]))
+        .with_resource(
+            Resource::builder()
+                .with_service_name("metrics-basic-example")
+                .build(),
+        )
         .build();
     global::set_meter_provider(provider.clone());
     provider

examples/tracing-jaeger/src/main.rs

@@ -5,7 +5,6 @@ use opentelemetry::{
 };
 use opentelemetry_sdk::trace::TracerProvider;
 use opentelemetry_sdk::{runtime, Resource};
-use opentelemetry_semantic_conventions::resource::SERVICE_NAME;
 
 use std::error::Error;
 
@@ -16,10 +15,11 @@ fn init_tracer_provider() -> Result<opentelemetry_sdk::trace::TracerProvider, Tr
 
     Ok(TracerProvider::builder()
         .with_batch_exporter(exporter, runtime::Tokio)
-        .with_resource(Resource::new(vec![KeyValue::new(
-            SERVICE_NAME,
-            "tracing-jaeger",
-        )]))
+        .with_resource(
+            Resource::builder()
+                .with_service_name("tracing-jaeger")
+                .build(),
+        )
         .build())
 }
 

opentelemetry-appender-tracing/benches/logs.rs

@@ -15,7 +15,7 @@
 
 use async_trait::async_trait;
 use criterion::{criterion_group, criterion_main, Criterion};
-use opentelemetry::{InstrumentationScope, KeyValue};
+use opentelemetry::InstrumentationScope;
 use opentelemetry_appender_tracing::layer as tracing_layer;
 use opentelemetry_sdk::export::logs::{LogBatch, LogExporter};
 use opentelemetry_sdk::logs::LogResult;
@@ -126,10 +126,11 @@ fn benchmark_with_ot_layer(c: &mut Criterion, enabled: bool, bench_name: &str) {
     let exporter = NoopExporter { enabled };
     let processor = NoopProcessor::new(Box::new(exporter));
     let provider = LoggerProvider::builder()
-        .with_resource(Resource::new(vec![KeyValue::new(
-            "service.name",
-            "benchmark",
-        )]))
+        .with_resource(
+            Resource::builder_empty()
+                .with_service_name("benchmark")
+                .build(),
+        )
         .with_log_processor(processor)
         .build();
     let ot_layer = tracing_layer::OpenTelemetryTracingBridge::new(&provider);

opentelemetry-appender-tracing/examples/basic.rs

@@ -1,6 +1,5 @@
 //! run with `$ cargo run --example basic
 
-use opentelemetry::KeyValue;
 use opentelemetry_appender_tracing::layer;
 use opentelemetry_sdk::{logs::LoggerProvider, Resource};
 use tracing::error;
@@ -9,10 +8,11 @@ use tracing_subscriber::prelude::*;
 fn main() {
     let exporter = opentelemetry_stdout::LogExporter::default();
     let provider: LoggerProvider = LoggerProvider::builder()
-        .with_resource(Resource::new(vec![KeyValue::new(
-            "service.name",
-            "log-appender-tracing-example",
-        )]))
+        .with_resource(
+            Resource::builder()
+                .with_service_name("log-appender-tracing-example")
+                .build(),
+        )
         .with_simple_exporter(exporter)
         .build();
     let layer = layer::OpenTelemetryTracingBridge::new(&provider);

opentelemetry-otlp/examples/basic-otlp-http/src/main.rs

@@ -24,10 +24,9 @@ use tracing_subscriber::prelude::*;
 use tracing_subscriber::EnvFilter;
 
 static RESOURCE: Lazy<Resource> = Lazy::new(|| {
-    Resource::new(vec![KeyValue::new(
-        opentelemetry_semantic_conventions::resource::SERVICE_NAME,
-        "basic-otlp-example",
-    )])
+    Resource::builder()
+        .with_service_name("basic-otlp-example")
+        .build()
 });
 
 fn init_logs() -> Result<sdklogs::LoggerProvider, opentelemetry_sdk::logs::LogError> {

opentelemetry-otlp/examples/basic-otlp/src/main.rs

@@ -15,10 +15,9 @@ use tracing_subscriber::prelude::*;
 use tracing_subscriber::EnvFilter;
 
 static RESOURCE: Lazy<Resource> = Lazy::new(|| {
-    Resource::new(vec![KeyValue::new(
-        opentelemetry_semantic_conventions::resource::SERVICE_NAME,
-        "basic-otlp-example",
-    )])
+    Resource::builder()
+        .with_service_name("basic-otlp-example")
+        .build()
 });
 
 fn init_traces() -> Result<sdktrace::TracerProvider, TraceError> {

opentelemetry-otlp/src/lib.rs

@@ -162,7 +162,7 @@
 //!                 .with_max_events_per_span(64)
 //!                 .with_max_attributes_per_span(16)
 //!                 .with_max_events_per_span(16)
-//!                 .with_resource(Resource::new(vec![KeyValue::new("service.name", "example")])),
+//!                 .with_resource(Resource::builder_empty().with_attributes(vec![KeyValue::new("service.name", "example")]).build()),
 //!         ).build();
 //!     global::set_tracer_provider(tracer_provider);
 //!     let tracer = global::tracer("tracer-name");
@@ -186,7 +186,7 @@
 //!
 //!    let provider = opentelemetry_sdk::metrics::SdkMeterProvider::builder()
 //!        .with_reader(reader)
-//!         .with_resource(Resource::new(vec![KeyValue::new("service.name", "example")]))
+//!         .with_resource(Resource::builder_empty().with_attributes(vec![KeyValue::new("service.name", "example")]).build())
 //!         .build();
 //!     # }
 //!

opentelemetry-otlp/tests/integration_test/tests/logs.rs

@@ -2,7 +2,6 @@
 
 use integration_test_runner::logs_asserter::{read_logs_from_json, LogsAsserter};
 use log::{info, Level};
-use opentelemetry::KeyValue;
 use opentelemetry_appender_log::OpenTelemetryLogBridge;
 use opentelemetry_otlp::LogExporter;
 use opentelemetry_sdk::logs::{LogError, LoggerProvider};
@@ -27,10 +26,11 @@ fn init_logs() -> Result<sdklogs::LoggerProvider, LogError> {
 
     Ok(LoggerProvider::builder()
         .with_batch_exporter(exporter, runtime::Tokio)
-        .with_resource(Resource::new(vec![KeyValue::new(
-            opentelemetry_semantic_conventions::resource::SERVICE_NAME,
-            "logs-integration-test",
-        )]))
+        .with_resource(
+            Resource::builder_empty()
+                .with_service_name("logs-integration-test")
+                .build(),
+        )
         .build())
 }
 

opentelemetry-otlp/tests/integration_test/tests/traces.rs

@@ -32,10 +32,11 @@ fn init_tracer_provider() -> Result<sdktrace::TracerProvider, TraceError> {
 
     Ok(opentelemetry_sdk::trace::TracerProvider::builder()
         .with_batch_exporter(exporter, runtime::Tokio)
-        .with_resource(Resource::new(vec![KeyValue::new(
-            opentelemetry_semantic_conventions::resource::SERVICE_NAME,
-            "basic-otlp-tracing-example",
-        )]))
+        .with_resource(
+            Resource::builder_empty()
+                .with_service_name("basic-otlp-tracing-example")
+                .build(),
+        )
         .build())
 }
 

opentelemetry-proto/src/transform/logs.rs

@@ -252,7 +252,7 @@ mod tests {
 
     #[test]
     fn test_group_logs_by_resource_and_scope_single_scope() {
-        let resource = Resource::default();
+        let resource = Resource::builder().build();
         let (log_record1, instrum_lib1) = create_test_log_data("test-lib", "Log 1");
         let (log_record2, instrum_lib2) = create_test_log_data("test-lib", "Log 2");
 
@@ -273,7 +273,7 @@ mod tests {
 
     #[test]
     fn test_group_logs_by_resource_and_scope_multiple_scopes() {
-        let resource = Resource::default();
+        let resource = Resource::builder().build();
         let (log_record1, instrum_lib1) = create_test_log_data("lib1", "Log 1");
         let (log_record2, instrum_lib2) = create_test_log_data("lib2", "Log 2");
 

opentelemetry-proto/src/transform/trace.rs

@@ -231,7 +231,9 @@ mod tests {
 
     #[test]
     fn test_group_spans_by_resource_and_scope_single_scope() {
-        let resource = Resource::new(vec![KeyValue::new("resource_key", "resource_value")]);
+        let resource = Resource::builder_empty()
+            .with_attribute(KeyValue::new("resource_key", "resource_value"))
+            .build();
         let span_data = create_test_span_data("lib1");
 
         let spans = vec![span_data.clone()];
@@ -276,7 +278,9 @@ mod tests {
 
     #[test]
     fn test_group_spans_by_resource_and_scope_multiple_scopes() {
-        let resource = Resource::new(vec![KeyValue::new("resource_key", "resource_value")]);
+        let resource = Resource::builder_empty()
+            .with_attribute(KeyValue::new("resource_key", "resource_value"))
+            .build();
         let span_data1 = create_test_span_data("lib1");
         let span_data2 = create_test_span_data("lib1");
         let span_data3 = create_test_span_data("lib2");

opentelemetry-sdk/CHANGELOG.md

@@ -14,7 +14,22 @@
     [#2338](https://github.com/open-telemetry/opentelemetry-rust/pull/2338)
   - `ResourceDetector.detect()` no longer supports timeout option.
   - `opentelemetry::global::shutdown_tracer_provider()` Removed from the API, should now use `tracer_provider.shutdown()` see [#2369](https://github.com/open-telemetry/opentelemetry-rust/pull/2369) for a migration example. "Tracer provider" is cheaply cloneable, so users are encouraged to set a clone of it as the global (ex: `global::set_tracer_provider(provider.clone()))`, so that instrumentations and other components can obtain tracers from `global::tracer()`. The tracer_provider must be kept around to call shutdown on it at the end of application (ex: `tracer_provider.shutdown()`)
-
+- *Feature*: Add `ResourceBuilder` for an easy way to create new `Resource`s
+- *Breaking*: Remove `Resource::{new,empty,from_detectors,new_with_defaults,from_schema_url,merge,default}` from public api. To create Resources you should only use `Resource::builder()` or `Resource::builder_empty()`. See [#2322](https://github.com/open-telemetry/opentelemetry-rust/pull/2322) for a migration guide.
+  Example Usage:
+  ```rust
+  // old
+  Resource::default().with_attributes([
+      KeyValue::new("service.name", "test_service"),
+      KeyValue::new("key", "value"),
+  ]);
+
+  // new
+  Resource::builder()
+      .with_service_name("test_service")
+      .with_attribute(KeyValue::new("key", "value"))
+      .build();
+  ```
 - *Breaking* The LogExporter::export() method no longer requires a mutable reference to self.:
   Before:
      async fn export(&mut self, _batch: LogBatch<'_>) -> LogResult<()>

opentelemetry-sdk/benches/metric.rs

@@ -241,7 +241,7 @@ fn counters(c: &mut Criterion) {
 
     let (rdr, cntr) = bench_counter(None, "cumulative");
     let mut rm = ResourceMetrics {
-        resource: Resource::empty(),
+        resource: Resource::builder_empty().build(),
         scope_metrics: Vec::new(),
     };
 
@@ -338,7 +338,7 @@ fn benchmark_collect_histogram(b: &mut Bencher, n: usize) {
     }
 
     let mut rm = ResourceMetrics {
-        resource: Resource::empty(),
+        resource: Resource::builder_empty().build(),
         scope_metrics: Vec::new(),
     };
 

opentelemetry-sdk/src/logs/log_emitter.rs

@@ -221,7 +221,7 @@ impl Builder {
 
     /// Create a new provider from this configuration.
     pub fn build(self) -> LoggerProvider {
-        let resource = self.resource.unwrap_or_default();
+        let resource = self.resource.unwrap_or(Resource::builder().build());
 
         let logger_provider = LoggerProvider {
             inner: Arc::new(LoggerProviderInner {
@@ -413,10 +413,11 @@ mod tests {
 
         // If user provided a resource, use that.
         let custom_config_provider = super::LoggerProvider::builder()
-            .with_resource(Resource::new(vec![KeyValue::new(
-                SERVICE_NAME,
-                "test_service",
-            )]))
+            .with_resource(
+                Resource::builder_empty()
+                    .with_service_name("test_service")
+                    .build(),
+            )
             .build();
         assert_resource(&custom_config_provider, SERVICE_NAME, Some("test_service"));
         assert_eq!(custom_config_provider.resource().len(), 1);
@@ -445,10 +446,14 @@ mod tests {
             Some("my-custom-key=env-val,k2=value2"),
             || {
                 let user_provided_resource_config_provider = super::LoggerProvider::builder()
-                    .with_resource(Resource::default().merge(&mut Resource::new(vec![
-                        KeyValue::new("my-custom-key", "my-custom-value"),
-                        KeyValue::new("my-custom-key2", "my-custom-value2"),
-                    ])))
+                    .with_resource(
+                        Resource::builder()
+                            .with_attributes(vec![
+                                KeyValue::new("my-custom-key", "my-custom-value"),
+                                KeyValue::new("my-custom-key2", "my-custom-value2"),
+                            ])
+                            .build(),
+                    )
                     .build();
                 assert_resource(
                     &user_provided_resource_config_provider,

opentelemetry-sdk/src/logs/log_processor.rs

@@ -767,13 +767,17 @@ mod tests {
         let processor = SimpleLogProcessor::new(exporter.clone());
         let _ = LoggerProvider::builder()
             .with_log_processor(processor)
-            .with_resource(Resource::new(vec![
-                KeyValue::new("k1", "v1"),
-                KeyValue::new("k2", "v3"),
-                KeyValue::new("k3", "v3"),
-                KeyValue::new("k4", "v4"),
-                KeyValue::new("k5", "v5"),
-            ]))
+            .with_resource(
+                Resource::builder_empty()
+                    .with_attributes(vec![
+                        KeyValue::new("k1", "v1"),
+                        KeyValue::new("k2", "v3"),
+                        KeyValue::new("k3", "v3"),
+                        KeyValue::new("k4", "v4"),
+                        KeyValue::new("k5", "v5"),
+                    ])
+                    .build(),
+            )
             .build();
         assert_eq!(exporter.get_resource().unwrap().into_iter().count(), 5);
     }
@@ -790,13 +794,17 @@ mod tests {
         );
         let provider = LoggerProvider::builder()
             .with_log_processor(processor)
-            .with_resource(Resource::new(vec![
-                KeyValue::new("k1", "v1"),
-                KeyValue::new("k2", "v3"),
-                KeyValue::new("k3", "v3"),
-                KeyValue::new("k4", "v4"),
-                KeyValue::new("k5", "v5"),
-            ]))
+            .with_resource(
+                Resource::builder_empty()
+                    .with_attributes(vec![
+                        KeyValue::new("k1", "v1"),
+                        KeyValue::new("k2", "v3"),
+                        KeyValue::new("k3", "v3"),
+                        KeyValue::new("k4", "v4"),
+                        KeyValue::new("k5", "v5"),
+                    ])
+                    .build(),
+            )
             .build();
         tokio::time::sleep(Duration::from_secs(2)).await; // set resource in batch span processor is not blocking. Should we make it blocking?
         assert_eq!(exporter.get_resource().unwrap().into_iter().count(), 5);