Feature/convention http server duration (#2326)

Rodrigo-Novas · web-flow · commit 617cae937553 · 2024-03-18T17:29:10.000+02:00
* feat: add http.duration convention

* feat: add http.duration convention

* feat: replace for the last description version Duration of HTTP client requests

* feat: add new description to histogram
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,13 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
-### Fixed
 - `opentelemetry-instrumentation-celery` Allow Celery instrumentation to be installed multiple times
   ([#2342](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2342))
 - Align gRPC span status codes to OTEL specification
   ([#1756](https://github.com/open-telemetry/opentelemetry-python-contrib/issues/1756))
 - `opentelemetry-instrumentation-flask` Add importlib metadata default for deprecation warning flask version
   ([#2297](https://github.com/open-telemetry/opentelemetry-python-contrib/issues/2297))
+- Ensure all http.server.duration metrics have the same description
+  ([#2151](https://github.com/open-telemetry/opentelemetry-python-contrib/issues/2298))
 
 ## Version 1.23.0/0.44b0 (2024-02-23)
 
diff --git a/instrumentation/opentelemetry-instrumentation-aiohttp-server/src/opentelemetry/instrumentation/aiohttp_server/__init__.py b/instrumentation/opentelemetry-instrumentation-aiohttp-server/src/opentelemetry/instrumentation/aiohttp_server/__init__.py
@@ -207,7 +207,7 @@ async def middleware(request, handler):
     duration_histogram = meter.create_histogram(
         name=MetricInstruments.HTTP_SERVER_DURATION,
         unit="ms",
-        description="measures the duration of the inbound HTTP request",
+        description="Duration of HTTP client requests.",
     )
 
     active_requests_counter = meter.create_up_down_counter(
diff --git a/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py b/instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py
@@ -492,7 +492,7 @@ def __init__(
         self.duration_histogram = self.meter.create_histogram(
             name=MetricInstruments.HTTP_SERVER_DURATION,
             unit="ms",
-            description="measures the duration of the inbound HTTP request",
+            description="Duration of HTTP client requests.",
         )
         self.server_response_size_histogram = self.meter.create_histogram(
             name=MetricInstruments.HTTP_SERVER_RESPONSE_SIZE,
diff --git a/instrumentation/opentelemetry-instrumentation-django/src/opentelemetry/instrumentation/django/__init__.py b/instrumentation/opentelemetry-instrumentation-django/src/opentelemetry/instrumentation/django/__init__.py
@@ -322,7 +322,7 @@ def _instrument(self, **kwargs):
         _DjangoMiddleware._duration_histogram = meter.create_histogram(
             name=MetricInstruments.HTTP_SERVER_DURATION,
             unit="ms",
-            description="measures the duration of the inbound http request",
+            description="Duration of HTTP client requests.",
         )
         _DjangoMiddleware._active_request_counter = meter.create_up_down_counter(
             name=MetricInstruments.HTTP_SERVER_ACTIVE_REQUESTS,
diff --git a/instrumentation/opentelemetry-instrumentation-falcon/src/opentelemetry/instrumentation/falcon/__init__.py b/instrumentation/opentelemetry-instrumentation-falcon/src/opentelemetry/instrumentation/falcon/__init__.py
@@ -268,7 +268,7 @@ def __init__(self, *args, **kwargs):
         self.duration_histogram = self._otel_meter.create_histogram(
             name=MetricInstruments.HTTP_SERVER_DURATION,
             unit="ms",
-            description="measures the duration of the inbound HTTP request",
+            description="Duration of HTTP client requests.",
         )
         self.active_requests_counter = self._otel_meter.create_up_down_counter(
             name=MetricInstruments.HTTP_SERVER_ACTIVE_REQUESTS,
diff --git a/instrumentation/opentelemetry-instrumentation-flask/src/opentelemetry/instrumentation/flask/__init__.py b/instrumentation/opentelemetry-instrumentation-flask/src/opentelemetry/instrumentation/flask/__init__.py
@@ -506,7 +506,7 @@ def __init__(self, *args, **kwargs):
         duration_histogram = meter.create_histogram(
             name=MetricInstruments.HTTP_SERVER_DURATION,
             unit="ms",
-            description="measures the duration of the inbound HTTP request",
+            description="Duration of HTTP client requests.",
         )
         active_requests_counter = meter.create_up_down_counter(
             name=MetricInstruments.HTTP_SERVER_ACTIVE_REQUESTS,
@@ -612,7 +612,7 @@ def instrument_app(
             duration_histogram = meter.create_histogram(
                 name=MetricInstruments.HTTP_SERVER_DURATION,
                 unit="ms",
-                description="measures the duration of the inbound HTTP request",
+                description="Duration of HTTP client requests.",
             )
             active_requests_counter = meter.create_up_down_counter(
                 name=MetricInstruments.HTTP_SERVER_ACTIVE_REQUESTS,
diff --git a/instrumentation/opentelemetry-instrumentation-pyramid/src/opentelemetry/instrumentation/pyramid/callbacks.py b/instrumentation/opentelemetry-instrumentation-pyramid/src/opentelemetry/instrumentation/pyramid/callbacks.py
@@ -140,7 +140,7 @@ def trace_tween_factory(handler, registry):
     duration_histogram = meter.create_histogram(
         name=MetricInstruments.HTTP_SERVER_DURATION,
         unit="ms",
-        description="measures the duration of the inbound HTTP request",
+        description="Duration of HTTP client requests.",
     )
     active_requests_counter = meter.create_up_down_counter(
         name=MetricInstruments.HTTP_SERVER_ACTIVE_REQUESTS,
diff --git a/instrumentation/opentelemetry-instrumentation-tornado/src/opentelemetry/instrumentation/tornado/__init__.py b/instrumentation/opentelemetry-instrumentation-tornado/src/opentelemetry/instrumentation/tornado/__init__.py
@@ -296,7 +296,7 @@ def _create_server_histograms(meter) -> Dict[str, Histogram]:
         MetricInstruments.HTTP_SERVER_DURATION: meter.create_histogram(
             name=MetricInstruments.HTTP_SERVER_DURATION,
             unit="ms",
-            description="measures the duration outbound HTTP requests",
+            description="Duration of HTTP client requests.",
         ),
         MetricInstruments.HTTP_SERVER_REQUEST_SIZE: meter.create_histogram(
             name=MetricInstruments.HTTP_SERVER_REQUEST_SIZE,
diff --git a/instrumentation/opentelemetry-instrumentation-wsgi/src/opentelemetry/instrumentation/wsgi/__init__.py b/instrumentation/opentelemetry-instrumentation-wsgi/src/opentelemetry/instrumentation/wsgi/__init__.py
@@ -507,7 +507,7 @@ def __init__(
         self.duration_histogram = self.meter.create_histogram(
             name=MetricInstruments.HTTP_SERVER_DURATION,
             unit="ms",
-            description="measures the duration of the inbound HTTP request",
+            description="Duration of HTTP client requests.",
         )
         self.active_requests_counter = self.meter.create_up_down_counter(
             name=MetricInstruments.HTTP_SERVER_ACTIVE_REQUESTS,

Original file line number	Diff line number	Diff line change
`@@ -207,7 +207,7 @@ async def middleware(request, handler):`
`207`	`207`	`duration_histogram = meter.create_histogram(`
`208`	`208`	`name=MetricInstruments.HTTP_SERVER_DURATION,`
`209`	`209`	`unit="ms",`
`210`		`- description="measures the duration of the inbound HTTP request",`
	`210`	`+ description="Duration of HTTP client requests.",`
`211`	`211`	`)`
`212`	`212`
`213`	`213`	`active_requests_counter = meter.create_up_down_counter(`
Original file line number	Diff line number	Diff line change
`@@ -492,7 +492,7 @@ def __init__(`
`492`	`492`	`self.duration_histogram = self.meter.create_histogram(`
`493`	`493`	`name=MetricInstruments.HTTP_SERVER_DURATION,`
`494`	`494`	`unit="ms",`
`495`		`- description="measures the duration of the inbound HTTP request",`
	`495`	`+ description="Duration of HTTP client requests.",`
`496`	`496`	`)`
`497`	`497`	`self.server_response_size_histogram = self.meter.create_histogram(`
`498`	`498`	`name=MetricInstruments.HTTP_SERVER_RESPONSE_SIZE,`
Original file line number	Diff line number	Diff line change
`@@ -322,7 +322,7 @@ def _instrument(self, **kwargs):`
`322`	`322`	`_DjangoMiddleware._duration_histogram = meter.create_histogram(`
`323`	`323`	`name=MetricInstruments.HTTP_SERVER_DURATION,`
`324`	`324`	`unit="ms",`
`325`		`- description="measures the duration of the inbound http request",`
	`325`	`+ description="Duration of HTTP client requests.",`
`326`	`326`	`)`
`327`	`327`	`_DjangoMiddleware._active_request_counter = meter.create_up_down_counter(`
`328`	`328`	`name=MetricInstruments.HTTP_SERVER_ACTIVE_REQUESTS,`
Original file line number	Diff line number	Diff line change
`@@ -268,7 +268,7 @@ def __init__(self, args, *kwargs):`
`268`	`268`	`self.duration_histogram = self._otel_meter.create_histogram(`
`269`	`269`	`name=MetricInstruments.HTTP_SERVER_DURATION,`
`270`	`270`	`unit="ms",`
`271`		`- description="measures the duration of the inbound HTTP request",`
	`271`	`+ description="Duration of HTTP client requests.",`
`272`	`272`	`)`
`273`	`273`	`self.active_requests_counter = self._otel_meter.create_up_down_counter(`
`274`	`274`	`name=MetricInstruments.HTTP_SERVER_ACTIVE_REQUESTS,`
Original file line number	Diff line number	Diff line change
`@@ -140,7 +140,7 @@ def trace_tween_factory(handler, registry):`
`140`	`140`	`duration_histogram = meter.create_histogram(`
`141`	`141`	`name=MetricInstruments.HTTP_SERVER_DURATION,`
`142`	`142`	`unit="ms",`
`143`		`- description="measures the duration of the inbound HTTP request",`
	`143`	`+ description="Duration of HTTP client requests.",`
`144`	`144`	`)`
`145`	`145`	`active_requests_counter = meter.create_up_down_counter(`
`146`	`146`	`name=MetricInstruments.HTTP_SERVER_ACTIVE_REQUESTS,`
Original file line number	Diff line number	Diff line change
`@@ -507,7 +507,7 @@ def __init__(`
`507`	`507`	`self.duration_histogram = self.meter.create_histogram(`
`508`	`508`	`name=MetricInstruments.HTTP_SERVER_DURATION,`
`509`	`509`	`unit="ms",`
`510`		`- description="measures the duration of the inbound HTTP request",`
	`510`	`+ description="Duration of HTTP client requests.",`
`511`	`511`	`)`
`512`	`512`	`self.active_requests_counter = self.meter.create_up_down_counter(`
`513`	`513`	`name=MetricInstruments.HTTP_SERVER_ACTIVE_REQUESTS,`