def test_set_annotation_without_attributes(self):
pb_span = trace_pb2.Span()
pb_event0 = pb_span.time_events.time_event.add()
pb_event1 = pb_span.time_events.time_event.add()
annotation0 = time_event_module.Annotation(description="hi there0")
annotation1 = time_event_module.Annotation(
description="hi there1", attributes=attributes_module.Attributes())
utils.set_proto_annotation(pb_event0.annotation, annotation0)
utils.set_proto_annotation(pb_event1.annotation, annotation1)
self.assertEqual(pb_event0.annotation.description.value, "hi there0")
self.assertEqual(pb_event1.annotation.description.value, "hi there1")
self.assertEqual(len(pb_event0.annotation.attributes.attribute_map), 0)
self.assertEqual(len(pb_event1.annotation.attributes.attribute_map), 0)
def test_set_annotation_with_attributes(self):
pb_span = trace_pb2.Span()
pb_event = pb_span.time_events.time_event.add()
annotation = time_event_module.Annotation(
description="hi there",
attributes=attributes_module.Attributes(
attributes={
'test_str_key': 'test_str_value',
'test_int_key': 1,
'test_bool_key': False,
'test_double_key': 567.89
}))
utils.set_proto_annotation(pb_event.annotation, annotation)
self.assertEqual(pb_event.annotation.description.value, "hi there")
self.assertEqual(len(pb_event.annotation.attributes.attribute_map), 4)
self.assertEqual(
pb_event.annotation.attributes.attribute_map['test_str_key'],
trace_pb2.AttributeValue(string_value=trace_pb2.TruncatableString(
value='test_str_value')))
self.assertEqual(
pb_event.annotation.attributes.attribute_map['test_int_key'],
trace_pb2.AttributeValue(int_value=1))
self.assertEqual(
pb_event.annotation.attributes.attribute_map['test_bool_key'],
trace_pb2.AttributeValue(bool_value=False))
self.assertEqual(
pb_event.annotation.attributes.attribute_map['test_double_key'],
trace_pb2.AttributeValue(double_value=567.89))
def test_translate_annotation(self):
ts = datetime.utcnow() + timedelta(seconds=-10)
annotation = time_event_module.Annotation(
timestamp=ts,
description='description')
span_data = span_data_module.SpanData(
context=span_context_module.SpanContext(
trace_id='6e0c63257de34c92bf9efcd03927272e'),
span_id='6e0c63257de34c92',
annotations=[annotation],
message_events=None,
span_kind=span_module.SpanKind.SERVER,
status=None,
start_time=None,
end_time=None,
child_span_count=None,
name=None,
parent_span_id=None,
attributes=None,
same_process_as_parent_span=False,
stack_trace=None,
links=None)
pb_span = utils.translate_to_trace_proto(span_data)
self.assertEqual(len(pb_span.time_events.time_event), 1)
def test_format_legacy_trace_json(self):
trace_id = '2dd43a1d6b2549c6bc2a1a54c2fc0b05'
span_data = span_data_module.SpanData(
name='root',
context=span_context.SpanContext(trace_id=trace_id,
span_id='6e0c63257de34c92'),
span_id='6e0c63257de34c92',
parent_span_id='6e0c63257de34c93',
attributes={'key1': 'value1'},
start_time=utils.to_iso_str(),
end_time=utils.to_iso_str(),
stack_trace=stack_trace.StackTrace(stack_trace_hash_id='111'),
links=[link.Link('1111', span_id='6e0c63257de34c92')],
status=status.Status(code=0, message='pok'),
annotations=[
time_event.Annotation(timestamp=datetime.datetime(1970, 1, 1),
description='description')
],
message_events=[
time_event.MessageEvent(
timestamp=datetime.datetime(1970, 1, 1),
id=0,
)
],
same_process_as_parent_span=False,
child_span_count=0,
span_kind=0,
)
trace_json = span_data_module.format_legacy_trace_json([span_data])
self.assertEqual(trace_json.get('traceId'), trace_id)
self.assertEqual(len(trace_json.get('spans')), 1)
def test_constructor(self):
description = 'test description'
attributes = mock.Mock()
annotation = time_event_module.Annotation(description, attributes)
self.assertEqual(annotation.description, description)
self.assertEqual(annotation.attributes, attributes)
def add_annotation(self, description, **attrs):
"""Add an annotation to span.
:type description: str
:param description: A user-supplied message describing the event.
The maximum length for the description is 256 bytes.
:type attrs: kwargs
:param attrs: keyworded arguments e.g. failed=True, name='Caching'
"""
at = attributes.Attributes(attrs)
self.add_time_event(time_event_module.TimeEvent(datetime.utcnow(),
time_event_module.Annotation(description, at)))
def test_format_annotation_json_without_attributes(self):
description = 'test description'
annotation = time_event_module.Annotation(description)
annotation_json = annotation.format_annotation_json()
expected_annotation_json = {
'description': {
'value': description,
'truncated_byte_count': 0
}
}
self.assertEqual(annotation_json, expected_annotation_json)
def test_format_annotation_json_with_attributes(self):
description = 'test description'
attrs_json = {}
attributes = mock.Mock()
attributes.format_attributes_json.return_value = attrs_json
annotation = time_event_module.Annotation(description, attributes)
annotation_json = annotation.format_annotation_json()
expected_annotation_json = {
'description': {
'value': description,
'truncated_byte_count': 0
},
'attributes': {}
}
self.assertEqual(annotation_json, expected_annotation_json)
def test_translate_to_zipkin_with_annotations(self):
trace_id = '6e0c63257de34c92bf9efcd03927272e'
annotation_attributes = {
'annotation_bool': True,
'annotation_string': 'annotation_test',
'key_float': .3
}
s = '2017-08-15T18:02:26.071158'
time = datetime.strptime(s, '%Y-%m-%dT%H:%M:%S.%f')
time_events = [
time_event.TimeEvent(timestamp=time,
annotation=time_event.Annotation(
description='First Annotation',
attributes=annotation_attributes)),
time_event.TimeEvent(timestamp=time,
message_event=time_event.MessageEvent(
id='message-event-id',
uncompressed_size_bytes=0,
)),
]
spans_ipv4 = [
span_data_module.SpanData(
name='child_span',
context=span_context.SpanContext(trace_id=trace_id),
span_id='6e0c63257de34c92',
parent_span_id='6e0c63257de34c93',
attributes={'test_key': 'test_value'},
start_time='2017-08-15T18:02:26.071158Z',
end_time='2017-08-15T18:02:36.071158Z',
child_span_count=None,
stack_trace=None,
time_events=time_events,
links=None,
status=None,
same_process_as_parent_span=None,
span_kind=0,
),
span_data_module.SpanData(
name='child_span',
context=span_context.SpanContext(trace_id=trace_id),
span_id='6e0c63257de34c92',
parent_span_id='6e0c63257de34c93',
attributes={'test_key': 1},
start_time='2017-08-15T18:02:26.071158Z',
end_time='2017-08-15T18:02:36.071158Z',
child_span_count=None,
stack_trace=None,
time_events=time_events,
links=None,
status=None,
same_process_as_parent_span=None,
span_kind=None,
),
]
spans_ipv6 = [
span_data_module.SpanData(
name='child_span',
context=span_context.SpanContext(trace_id=trace_id),
span_id='6e0c63257de34c92',
parent_span_id=None,
attributes={
'test_key': False,
'test_key2': 'raw_value',
'test_key3': 0.1,
},
start_time='2017-08-15T18:02:26.071158Z',
end_time='2017-08-15T18:02:36.071158Z',
child_span_count=None,
stack_trace=None,
time_events=time_events,
links=None,
status=None,
same_process_as_parent_span=None,
span_kind=1,
),
]
ipv4 = '127.0.0.1'
ipv6 = '2001:0db8:85a3:0000:0000:8a2e:0370:7334'
local_endpoint_ipv4 = {
'serviceName': 'my_service',
'ipv4': ipv4,
'port': 9411,
}
local_endpoint_ipv6 = {
'serviceName': 'my_service',
'ipv6': ipv6,
'port': 9411,
}
expected_zipkin_spans_ipv4 = [
{
'traceId':
'6e0c63257de34c92bf9efcd03927272e',
'id':
'6e0c63257de34c92',
'parentId':
'6e0c63257de34c93',
'name':
'child_span',
'timestamp':
1502820146071158,
'duration':
10000000,
'localEndpoint':
local_endpoint_ipv4,
'tags': {
'test_key': 'test_value'
},
'annotations': [{
'timestamp': 1502820146071158,
'value': 'First Annotation'
}]
},
{
'traceId':
'6e0c63257de34c92bf9efcd03927272e',
'id':
'6e0c63257de34c92',
'parentId':
'6e0c63257de34c93',
'name':
'child_span',
'timestamp':
1502820146071158,
'duration':
10000000,
'localEndpoint':
local_endpoint_ipv4,
'tags': {
'test_key': '1'
},
'annotations': [{
'timestamp': 1502820146071158,
'value': 'First Annotation'
}]
},
]
expected_zipkin_spans_ipv6 = [
{
'traceId':
'6e0c63257de34c92bf9efcd03927272e',
'id':
'6e0c63257de34c92',
'name':
'child_span',
'timestamp':
1502820146071158,
'duration':
10000000,
'localEndpoint':
local_endpoint_ipv6,
'tags': {
'test_key': 'False',
'test_key2': 'raw_value',
'test_key3': '0.1'
},
'kind':
'SERVER',
'annotations': [{
'timestamp': 1502820146071158,
'value': 'First Annotation'
}]
},
]
# Test ipv4 local endpoint
exporter_ipv4 = trace_exporter.ZipkinExporter(
service_name='my_service', ipv4=ipv4)
zipkin_spans_ipv4 = exporter_ipv4.translate_to_zipkin(
span_datas=spans_ipv4)
self.assertEqual(zipkin_spans_ipv4, expected_zipkin_spans_ipv4)
# Test ipv6 local endpoint
exporter_ipv6 = trace_exporter.ZipkinExporter(
service_name='my_service', ipv6=ipv6)
zipkin_spans_ipv6 = exporter_ipv6.translate_to_zipkin(
span_datas=spans_ipv6)
self.assertEqual(zipkin_spans_ipv6, expected_zipkin_spans_ipv6)
def test_translate_to_jaeger(self):
self.maxDiff = None
trace_id_high = '6e0c63257de34c92'
trace_id_low = 'bf9efcd03927272e'
trace_id = trace_id_high + trace_id_low
span_id = '6e0c63257de34c92'
parent_span_id = '1111111111111111'
span_attributes = {
'key_bool': False,
'key_string': 'hello_world',
'key_int': 3
}
annotation_attributes = {
'annotation_bool': True,
'annotation_string': 'annotation_test',
'key_float': .3
}
link_attributes = {'key_bool': True}
import datetime
s = '2017-08-15T18:02:26.071158'
time = datetime.datetime.strptime(s, '%Y-%m-%dT%H:%M:%S.%f')
time_events = [
time_event.TimeEvent(
timestamp=time,
annotation=time_event.Annotation(
description='First Annotation',
attributes=attributes.Attributes(annotation_attributes))),
time_event.TimeEvent(timestamp=time,
message_event=time_event.MessageEvent(
id='message-event-id',
uncompressed_size_bytes=0,
)),
]
time_events2 = [
time_event.TimeEvent(timestamp=time,
annotation=time_event.Annotation(
description='First Annotation',
attributes=None)),
time_event.TimeEvent(timestamp=time,
message_event=time_event.MessageEvent(
id='message-event-id',
uncompressed_size_bytes=0,
)),
]
links = [
link.Link(trace_id=trace_id,
span_id=span_id,
type=link.Type.CHILD_LINKED_SPAN,
attributes=link_attributes),
link.Link(trace_id=trace_id,
span_id=span_id,
type=link.Type.PARENT_LINKED_SPAN,
attributes=link_attributes),
link.Link(trace_id=trace_id,
span_id=span_id,
type=link.Type.TYPE_UNSPECIFIED,
attributes=link_attributes)
]
span_status = status.Status(code=200, message='success')
start_time = '2017-08-15T18:02:26.071158Z'
end_time = '2017-08-15T18:02:36.071158Z'
span_datas = [
span_data.SpanData(
name='test1',
context=span_context.SpanContext(trace_id=trace_id),
span_id=span_id,
parent_span_id=parent_span_id,
attributes=span_attributes,
start_time=start_time,
end_time=end_time,
child_span_count=0,
stack_trace=None,
time_events=time_events,
links=links,
status=span_status,
same_process_as_parent_span=None,
span_kind=0,
),
span_data.SpanData(
name='test2',
context=None,
span_id=span_id,
parent_span_id=None,
attributes=None,
start_time=start_time,
end_time=end_time,
child_span_count=None,
stack_trace=None,
time_events=time_events2,
links=None,
status=None,
same_process_as_parent_span=None,
span_kind=None,
),
span_data.SpanData(
name='test3',
context=None,
span_id=span_id,
parent_span_id=None,
attributes=None,
start_time=start_time,
end_time=end_time,
child_span_count=None,
stack_trace=None,
time_events=None,
links=None,
status=None,
same_process_as_parent_span=None,
span_kind=None,
)
]
exporter = jaeger_exporter.JaegerExporter()
spans = exporter.translate_to_jaeger(span_datas)
expected_spans = [
jaeger.Span(
traceIdHigh=7929822056569588882,
traceIdLow=-4638992594902767826,
spanId=7929822056569588882,
parentSpanId=1229782938247303441,
operationName='test1',
startTime=1502820146071158,
duration=10000000,
flags=1,
tags=[
jaeger.Tag(key='key_bool',
vType=jaeger.TagType.BOOL,
vBool=False),
jaeger.Tag(key='key_string',
vType=jaeger.TagType.STRING,
vStr='hello_world'),
jaeger.Tag(key='key_int',
vType=jaeger.TagType.LONG,
vLong=3),
jaeger.Tag(key='status.code',
vType=jaeger.TagType.LONG,
vLong=200),
jaeger.Tag(key='status.message',
vType=jaeger.TagType.STRING,
vStr='success')
],
references=[
jaeger.SpanRef(refType=jaeger.SpanRefType.CHILD_OF,
traceIdHigh=7929822056569588882,
traceIdLow=-4638992594902767826,
spanId=7929822056569588882),
jaeger.SpanRef(refType=jaeger.SpanRefType.FOLLOWS_FROM,
traceIdHigh=7929822056569588882,
traceIdLow=-4638992594902767826,
spanId=7929822056569588882),
jaeger.SpanRef(refType=None,
traceIdHigh=7929822056569588882,
traceIdLow=-4638992594902767826,
spanId=7929822056569588882)
],
logs=[
jaeger.Log(timestamp=1502820146071158,
fields=[
jaeger.Tag(key='annotation_bool',
vType=jaeger.TagType.BOOL,
vBool=True),
jaeger.Tag(key='annotation_string',
vType=jaeger.TagType.STRING,
vStr='annotation_test'),
jaeger.Tag(key='message',
vType=jaeger.TagType.STRING,
vStr='First Annotation')
])
]),
jaeger.Span(operationName="test2",
traceIdHigh=7929822056569588882,
traceIdLow=-4638992594902767826,
spanId=7929822056569588882,
parentSpanId=0,
startTime=1502820146071158,
duration=10000000,
logs=[
jaeger.Log(timestamp=1502820146071158,
fields=[
jaeger.Tag(
key='message',
vType=jaeger.TagType.STRING,
vStr='First Annotation')
])
]),
jaeger.Span(operationName="test3",
traceIdHigh=7929822056569588882,
traceIdLow=-4638992594902767826,
spanId=7929822056569588882,
parentSpanId=0,
startTime=1502820146071158,
duration=10000000,
logs=[])
]
spans_json = [span.format_span_json() for span in spans]
expected_spans_json = [
span.format_span_json() for span in expected_spans
]
span = spans_json[0]
expected_span = expected_spans_json[0]
try:
listsEqual = self.assertCountEqual
except AttributeError:
listsEqual = self.assertItemsEqual
log = span.get('logs')[0]
expected_log = expected_span.get('logs')[0]
self.assertEqual(log.get('timestamp'), expected_log.get('timestamp'))
listsEqual(log.get('fields'), expected_log.get('fields'))
listsEqual(span.get('tags'), expected_span.get('tags'))
listsEqual(span.get('references'), expected_span.get('references'))
self.assertEqual(span.get('traceIdHigh'),
expected_span.get('traceIdHigh'))
self.assertEqual(span.get('traceIdLow'),
expected_span.get('traceIdLow'))
self.assertEqual(span.get('spanId'), expected_span.get('spanId'))
self.assertEqual(span.get('parentSpanId'),
expected_span.get('parentSpanId'))
self.assertEqual(span.get('operationName'),
expected_span.get('operationName'))
self.assertEqual(span.get('startTime'), expected_span.get('startTime'))
self.assertEqual(span.get('duration'), expected_span.get('duration'))
self.assertEqual(span.get('flags'), expected_span.get('flags'))
self.assertEqual(spans_json[1], expected_spans_json[1])
self.assertEqual(spans_json[2], expected_spans_json[2])
def test_translate_time_events(self):
annotation0_ts = datetime.utcnow() + timedelta(seconds=-10)
annotation1_ts = datetime.utcnow() + timedelta(seconds=-9)
message0_ts = datetime.utcnow() + timedelta(seconds=-8)
message1_ts = datetime.utcnow() + timedelta(seconds=-7)
message2_ts = datetime.utcnow() + timedelta(seconds=-6)
span_data = span_data_module.SpanData(
context=span_context_module.SpanContext(
trace_id='6e0c63257de34c92bf9efcd03927272e'),
span_id='6e0c63257de34c92',
time_events=[
time_event_module.TimeEvent(
timestamp=annotation0_ts,
annotation=time_event_module.Annotation(
description="hi there0",
attributes=attributes_module.Attributes(
attributes={
'test_str_key': 'test_str_value',
'test_int_key': 1,
'test_bool_key': False,
'test_double_key': 567.89
}))),
time_event_module.TimeEvent(
timestamp=annotation1_ts,
annotation=time_event_module.Annotation(
description="hi there1")),
time_event_module.TimeEvent(
timestamp=message0_ts,
message_event=time_event_module.MessageEvent(
id=0,
type=time_event_module.Type.SENT,
uncompressed_size_bytes=10,
compressed_size_bytes=1)),
time_event_module.TimeEvent(
timestamp=message1_ts,
message_event=time_event_module.MessageEvent(
id=1,
type=time_event_module.Type.RECEIVED,
uncompressed_size_bytes=20,
compressed_size_bytes=2)),
time_event_module.TimeEvent(
timestamp=message2_ts,
message_event=time_event_module.MessageEvent(
id=2,
type=time_event_module.Type.TYPE_UNSPECIFIED,
uncompressed_size_bytes=30,
compressed_size_bytes=3))
],
span_kind=span_module.SpanKind.SERVER,
status=None,
start_time=None,
end_time=None,
child_span_count=None,
name=None,
parent_span_id=None,
attributes=None,
same_process_as_parent_span=False,
stack_trace=None,
links=None)
pb_span = utils.translate_to_trace_proto(span_data)
self.assertEqual(len(pb_span.time_events.time_event), 5)
event0 = pb_span.time_events.time_event[0]
event1 = pb_span.time_events.time_event[1]
event2 = pb_span.time_events.time_event[2]
event3 = pb_span.time_events.time_event[3]
event4 = pb_span.time_events.time_event[4]
self.assertEqual(event0.time.ToDatetime(), annotation0_ts)
self.assertEqual(event1.time.ToDatetime(), annotation1_ts)
self.assertEqual(event2.time.ToDatetime(), message0_ts)
self.assertEqual(event3.time.ToDatetime(), message1_ts)
self.assertEqual(event4.time.ToDatetime(), message2_ts)
self.assertEqual(event0.annotation.description.value, "hi there0")
self.assertEqual(event1.annotation.description.value, "hi there1")
self.assertEqual(len(event0.annotation.attributes.attribute_map), 4)
self.assertEqual(len(event1.annotation.attributes.attribute_map), 0)
self.assertEqual(
event0.annotation.attributes.attribute_map['test_str_key'],
trace_pb2.AttributeValue(string_value=trace_pb2.TruncatableString(
value='test_str_value')))
self.assertEqual(
event0.annotation.attributes.attribute_map['test_int_key'],
trace_pb2.AttributeValue(int_value=1))
self.assertEqual(
event0.annotation.attributes.attribute_map['test_bool_key'],
trace_pb2.AttributeValue(bool_value=False))
self.assertEqual(
event0.annotation.attributes.attribute_map['test_double_key'],
trace_pb2.AttributeValue(double_value=567.89))
self.assertEqual(event2.message_event.id, 0)
self.assertEqual(event3.message_event.id, 1)
self.assertEqual(event4.message_event.id, 2)
self.assertEqual(event2.message_event.uncompressed_size, 10)
self.assertEqual(event3.message_event.uncompressed_size, 20)
self.assertEqual(event4.message_event.uncompressed_size, 30)
self.assertEqual(event2.message_event.compressed_size, 1)
self.assertEqual(event3.message_event.compressed_size, 2)
self.assertEqual(event4.message_event.compressed_size, 3)
self.assertEqual(event2.message_event.type, 1)
self.assertEqual(event3.message_event.type, 2)
self.assertEqual(event4.message_event.type, 0)