def __init__(self, run_tracker, settings, endpoint, trace_id, parent_id, sample_rate,
service_name_prefix, max_span_batch_size):
"""
When trace_id and parent_id are set a Zipkin trace will be created with given trace_id
and parent_id. If trace_id and parent_id are set to None, a trace_id will be randomly
generated for a Zipkin trace. trace-id and parent-id must both either be set or not set.
:param RunTracker run_tracker: Tracks and times the execution of a pants run.
:param Settings settings: Generic reporting settings.
:param string endpoint: The full HTTP URL of a zipkin server to which traces should be posted.
:param string trace_id: The overall 64 or 128-bit ID of the trace. May be None.
:param string parent_id: The 64-bit ID for a parent span that invokes Pants. May be None.
:param float sample_rate: Rate at which to sample Zipkin traces. Value 0.0 - 100.0.
:param string service_name_prefix: Prefix for service name.
:param int max_span_batch_size: Spans in a trace are sent in batches,
max_span_batch_size defines max size of one batch.
"""
super().__init__(run_tracker, settings)
# Create a transport handler
self.trace_id = trace_id
self.parent_id = parent_id
self.sample_rate = float(sample_rate)
self.endpoint = endpoint
self.encoding = Encoding.V1_JSON
self.tracer = get_default_tracer()
self.run_tracker = run_tracker
self.service_name_prefix = service_name_prefix
self.max_span_batch_size = max_span_batch_size
self.zipkin_spans_dir = os.path.join(self.run_tracker.run_info_dir, 'zipkin')
self.handler = AsyncHTTPTransportHandler(endpoint, self.zipkin_spans_dir, self.encoding)
# Directory to store encoded spans.
safe_mkdir(self.zipkin_spans_dir)
def bulk_record_workunits(self, engine_workunits):
"""A collection of workunits from v2 engine part"""
for workunit in engine_workunits:
start_timestamp = from_secs_and_nanos_to_float(
workunit['start_secs'],
workunit['start_nanos']
)
duration = from_secs_and_nanos_to_float(
workunit['duration_secs'],
workunit['duration_nanos']
)
local_tracer = get_default_tracer()
span = local_tracer.zipkin_span(
service_name=self.service_name_prefix.format("rule"),
span_name=workunit['name'],
duration=duration,
)
span.start()
span.zipkin_attrs = ZipkinAttrs(
trace_id=self.trace_id,
span_id=workunit['span_id'],
# TODO change it when we properly pass parent_id to the v2 engine Nodes
# TODO Pass parent_id with ExecutionRequest when v2 engine is called by a workunit
# TODO pass parent_id when v2 engine Node is called by another v2 engine Node
parent_span_id=workunit.get("parent_id", self.parent_id),
flags='0', # flags: stores flags header. Currently unused
is_sampled=True,
)
span.start_timestamp = start_timestamp
span.stop()
def __init__(self, run_tracker, settings, endpoint, trace_id, parent_id,
sample_rate):
"""
When trace_id and parent_id are set a Zipkin trace will be created with given trace_id
and parent_id. If trace_id and parent_id are set to None, a trace_id will be randomly
generated for a Zipkin trace. trace-id and parent-id must both either be set or not set.
:param RunTracker run_tracker: Tracks and times the execution of a pants run.
:param Settings settings: Generic reporting settings.
:param string endpoint: The full HTTP URL of a zipkin server to which traces should be posted.
:param string trace_id: The overall 64 or 128-bit ID of the trace. May be None.
:param string parent_id: The 64-bit ID for a parent span that invokes Pants. May be None.
:param float sample_rate: Rate at which to sample Zipkin traces. Value 0.0 - 100.0.
"""
super(ZipkinReporter, self).__init__(run_tracker, settings)
# Create a transport handler
self.handler = HTTPTransportHandler(endpoint)
self.trace_id = trace_id
self.parent_id = parent_id
self.sample_rate = float(sample_rate)
self.endpoint = endpoint
self.tracer = get_default_tracer()
self.run_tracker = run_tracker
def start_workunit(self, workunit):
"""Implementation of Reporter callback."""
if workunit.has_label(WorkUnitLabel.GOAL):
service_name = "goal"
elif workunit.has_label(WorkUnitLabel.TASK):
service_name = "task"
else:
service_name = "workunit"
# Set local_tracer. Tracer stores spans and span's zipkin_attrs.
# If start_workunit is called from the root thread then local_tracer is the same as self.tracer.
# If start_workunit is called from a new thread then local_tracer will have an empty span
# storage and stack.
local_tracer = get_default_tracer()
# Check if it is the first workunit
first_span = self.run_tracker.is_main_root_workunit(workunit)
if first_span:
# If trace_id and parent_id are given as flags create zipkin_attrs
if self.trace_id is not None and self.parent_id is not None:
zipkin_attrs = ZipkinAttrs(
# trace_id and parent_id are passed to Pants by another process that collects
# Zipkin trace
trace_id=self.trace_id,
span_id=generate_random_64bit_string(),
parent_span_id=self.parent_id,
flags='0', # flags: stores flags header. Currently unused
is_sampled=True,
)
else:
zipkin_attrs = create_attrs_for_span(
# trace_id is the same as run_uuid that is created in run_tracker and is the part of
# pants_run id
trace_id=self.trace_id,
sample_rate=self.sample_rate, # Value between 0.0 and 100.0
)
# TODO delete this line when parent_id will be passed in v2 engine:
# - with ExecutionRequest when Nodes from v2 engine are called by a workunit;
# - when a v2 engine Node is called by another v2 engine Node.
self.parent_id = zipkin_attrs.span_id
span = local_tracer.zipkin_span(
service_name=self.service_name_prefix.format("main"),
span_name=workunit.name,
transport_handler=self.handler,
encoding=self.encoding,
zipkin_attrs=zipkin_attrs,
max_span_batch_size=self.max_span_batch_size,
)
else:
# If start_workunit is called from a new thread local_tracer doesn't have zipkin attributes.
# Parent's attributes need to be added to the local_tracer zipkin_attrs storage.
if not local_tracer.get_zipkin_attrs():
parent_attrs = workunit.parent.zipkin_span.zipkin_attrs
local_tracer.push_zipkin_attrs(parent_attrs)
local_tracer.set_transport_configured(configured=True)
span = local_tracer.zipkin_span(
service_name=self.service_name_prefix.format(service_name),
span_name=workunit.name,
)
# For all spans except the first span zipkin_attrs for span are created at this point
span.start()
if workunit.name == 'background' and self.run_tracker.is_main_root_workunit(workunit.parent):
span.zipkin_attrs = span.zipkin_attrs._replace(
parent_span_id=workunit.parent.zipkin_span.zipkin_attrs.span_id
)
span.service_name = self.service_name_prefix.format("background")
# Goals and tasks save their start time at the beginning of their run.
# This start time is passed to workunit, because the workunit may be created much later.
span.start_timestamp = workunit.start_time
if first_span and span.zipkin_attrs.is_sampled:
span.logging_context.start_timestamp = workunit.start_time
workunit.zipkin_span = span
