[Python o11] Add boundaries to CSM example (#36898)

* Latency in 50 percentile:
![Screenshot 2024-06-12 at 11 04
08 AM](https://github.com/grpc/grpc/assets/24593237/cb315d47-0983-40b7-ab9d-75afb93b232c)

<!--

If you know who should review your pull request, please assign it to
that
person, otherwise the pull request would get assigned randomly.

If your pull request is for a specific language, please add the
appropriate
lang label.

-->
pull/36951/head
Xuan Wang 5 months ago committed by GitHub
parent b0063e8345
commit 4df07a77f0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 100
      examples/python/observability/csm/csm_greeter_client.py
  2. 90
      examples/python/observability/csm/csm_greeter_server.py

@ -15,11 +15,14 @@
import argparse
import logging
import time
from typing import Sequence
import grpc
from grpc_csm_observability import CsmOpenTelemetryPlugin
from opentelemetry.exporter.prometheus import PrometheusMetricReader
from opentelemetry.sdk.metrics import Histogram
from opentelemetry.sdk.metrics import MeterProvider
from opentelemetry.sdk.metrics import view
from prometheus_client import start_http_server
from src.proto.grpc.testing import messages_pb2
@ -47,8 +50,14 @@ def _run(target: int, secure_mode: bool, prometheus_endpoint: int):
while True:
request = messages_pb2.SimpleRequest()
logger.info("Sending request to server")
stub.UnaryCall(request)
time.sleep(1)
try:
stub.UnaryCall(request)
time.sleep(1)
except Exception: # pylint: disable=broad-except
logger.info(
"Request failed, this is normal during initial setup."
)
# Deregister is not called in this example, but this is required to clean up.
csm_plugin.deregister_global()
@ -58,13 +67,98 @@ def _prepare_csm_observability_plugin(
# Start Prometheus client
start_http_server(port=prometheus_endpoint, addr="0.0.0.0")
reader = PrometheusMetricReader()
meter_provider = MeterProvider(metric_readers=[reader])
meter_provider = MeterProvider(
metric_readers=[reader], views=_create_views()
)
csm_plugin = CsmOpenTelemetryPlugin(
meter_provider=meter_provider,
)
return csm_plugin
def _create_views() -> Sequence[view.View]:
"""Create a list of views with config for specific metrics."""
latency_boundaries = [
0,
0.00001,
0.00005,
0.0001,
0.0003,
0.0006,
0.0008,
0.001,
0.002,
0.003,
0.004,
0.005,
0.006,
0.008,
0.01,
0.013,
0.016,
0.02,
0.025,
0.03,
0.04,
0.05,
0.065,
0.08,
0.1,
0.13,
0.16,
0.2,
0.25,
0.3,
0.4,
0.5,
0.65,
0.8,
1,
2,
5,
10,
20,
50,
100,
]
size_boundaries = [
0,
1024,
2048,
4096,
16384,
65536,
262144,
1048576,
4194304,
16777216,
67108864,
268435456,
1073741824,
4294967296,
]
return [
view.View(
instrument_type=Histogram,
instrument_unit="s",
aggregation=view.ExplicitBucketHistogramAggregation(
# Boundaries as defined in gRFC. See:
# https://github.com/grpc/proposal/blob/master/A66-otel-stats.md
boundaries=latency_boundaries
),
),
view.View(
instrument_type=Histogram,
instrument_unit="By",
aggregation=view.ExplicitBucketHistogramAggregation(
# Boundaries as defined in gRFC. See:
# https://github.com/grpc/proposal/blob/master/A66-otel-stats.md
boundaries=size_boundaries
),
),
]
def bool_arg(arg: str) -> bool:
if arg.lower() in ("true", "yes", "y"):
return True

@ -16,11 +16,14 @@ import argparse
from concurrent import futures
import logging
import socket
from typing import Sequence
import grpc
from grpc_csm_observability import CsmOpenTelemetryPlugin
from opentelemetry.exporter.prometheus import PrometheusMetricReader
from opentelemetry.sdk.metrics import Histogram
from opentelemetry.sdk.metrics import MeterProvider
from opentelemetry.sdk.metrics import view
from prometheus_client import start_http_server
from src.proto.grpc.testing import messages_pb2
@ -81,13 +84,98 @@ def _prepare_csm_observability_plugin(
# Start Prometheus client
start_http_server(port=prometheus_endpoint, addr="0.0.0.0")
reader = PrometheusMetricReader()
meter_provider = MeterProvider(metric_readers=[reader])
meter_provider = MeterProvider(
metric_readers=[reader], views=_create_views()
)
csm_plugin = CsmOpenTelemetryPlugin(
meter_provider=meter_provider,
)
return csm_plugin
def _create_views() -> Sequence[view.View]:
"""Create a list of views with config for specific metrics."""
latency_boundaries = [
0,
0.00001,
0.00005,
0.0001,
0.0003,
0.0006,
0.0008,
0.001,
0.002,
0.003,
0.004,
0.005,
0.006,
0.008,
0.01,
0.013,
0.016,
0.02,
0.025,
0.03,
0.04,
0.05,
0.065,
0.08,
0.1,
0.13,
0.16,
0.2,
0.25,
0.3,
0.4,
0.5,
0.65,
0.8,
1,
2,
5,
10,
20,
50,
100,
]
size_boundaries = [
0,
1024,
2048,
4096,
16384,
65536,
262144,
1048576,
4194304,
16777216,
67108864,
268435456,
1073741824,
4294967296,
]
return [
view.View(
instrument_type=Histogram,
instrument_unit="s",
aggregation=view.ExplicitBucketHistogramAggregation(
# Boundaries as defined in gRFC. See:
# https://github.com/grpc/proposal/blob/master/A66-otel-stats.md
boundaries=latency_boundaries
),
),
view.View(
instrument_type=Histogram,
instrument_unit="By",
aggregation=view.ExplicitBucketHistogramAggregation(
# Boundaries as defined in gRFC. See:
# https://github.com/grpc/proposal/blob/master/A66-otel-stats.md
boundaries=size_boundaries
),
),
]
def _configure_test_server(
server: grpc.Server, port: int, secure_mode: bool, server_id: str
) -> None:

Loading…
Cancel
Save