mirror of
https://github.com/agent-substrate/substrate.git
synced 2026-10-02 03:24:42 +08:00
Jeff Luo
4bc650a83d
Follow-up to #749, for comment of adding the ladder design in benchmarking for observability.
133 lines
4.9 KiB
Python
133 lines
4.9 KiB
Python
# Copyright 2026 Google LLC
|
|
#
|
|
# 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 collections.abc import Sequence
|
|
from locust import events
|
|
from locust.argument_parser import LocustArgumentParser
|
|
from locust.env import Environment
|
|
from opentelemetry import trace
|
|
from opentelemetry.context import Context
|
|
from opentelemetry.sdk.trace import TracerProvider
|
|
from opentelemetry.sdk.trace.export import BatchSpanProcessor
|
|
from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
|
|
from opentelemetry.sdk.trace.sampling import SamplingResult, TraceIdRatioBased, Sampler
|
|
from opentelemetry.propagate import set_global_textmap
|
|
from opentelemetry.trace import Link, SpanKind, Tracer
|
|
from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator
|
|
from opentelemetry.trace.span import TraceState
|
|
from opentelemetry.sdk.resources import SERVICE_NAME, Resource
|
|
from opentelemetry.util.types import Attributes
|
|
import logging
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
class UpdatableSampler(Sampler):
|
|
def __init__(self, initial_probability: float = 0.0) -> None:
|
|
self.sampler = TraceIdRatioBased(initial_probability)
|
|
self.probability = initial_probability
|
|
|
|
def update_probability(self, probability: float) -> None:
|
|
self.sampler = TraceIdRatioBased(probability)
|
|
self.probability = probability
|
|
|
|
def should_sample(
|
|
self,
|
|
parent_context: Context | None,
|
|
trace_id: int,
|
|
name: str,
|
|
kind: SpanKind | None = None,
|
|
attributes: Attributes = None,
|
|
links: Sequence[Link] | None = None,
|
|
trace_state: TraceState | None = None,
|
|
) -> SamplingResult:
|
|
return self.sampler.should_sample(
|
|
parent_context, trace_id, name, kind, attributes, links, trace_state
|
|
)
|
|
|
|
def get_description(self) -> str:
|
|
return f"UpdatableSampler(probability={self.probability})"
|
|
|
|
_initialized = False
|
|
_sampler = UpdatableSampler(0.0)
|
|
|
|
|
|
# All locust test files share one process-global TracerProvider, so the
|
|
# service name is fixed here rather than passed per-call.
|
|
SERVICE_NAME_VALUE = "substrate-locust"
|
|
|
|
|
|
def init_tracing() -> None:
|
|
global _initialized, _sampler
|
|
if _initialized:
|
|
logger.info("Tracing already initialized, skipping.")
|
|
return
|
|
|
|
@events.init_command_line_parser.add_listener
|
|
def _(parser: LocustArgumentParser) -> None:
|
|
parser.add_argument(
|
|
"--trace-probability",
|
|
type=float,
|
|
default=0.0,
|
|
env_var="LOCUST_TRACE_PROBABILITY",
|
|
help="Probability of tracing requests (0.0 to 1.0)",
|
|
include_in_web_ui=True,
|
|
)
|
|
|
|
@events.init.add_listener
|
|
def on_locust_init(environment: Environment, **kwargs) -> None:
|
|
options = environment.parsed_options
|
|
probability = getattr(options, 'trace_probability', 0.0)
|
|
|
|
_sampler.update_probability(probability)
|
|
|
|
resource = Resource(attributes={
|
|
SERVICE_NAME: SERVICE_NAME_VALUE
|
|
})
|
|
provider = TracerProvider(sampler=_sampler, resource=resource)
|
|
|
|
# Always add the exporter so it's ready if probability is increased later
|
|
processor = BatchSpanProcessor(OTLPSpanExporter())
|
|
provider.add_span_processor(processor)
|
|
|
|
trace.set_tracer_provider(provider)
|
|
set_global_textmap(TraceContextTextMapPropagator())
|
|
logger.info(f"Tracing initialized for {SERVICE_NAME_VALUE} with initial probability {probability}")
|
|
|
|
@events.test_start.add_listener
|
|
def on_test_start(environment: Environment, **kwargs) -> None:
|
|
options = environment.parsed_options
|
|
probability = getattr(options, 'trace_probability', 0.0)
|
|
_sampler.update_probability(probability)
|
|
logger.info(f"Test started, updated trace probability to {probability}")
|
|
|
|
_initialized = True
|
|
|
|
|
|
def set_trace_probability(probability: float) -> None:
|
|
"""Change the sample rate of this process while a test runs.
|
|
|
|
init_tracing sets the rate once, at the start of a test, from the command
|
|
line. A step of a load ladder changes the rate in the middle of a run
|
|
(see shapes/ladder_shape.py), and the provider holds one sampler for the
|
|
life of the process, thus the change goes to that sampler and not to a
|
|
new provider.
|
|
"""
|
|
_sampler.update_probability(probability)
|
|
logger.info(f"Trace probability set to {probability}")
|
|
|
|
|
|
def get_tracer(name: str) -> Tracer:
|
|
return trace.get_tracer(name)
|
|
|