Updated changelog for August release (#2842)

* Updated changelog for August release

* Update sdk/core/azure_core/CHANGELOG.md

Co-authored-by: Copilot <[email protected]>

* Added distributed tracing to ci.yml; removed noise from opentelemetry readme file.

---------

Co-authored-by: Copilot <[email protected]>

Author: LarryOsterman

Cargo.toml

@@ -54,6 +54,9 @@ path = "sdk/core/azure_core"
 version = "0.1.0"
 path = "sdk/core/azure_core_macros"
 
+[workspace.dependencies.azure_core_opentelemetry]
+version = "0.1.0"
+path = "sdk/core/azure_core_opentelemetry"
 
 [workspace.dependencies.azure_core_amqp]
 version = "0.6.0"
@@ -93,6 +96,9 @@ hmac = { version = "0.12" }
 litemap = "0.7.4"
 log = "0.4"
 openssl = { version = "0.10.72" }
+opentelemetry = { version = "0.30", features = ["trace"] }
+opentelemetry_sdk = "0.30"
+opentelemetry-http = "0.30"
 pin-project = "1.0"
 proc-macro2 = "1.0.86"
 quick-xml = { version = "0.31", features = ["serialize", "serde-types"] }

sdk/core/azure_core/CHANGELOG.md

@@ -4,6 +4,8 @@
 
 ### Features Added
 
+- Added support for distributed tracing macros in Azure service clients, including convenience macros `#[tracing::new]`, `#[tracing::client]` and `#[tracing::function]` to reduce implementation details. See [distributed tracing in rust](https://github.com/Azure/azure-sdk-for-rust/blob/main/doc/distributed-tracing-for-rust-service-clients.md) for more information on distributed tracing.
+
 ### Breaking Changes
 
 - `Pager::from_callback` and `PageIterator::from_callback` define a parameter of type `PagerState<C>` instead of `Option<C>`, where `None` => `Initial` and `Some(C)` => `More(C)`.

sdk/core/azure_core_opentelemetry/Cargo.toml

@@ -10,15 +10,15 @@ homepage = "https://github.com/azure/azure-sdk-for-rust"
 documentation = "https://docs.rs/azure_core_tracing_opentelemetry"
 keywords = ["sdk", "azure", "tracing", "opentelemetry", "observability"]
 categories = ["api-bindings", "development-tools::debugging"]
-publish = false
+publish = true
 
 edition.workspace = true
 
 [dependencies]
 azure_core.workspace = true
-opentelemetry = { version = "0.30", features = ["trace"] }
-opentelemetry-http = "0.30.0"
-opentelemetry_sdk = "0.30"
+opentelemetry.workspace = true
+opentelemetry-http.workspace = true
+opentelemetry_sdk.workspace = true
 reqwest.workspace = true
 tracing.workspace = true
 typespec_client_core.workspace = true

sdk/core/azure_core_opentelemetry/README.md

@@ -74,12 +74,6 @@ let options = ServiceClientOptions {
 
 Once the `OpenTelemetryTracerProvider` is integrated with the Azure Service ClientOptions, the Azure SDK will be configured to capture per-API and per-HTTP operation tracing options, and the HTTP requests will be annotated with [W3C Trace Context headers](https://www.w3.org/TR/trace-context/).
 
-## Troubleshooting
-
-## General
-
-## Logging
-
 ## Contributing
 
 See the [CONTRIBUTING.md] for details on building, testing, and contributing to these libraries.

sdk/core/azure_core_opentelemetry/assets.json

@@ -1,6 +1,6 @@
 {
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "rust",
-  "Tag": "rust/azure_core_opentelemetry_58be03e82f",
+  "Tag": "rust/azure_core_opentelemetry_2bc5efc404",
   "TagPrefix": "rust/azure_core_opentelemetry"
 }

sdk/core/azure_core_opentelemetry/tests/telemetry_service_implementation.rs

@@ -5,13 +5,11 @@
 
 //! This file contains an Azure SDK for Rust fake service client API.
 //!
+use azure_core::http::RequestInstrumentationOptions;
 use azure_core::{
     credentials::TokenCredential,
     fmt::SafeDebug,
-    http::{
-        ClientMethodOptions, ClientOptions, Pipeline, RawResponse, Request,
-        RequestInstrumentationOptions, Url,
-    },
+    http::{ClientMethodOptions, ClientOptions, Pipeline, RawResponse, Request, Url},
     tracing::{PublicApiInstrumentationInformation, Tracer},
     Result,
 };
@@ -239,9 +237,10 @@ async fn test_service_client_new(ctx: TestContext) -> Result<()> {
     let recording = ctx.recording();
     let endpoint = "https://www.microsoft.com";
     let credential = recording.credential().clone();
-    let options = TestServiceClientOptions {
+    let mut options = TestServiceClientOptions {
         ..Default::default()
     };
+    recording.instrument(&mut options.azure_client_options);
 
     let client = TestServiceClient::new(endpoint, credential, Some(options)).unwrap();
     assert_eq!(client.endpoint().as_str(), "https://www.microsoft.com/");
@@ -256,8 +255,10 @@ async fn test_service_client_get(ctx: TestContext) -> Result<()> {
     let recording = ctx.recording();
     let endpoint = "https://azuresdkforcpp.azurewebsites.net";
     let credential = recording.credential().clone();
+    let mut options = TestServiceClientOptions::default();
+    recording.instrument(&mut options.azure_client_options);
 
-    let client = TestServiceClient::new(endpoint, credential, None).unwrap();
+    let client = TestServiceClient::new(endpoint, credential, Some(options)).unwrap();
     let response = client.get("get", None).await;
     info!("Response: {:?}", response);
     assert!(response.is_ok());
@@ -274,7 +275,7 @@ async fn test_service_client_get_with_tracing(ctx: TestContext) -> Result<()> {
     let recording = ctx.recording();
     let endpoint = "https://azuresdkforcpp.azurewebsites.net";
     let credential = recording.credential().clone();
-    let options = TestServiceClientOptions {
+    let mut options = TestServiceClientOptions {
         azure_client_options: ClientOptions {
             request_instrumentation: Some(RequestInstrumentationOptions {
                 tracer_provider: Some(azure_provider),
@@ -283,6 +284,7 @@ async fn test_service_client_get_with_tracing(ctx: TestContext) -> Result<()> {
         },
         ..Default::default()
     };
+    recording.instrument(&mut options.azure_client_options);
 
     let client = TestServiceClient::new(endpoint, credential, Some(options)).unwrap();
     let response = client.get("get", None).await;
@@ -328,7 +330,7 @@ async fn test_service_client_get_tracing_error(ctx: TestContext) -> Result<()> {
     let recording = ctx.recording();
     let endpoint = "https://azuresdkforcpp.azurewebsites.net";
     let credential = recording.credential().clone();
-    let options = TestServiceClientOptions {
+    let mut options = TestServiceClientOptions {
         azure_client_options: ClientOptions {
             request_instrumentation: Some(RequestInstrumentationOptions {
                 tracer_provider: Some(azure_provider),
@@ -337,6 +339,7 @@ async fn test_service_client_get_tracing_error(ctx: TestContext) -> Result<()> {
         },
         ..Default::default()
     };
+    recording.instrument(&mut options.azure_client_options);
 
     let client = TestServiceClient::new(endpoint, credential, Some(options)).unwrap();
     let response = client.get("failing_url", None).await;
@@ -388,7 +391,7 @@ async fn test_service_client_get_with_function_tracing(ctx: TestContext) -> Resu
     let recording = ctx.recording();
     let endpoint = "https://azuresdkforcpp.azurewebsites.net";
     let credential = recording.credential().clone();
-    let options = TestServiceClientOptions {
+    let mut options = TestServiceClientOptions {
         azure_client_options: ClientOptions {
             request_instrumentation: Some(RequestInstrumentationOptions {
                 tracer_provider: Some(azure_provider),
@@ -397,6 +400,7 @@ async fn test_service_client_get_with_function_tracing(ctx: TestContext) -> Resu
         },
         ..Default::default()
     };
+    recording.instrument(&mut options.azure_client_options);
 
     let client = TestServiceClient::new(endpoint, credential, Some(options)).unwrap();
     let response = client.get_with_function_tracing("get", None).await;
@@ -450,7 +454,7 @@ async fn test_service_client_get_with_function_tracing_error(ctx: TestContext) -
     let recording = ctx.recording();
     let endpoint = "https://azuresdkforcpp.azurewebsites.net";
     let credential = recording.credential().clone();
-    let options = TestServiceClientOptions {
+    let mut options = TestServiceClientOptions {
         azure_client_options: ClientOptions {
             request_instrumentation: Some(RequestInstrumentationOptions {
                 tracer_provider: Some(azure_provider),
@@ -459,6 +463,7 @@ async fn test_service_client_get_with_function_tracing_error(ctx: TestContext) -
         },
         ..Default::default()
     };
+    recording.instrument(&mut options.azure_client_options);
 
     let client = TestServiceClient::new(endpoint, credential, Some(options)).unwrap();
     let response = client.get_with_function_tracing("failing_url", None).await;

sdk/core/azure_core_opentelemetry/tests/telemetry_service_macros.rs

@@ -193,13 +193,13 @@ mod tests {
     }
 
     fn create_service_client(
-        ctx: TestContext,
+        ctx: &TestContext,
         azure_provider: Arc<dyn TracerProvider>,
     ) -> TestServiceClientWithMacros {
         let recording = ctx.recording();
         let endpoint = "https://azuresdkforcpp.azurewebsites.net";
         let credential = recording.credential().clone();
-        let options = TestServiceClientWithMacrosOptions {
+        let mut options = TestServiceClientWithMacrosOptions {
             client_options: ClientOptions {
                 request_instrumentation: Some(RequestInstrumentationOptions {
                     tracer_provider: Some(azure_provider),
@@ -208,6 +208,7 @@ mod tests {
             },
             ..Default::default()
         };
+        recording.instrument(&mut options.client_options);
 
         TestServiceClientWithMacros::new(endpoint, credential, Some(options)).unwrap()
     }
@@ -268,9 +269,10 @@ mod tests {
         let recording = ctx.recording();
         let endpoint = "https://microsoft.com";
         let credential = recording.credential().clone();
-        let options = TestServiceClientWithMacrosOptions {
+        let mut options = TestServiceClientWithMacrosOptions {
             ..Default::default()
         };
+        recording.instrument(&mut options.client_options);
 
         let client = TestServiceClientWithMacros::new(endpoint, credential, Some(options)).unwrap();
         assert_eq!(client.endpoint().as_str(), "https://microsoft.com/");
@@ -280,11 +282,11 @@ mod tests {
     }
 
     #[recorded::test()]
-    async fn test_macro_service_client_get(ctx: TestContext) -> Result<()> {
+    async fn test_macro_service_client_get_simple(ctx: TestContext) -> Result<()> {
         let (sdk_provider, otel_exporter) = create_exportable_tracer_provider();
         let azure_provider = OpenTelemetryTracerProvider::new(sdk_provider);
 
-        let client = create_service_client(ctx, azure_provider.clone());
+        let client = create_service_client(&ctx, azure_provider.clone());
 
         let response = client.get("get", None).await;
         info!("Response: {:?}", response);
@@ -327,7 +329,7 @@ mod tests {
         let (sdk_provider, otel_exporter) = create_exportable_tracer_provider();
         let azure_provider = OpenTelemetryTracerProvider::new(sdk_provider);
 
-        let client = create_service_client(ctx, azure_provider.clone());
+        let client = create_service_client(&ctx, azure_provider.clone());
 
         let response = client.get("failing_url", None).await;
         info!("Response: {:?}", response);
@@ -375,7 +377,7 @@ mod tests {
         let (sdk_provider, otel_exporter) = create_exportable_tracer_provider();
         let azure_provider = OpenTelemetryTracerProvider::new(sdk_provider);
 
-        let client = create_service_client(ctx, azure_provider.clone());
+        let client = create_service_client(&ctx, azure_provider.clone());
 
         let response = client.get_with_function_tracing("get", None).await;
         info!("Response: {:?}", response);
@@ -430,20 +432,8 @@ mod tests {
         let (sdk_provider, otel_exporter) = create_exportable_tracer_provider();
         let azure_provider = OpenTelemetryTracerProvider::new(sdk_provider);
 
-        let recording = ctx.recording();
-        let endpoint = "https://azuresdkforcpp.azurewebsites.net";
-        let credential = recording.credential().clone();
-        let options = TestServiceClientWithMacrosOptions {
-            client_options: ClientOptions {
-                request_instrumentation: Some(RequestInstrumentationOptions {
-                    tracer_provider: Some(azure_provider),
-                }),
-                ..Default::default()
-            },
-            ..Default::default()
-        };
+        let client = create_service_client(&ctx, azure_provider.clone());
 
-        let client = TestServiceClientWithMacros::new(endpoint, credential, Some(options)).unwrap();
         let response = client.get_with_function_tracing("failing_url", None).await;
         info!("Response: {:?}", response);
 

sdk/core/ci.yml

@@ -17,5 +17,9 @@ extends:
     Artifacts:
     - name: azure_core
       safeName: AzureCore
+    - name: azure_core_macros
+      safeName: AzureCoreMacros
     - name: azure_core_amqp
       safeName: AzureCoreAmqp
+    - name: azure_core_opentelemetry
+      safeName: AzureCoreOpentelemetry

sdk/typespec/CHANGELOG.md

@@ -6,6 +6,8 @@
 
 ### Breaking Changes
 
+- `http::Request::method()` returns a copy of the underlying `Method` rather than a reference to the underlying `Method`.
+
 ### Bugs Fixed
 
 ### Other Changes