urllib/urllib3 - set metric descriptions per semantic conventions (#1959)

* Set metric descriptions per semantic conventions

* Set metric descriptions per semantic conventions

* fix spelling

---------

Co-authored-by: Shalev Roda <65566801+shalevr@users.noreply.github.com>
This commit is contained in:
Pierre Tessier 2023-11-19 01:20:41 -05:00 committed by GitHub
parent f34771618c
commit 9afaf26b3a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 11 additions and 6 deletions

View File

@ -12,6 +12,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `opentelemetry-instrumentation` Added Otel semantic convention opt-in mechanism - `opentelemetry-instrumentation` Added Otel semantic convention opt-in mechanism
([#1987](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1987)) ([#1987](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1987))
### Fixed
- `opentelemetry-instrumentation-urllib`/`opentelemetry-instrumentation-urllib3` Fix metric descriptions to match semantic conventions
([#1959]((https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1959))
## Version 1.21.0/0.42b0 (2023-11-01) ## Version 1.21.0/0.42b0 (2023-11-01)
### Added ### Added

View File

@ -307,17 +307,17 @@ def _create_client_histograms(meter) -> Dict[str, Histogram]:
MetricInstruments.HTTP_CLIENT_DURATION: meter.create_histogram( MetricInstruments.HTTP_CLIENT_DURATION: meter.create_histogram(
name=MetricInstruments.HTTP_CLIENT_DURATION, name=MetricInstruments.HTTP_CLIENT_DURATION,
unit="ms", unit="ms",
description="measures the duration outbound HTTP requests", description="Measures the duration of outbound HTTP requests.",
), ),
MetricInstruments.HTTP_CLIENT_REQUEST_SIZE: meter.create_histogram( MetricInstruments.HTTP_CLIENT_REQUEST_SIZE: meter.create_histogram(
name=MetricInstruments.HTTP_CLIENT_REQUEST_SIZE, name=MetricInstruments.HTTP_CLIENT_REQUEST_SIZE,
unit="By", unit="By",
description="measures the size of HTTP request messages (compressed)", description="Measures the size of HTTP request messages.",
), ),
MetricInstruments.HTTP_CLIENT_RESPONSE_SIZE: meter.create_histogram( MetricInstruments.HTTP_CLIENT_RESPONSE_SIZE: meter.create_histogram(
name=MetricInstruments.HTTP_CLIENT_RESPONSE_SIZE, name=MetricInstruments.HTTP_CLIENT_RESPONSE_SIZE,
unit="By", unit="By",
description="measures the size of HTTP response messages (compressed)", description="Measures the size of HTTP response messages.",
), ),
} }

View File

@ -183,17 +183,17 @@ class URLLib3Instrumentor(BaseInstrumentor):
duration_histogram = meter.create_histogram( duration_histogram = meter.create_histogram(
name=MetricInstruments.HTTP_CLIENT_DURATION, name=MetricInstruments.HTTP_CLIENT_DURATION,
unit="ms", unit="ms",
description="measures the duration outbound HTTP requests", description="Measures the duration of outbound HTTP requests.",
) )
request_size_histogram = meter.create_histogram( request_size_histogram = meter.create_histogram(
name=MetricInstruments.HTTP_CLIENT_REQUEST_SIZE, name=MetricInstruments.HTTP_CLIENT_REQUEST_SIZE,
unit="By", unit="By",
description="measures the size of HTTP request messages (compressed)", description="Measures the size of HTTP request messages.",
) )
response_size_histogram = meter.create_histogram( response_size_histogram = meter.create_histogram(
name=MetricInstruments.HTTP_CLIENT_RESPONSE_SIZE, name=MetricInstruments.HTTP_CLIENT_RESPONSE_SIZE,
unit="By", unit="By",
description="measures the size of HTTP response messages (compressed)", description="Measures the size of HTTP response messages.",
) )
_instrument( _instrument(