diff options
author | S. Solomon Darnell | 2025-03-28 21:52:21 -0500 |
---|---|---|
committer | S. Solomon Darnell | 2025-03-28 21:52:21 -0500 |
commit | 4a52a71956a8d46fcb7294ac71734504bb09bcc2 (patch) | |
tree | ee3dc5af3b6313e921cd920906356f5d4febc4ed /.venv/lib/python3.12/site-packages/opentelemetry/semconv/_incubating/metrics/rpc_metrics.py | |
parent | cc961e04ba734dd72309fb548a2f97d67d578813 (diff) | |
download | gn-ai-master.tar.gz |
Diffstat (limited to '.venv/lib/python3.12/site-packages/opentelemetry/semconv/_incubating/metrics/rpc_metrics.py')
-rw-r--r-- | .venv/lib/python3.12/site-packages/opentelemetry/semconv/_incubating/metrics/rpc_metrics.py | 211 |
1 files changed, 211 insertions, 0 deletions
diff --git a/.venv/lib/python3.12/site-packages/opentelemetry/semconv/_incubating/metrics/rpc_metrics.py b/.venv/lib/python3.12/site-packages/opentelemetry/semconv/_incubating/metrics/rpc_metrics.py new file mode 100644 index 00000000..e3f4ad6e --- /dev/null +++ b/.venv/lib/python3.12/site-packages/opentelemetry/semconv/_incubating/metrics/rpc_metrics.py @@ -0,0 +1,211 @@ +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from typing import Final + +from opentelemetry.metrics import Histogram, Meter + +RPC_CLIENT_DURATION: Final = "rpc.client.duration" +""" +Measures the duration of outbound RPC +Instrument: histogram +Unit: ms +Note: While streaming RPCs may record this metric as start-of-batch +to end-of-batch, it's hard to interpret in practice. + +**Streaming**: N/A. +""" + + +def create_rpc_client_duration(meter: Meter) -> Histogram: + """Measures the duration of outbound RPC""" + return meter.create_histogram( + name=RPC_CLIENT_DURATION, + description="Measures the duration of outbound RPC.", + unit="ms", + ) + + +RPC_CLIENT_REQUEST_SIZE: Final = "rpc.client.request.size" +""" +Measures the size of RPC request messages (uncompressed) +Instrument: histogram +Unit: By +Note: **Streaming**: Recorded per message in a streaming batch. +""" + + +def create_rpc_client_request_size(meter: Meter) -> Histogram: + """Measures the size of RPC request messages (uncompressed)""" + return meter.create_histogram( + name=RPC_CLIENT_REQUEST_SIZE, + description="Measures the size of RPC request messages (uncompressed).", + unit="By", + ) + + +RPC_CLIENT_REQUESTS_PER_RPC: Final = "rpc.client.requests_per_rpc" +""" +Measures the number of messages received per RPC +Instrument: histogram +Unit: {count} +Note: Should be 1 for all non-streaming RPCs. + +**Streaming**: This metric is required for server and client streaming RPCs. +""" + + +def create_rpc_client_requests_per_rpc(meter: Meter) -> Histogram: + """Measures the number of messages received per RPC""" + return meter.create_histogram( + name=RPC_CLIENT_REQUESTS_PER_RPC, + description="Measures the number of messages received per RPC.", + unit="{count}", + ) + + +RPC_CLIENT_RESPONSE_SIZE: Final = "rpc.client.response.size" +""" +Measures the size of RPC response messages (uncompressed) +Instrument: histogram +Unit: By +Note: **Streaming**: Recorded per response in a streaming batch. +""" + + +def create_rpc_client_response_size(meter: Meter) -> Histogram: + """Measures the size of RPC response messages (uncompressed)""" + return meter.create_histogram( + name=RPC_CLIENT_RESPONSE_SIZE, + description="Measures the size of RPC response messages (uncompressed).", + unit="By", + ) + + +RPC_CLIENT_RESPONSES_PER_RPC: Final = "rpc.client.responses_per_rpc" +""" +Measures the number of messages sent per RPC +Instrument: histogram +Unit: {count} +Note: Should be 1 for all non-streaming RPCs. + +**Streaming**: This metric is required for server and client streaming RPCs. +""" + + +def create_rpc_client_responses_per_rpc(meter: Meter) -> Histogram: + """Measures the number of messages sent per RPC""" + return meter.create_histogram( + name=RPC_CLIENT_RESPONSES_PER_RPC, + description="Measures the number of messages sent per RPC.", + unit="{count}", + ) + + +RPC_SERVER_DURATION: Final = "rpc.server.duration" +""" +Measures the duration of inbound RPC +Instrument: histogram +Unit: ms +Note: While streaming RPCs may record this metric as start-of-batch +to end-of-batch, it's hard to interpret in practice. + +**Streaming**: N/A. +""" + + +def create_rpc_server_duration(meter: Meter) -> Histogram: + """Measures the duration of inbound RPC""" + return meter.create_histogram( + name=RPC_SERVER_DURATION, + description="Measures the duration of inbound RPC.", + unit="ms", + ) + + +RPC_SERVER_REQUEST_SIZE: Final = "rpc.server.request.size" +""" +Measures the size of RPC request messages (uncompressed) +Instrument: histogram +Unit: By +Note: **Streaming**: Recorded per message in a streaming batch. +""" + + +def create_rpc_server_request_size(meter: Meter) -> Histogram: + """Measures the size of RPC request messages (uncompressed)""" + return meter.create_histogram( + name=RPC_SERVER_REQUEST_SIZE, + description="Measures the size of RPC request messages (uncompressed).", + unit="By", + ) + + +RPC_SERVER_REQUESTS_PER_RPC: Final = "rpc.server.requests_per_rpc" +""" +Measures the number of messages received per RPC +Instrument: histogram +Unit: {count} +Note: Should be 1 for all non-streaming RPCs. + +**Streaming** : This metric is required for server and client streaming RPCs. +""" + + +def create_rpc_server_requests_per_rpc(meter: Meter) -> Histogram: + """Measures the number of messages received per RPC""" + return meter.create_histogram( + name=RPC_SERVER_REQUESTS_PER_RPC, + description="Measures the number of messages received per RPC.", + unit="{count}", + ) + + +RPC_SERVER_RESPONSE_SIZE: Final = "rpc.server.response.size" +""" +Measures the size of RPC response messages (uncompressed) +Instrument: histogram +Unit: By +Note: **Streaming**: Recorded per response in a streaming batch. +""" + + +def create_rpc_server_response_size(meter: Meter) -> Histogram: + """Measures the size of RPC response messages (uncompressed)""" + return meter.create_histogram( + name=RPC_SERVER_RESPONSE_SIZE, + description="Measures the size of RPC response messages (uncompressed).", + unit="By", + ) + + +RPC_SERVER_RESPONSES_PER_RPC: Final = "rpc.server.responses_per_rpc" +""" +Measures the number of messages sent per RPC +Instrument: histogram +Unit: {count} +Note: Should be 1 for all non-streaming RPCs. + +**Streaming**: This metric is required for server and client streaming RPCs. +""" + + +def create_rpc_server_responses_per_rpc(meter: Meter) -> Histogram: + """Measures the number of messages sent per RPC""" + return meter.create_histogram( + name=RPC_SERVER_RESPONSES_PER_RPC, + description="Measures the number of messages sent per RPC.", + unit="{count}", + ) |