refactor: rename to actix-web-opentelemetry to opentelemetry-instrumentation-actix-web (#240)

gruebel · web-flow · commit 6395c158eb44 · 2025-04-06T12:58:46.000-07:00
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,11 +1,11 @@
 [workspace]
 members = [
-    "actix-web-opentelemetry",
     "opentelemetry-aws",
     "opentelemetry-contrib",
     "opentelemetry-datadog",
     "opentelemetry-etw-logs",
     "opentelemetry-etw-metrics",
+    "opentelemetry-instrumentation-actix-web",
     "opentelemetry-resource-detectors",
     "opentelemetry-stackdriver",
     "opentelemetry-user-events-logs",
diff --git a/deny.toml b/deny.toml
@@ -1,6 +1,6 @@
 [graph]
 exclude=[
-    "protobuf" # actix-web-opentelemetry depends on prometheus should try to remove it
+    "protobuf" # opentelemetry-instrumentation-actix-web depends on prometheus should try to remove it
 ]
 
 [licenses]
diff --git a/opentelemetry-instrumentation-actix-web/CHANGELOG.md b/opentelemetry-instrumentation-actix-web/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## vNext
+
+### Changed
+
+* **Breaking** Rename crate to `opentelemetry-instrumentation-actix-web`
+
 ## [v0.22.0](https://github.com/OutThereLabs/actix-web-opentelemetry/compare/v0.22.0..v0.21.0)
 
 ### Changed
diff --git a/opentelemetry-instrumentation-actix-web/Cargo.toml b/opentelemetry-instrumentation-actix-web/Cargo.toml
@@ -1,12 +1,12 @@
 [package]
-name = "actix-web-opentelemetry"
+name = "opentelemetry-instrumentation-actix-web"
 version = "0.22.0"
-description = "Deprecated: 0.22.0 is the last release for this crate. Use opentelemetry-instrumentation-actix-web instead"
+description = "OpenTelemetry instrumentation for Actix Web apps"
 homepage = "https://github.com/open-telemetry/opentelemetry-rust-contrib/tree/main/actix-web-opentelemetry"
 repository = "https://github.com/open-telemetry/opentelemetry-rust-contrib/tree/main/actix-web-opentelemetry"
 readme = "README.md"
 categories = ["api-bindings"]
-keywords = ["actix", "actix-web", "opentelemetry", "jaeger", "prometheus"]
+keywords = ["actix", "actix-web", "opentelemetry", "prometheus"]
 license = "Apache-2.0"
 edition = "2021"
 rust-version = "1.75.0"
@@ -50,7 +50,7 @@ tracing = { version = "0.1.41", optional = true }
 
 [dev-dependencies]
 actix-web = { version = "4.0", features = ["macros"] }
-actix-web-opentelemetry = { path = ".", features = [
+opentelemetry-instrumentation-actix-web = { path = ".", features = [
   "metrics-prometheus",
   "sync-middleware",
   "awc",
diff --git a/opentelemetry-instrumentation-actix-web/LICENSE b/opentelemetry-instrumentation-actix-web/LICENSE
diff --git a/opentelemetry-instrumentation-actix-web/README.md b/opentelemetry-instrumentation-actix-web/README.md
@@ -1,12 +1,17 @@
-# Actix Web OpenTelemetry
+# OpenTelemetry Actix Web Instrumentation
+
+![OpenTelemetry — An observability framework for cloud-native software.][splash]
+
+[splash]: https://raw.githubusercontent.com/open-telemetry/opentelemetry-rust/main/assets/logo-text.png
+
+[OpenTelemetry](https://opentelemetry.io/) instrumentation for [Actix Web](https://actix.rs/).
 
 [![Crates.io: actix-web-opentelemetry](https://img.shields.io/crates/v/actix-web-opentelemetry.svg)](https://crates.io/crates/actix-web-opentelemetry)
 [![Documentation](https://docs.rs/actix-web-opentelemetry/badge.svg)](https://docs.rs/actix-web-opentelemetry)
 [![LICENSE](https://img.shields.io/crates/l/actix-web-opentelemetry)](./LICENSE)
+[![GitHub Actions CI](https://github.com/open-telemetry/opentelemetry-rust-contrib/workflows/CI/badge.svg)](https://github.com/open-telemetry/opentelemetry-rust-contrib/actions?query=workflow%3ACI+branch%3Amain)
 [![Slack](https://img.shields.io/badge/slack-@cncf/otel/rust-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C03GDP0H023)
 
-[OpenTelemetry](https://opentelemetry.io/) integration for [Actix Web](https://actix.rs/).
-
 ### Exporter configuration
 
 [`actix-web`] uses [`tokio`] as the underlying executor, so exporters should be
@@ -20,7 +25,7 @@ opentelemetry-jaeger = { version = "..", features = ["rt-tokio-current-thread"]
 # if exporting to zipkin, use the `tokio` based `reqwest-client` feature.
 opentelemetry-zipkin = { version = "..", features = ["reqwest-client"], default-features = false }
 
-# ... ensure the same same for any other exporters
+# ... ensure the same for any other exporters
 ```
 
 [`actix-web`]: https://crates.io/crates/actix-web
@@ -41,7 +46,7 @@ $ cargo run --example client --features awc
 $ firefox http://localhost:16686/
 ```
 
-![Jaeger UI](actix-web-opentelemetry/trace.png)
+![Jaeger UI](opentelemetry-instrumentation-actix-web/trace.png)
 
 ### Features
 
diff --git a/opentelemetry-instrumentation-actix-web/examples/client.rs b/opentelemetry-instrumentation-actix-web/examples/client.rs
@@ -1,5 +1,5 @@
-use actix_web_opentelemetry::ClientExt;
 use opentelemetry::{global, KeyValue};
+use opentelemetry_instrumentation_actix_web::ClientExt;
 use opentelemetry_sdk::propagation::TraceContextPropagator;
 use opentelemetry_sdk::trace::SdkTracerProvider;
 use opentelemetry_sdk::Resource;
diff --git a/opentelemetry-instrumentation-actix-web/examples/server.rs b/opentelemetry-instrumentation-actix-web/examples/server.rs
@@ -1,6 +1,8 @@
 use actix_web::{web, App, HttpRequest, HttpServer};
-use actix_web_opentelemetry::{PrometheusMetricsHandler, RequestMetrics, RequestTracing};
 use opentelemetry::{global, KeyValue};
+use opentelemetry_instrumentation_actix_web::{
+    PrometheusMetricsHandler, RequestMetrics, RequestTracing,
+};
 use opentelemetry_otlp::WithExportConfig;
 use opentelemetry_sdk::{
     metrics::{Aggregation, Instrument, SdkMeterProvider, Stream},
diff --git a/opentelemetry-instrumentation-actix-web/src/client.rs b/opentelemetry-instrumentation-actix-web/src/client.rs
@@ -72,8 +72,8 @@ pub trait ClientExt {
     ///
     /// Example:
     /// ```no_run
-    /// use actix_web_opentelemetry::ClientExt;
     /// use awc::{Client, error::SendRequestError};
+    /// use opentelemetry_instrumentation_actix_web::ClientExt;
     ///
     /// async fn execute_request(client: &Client) -> Result<(), SendRequestError> {
     ///     let res = client.get("http://localhost:8080")
@@ -97,9 +97,9 @@ pub trait ClientExt {
     ///
     /// Example:
     /// ```no_run
-    /// use actix_web_opentelemetry::ClientExt;
     /// use awc::{Client, error::SendRequestError};
     /// use opentelemetry::Context;
+    /// use opentelemetry_instrumentation_actix_web::ClientExt;
     ///
     /// async fn execute_request(client: &Client) -> Result<(), SendRequestError> {
     ///     let res = client.get("http://localhost:8080")
@@ -243,9 +243,9 @@ impl InstrumentedClientRequest {
     ///
     /// Example:
     /// ```
-    /// use actix_web_opentelemetry::ClientExt;
     /// use awc::{Client, error::SendRequestError};
     /// use opentelemetry::KeyValue;
+    /// use opentelemetry_instrumentation_actix_web::ClientExt;
     ///
     /// async fn execute_request(client: &Client) -> Result<(), SendRequestError> {
     ///     let attrs = [KeyValue::new("dye-key", "dye-value")];
@@ -272,8 +272,8 @@ impl InstrumentedClientRequest {
     ///
     /// Example:
     /// ```
-    /// use actix_web_opentelemetry::ClientExt;
     /// use awc::{Client, error::SendRequestError};
+    /// use opentelemetry_instrumentation_actix_web::ClientExt;
     ///
     /// async fn execute_request(client: &Client) -> Result<(), SendRequestError> {
     ///     let res = client.get("http://localhost:8080")
diff --git a/opentelemetry-instrumentation-actix-web/src/lib.rs b/opentelemetry-instrumentation-actix-web/src/lib.rs
@@ -1,4 +1,4 @@
-//! [OpenTelemetry] integration for [Actix Web].
+//! [OpenTelemetry] instrumentation for [Actix Web].
 //!
 //! This crate allows you to easily instrument client and server requests.
 //!
@@ -25,7 +25,7 @@
 //! # #[cfg(feature="awc")]
 //! # {
 //! use awc::{Client, error::SendRequestError};
-//! use actix_web_opentelemetry::ClientExt;
+//! use opentelemetry_instrumentation_actix_web::ClientExt;
 //!
 //! async fn execute_request(client: &Client) -> Result<(), SendRequestError> {
 //!     let res = client
@@ -49,8 +49,8 @@
 //!
 //! ```no_run
 //! use actix_web::{web, App, HttpServer};
-//! use actix_web_opentelemetry::RequestTracing;
 //! use opentelemetry::global;
+//! use opentelemetry_instrumentation_actix_web::RequestTracing;
 //! use opentelemetry_sdk::trace::SdkTracerProvider;
 //!
 //! async fn index() -> &'static str {
@@ -86,9 +86,9 @@
 //!
 //! ```no_run
 //! use actix_web::{dev, http, web, App, HttpRequest, HttpServer};
-//! # #[cfg(feature = "metrics-prometheus")]
-//! use actix_web_opentelemetry::{PrometheusMetricsHandler, RequestMetrics, RequestTracing};
 //! use opentelemetry::global;
+//! # #[cfg(feature = "metrics-prometheus")]
+//! use opentelemetry_instrumentation_actix_web::{PrometheusMetricsHandler, RequestMetrics, RequestTracing};
 //! use opentelemetry_sdk::metrics::SdkMeterProvider;
 //!
 //! # #[cfg(feature = "metrics-prometheus")]
diff --git a/opentelemetry-instrumentation-actix-web/src/middleware/metrics.rs b/opentelemetry-instrumentation-actix-web/src/middleware/metrics.rs
@@ -139,8 +139,8 @@ impl RequestMetricsBuilder {
 ///
 /// ```no_run
 /// use actix_web::{dev, http, web, App, HttpRequest, HttpServer};
-/// use actix_web_opentelemetry::{PrometheusMetricsHandler, RequestMetrics, RequestTracing};
 /// use opentelemetry::global;
+/// use opentelemetry_instrumentation_actix_web::{PrometheusMetricsHandler, RequestMetrics, RequestTracing};
 /// use opentelemetry_sdk::metrics::SdkMeterProvider;
 ///
 /// #[actix_web::main]
diff --git a/opentelemetry-instrumentation-actix-web/src/middleware/mod.rs b/opentelemetry-instrumentation-actix-web/src/middleware/mod.rs
@@ -7,7 +7,7 @@ pub(crate) mod route_formatter;
 pub(crate) mod trace;
 
 pub(crate) fn get_scope() -> InstrumentationScope {
-    InstrumentationScope::builder("actix-web-opentelemetry")
+    InstrumentationScope::builder("opentelemetry-instrumentation-actix-web")
         .with_version(env!("CARGO_PKG_VERSION"))
         .with_schema_url(opentelemetry_semantic_conventions::SCHEMA_URL)
         .build()
diff --git a/opentelemetry-instrumentation-actix-web/src/middleware/route_formatter.rs b/opentelemetry-instrumentation-actix-web/src/middleware/route_formatter.rs
@@ -13,7 +13,7 @@
 /// # Custom Formatter Examples
 ///
 /// ```
-/// use actix_web_opentelemetry::RouteFormatter;
+/// use opentelemetry_instrumentation_actix_web::RouteFormatter;
 ///
 /// // A formatter to ensure all paths are reported as lowercase.
 /// #[derive(Debug)]
diff --git a/opentelemetry-instrumentation-actix-web/src/middleware/trace.rs b/opentelemetry-instrumentation-actix-web/src/middleware/trace.rs
@@ -23,8 +23,8 @@ use crate::util::trace_attributes_from_request;
 ///
 /// ```no_run
 /// use actix_web::{web, App, HttpServer};
-/// use actix_web_opentelemetry::RequestTracing;
 /// use opentelemetry::global;
+/// use opentelemetry_instrumentation_actix_web::RequestTracing;
 /// use opentelemetry_sdk::trace::SdkTracerProvider;
 ///
 /// async fn index() -> &'static str {
@@ -72,7 +72,7 @@ impl RequestTracing {
     ///
     /// ```no_run
     /// use actix_web::{web, App, HttpServer};
-    /// use actix_web_opentelemetry::{RouteFormatter, RequestTracing};
+    /// use opentelemetry_instrumentation_actix_web::{RouteFormatter, RequestTracing};
     ///
     /// # #[actix_web::main]
     /// # async fn main() -> std::io::Result<()> {
diff --git a/opentelemetry-instrumentation-actix-web/src/util.rs b/opentelemetry-instrumentation-actix-web/src/util.rs
diff --git a/opentelemetry-instrumentation-actix-web/trace.png b/opentelemetry-instrumentation-actix-web/trace.png
diff --git a/scripts/publish.sh b/scripts/publish.sh
@@ -1,12 +1,12 @@
 #!/bin/bash
 
 packages=(
-    "actix-web-opentelemetry"
     "opentelemetry-aws"
     "opentelemetry-contrib"
     "opentelemetry-datadog"
     "opentelemetry-etw-logs"
-    "opentelemetry-etw-metrics"    
+    "opentelemetry-etw-metrics"
+    "opentelemetry-instrumentation-actix-web"
     "opentelemetry-resource-detectors"
     "opentelemetry-stackdriver"
     "opentelemetry-user-events-logs"

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`[graph]`
`2`	`2`	`exclude=[`
`3`		`- "protobuf" # actix-web-opentelemetry depends on prometheus should try to remove it`
	`3`	`+ "protobuf" # opentelemetry-instrumentation-actix-web depends on prometheus should try to remove it`
`4`	`4`	`]`
`5`	`5`
`6`	`6`	`[licenses]`