def test_constructor_zipkin(self):
service_name = 'test_service'
host_name = 'test_hostname'
port = 2333
response = Response()
def dummy_handler(request):
return response
exporter = zipkin_exporter.ZipkinExporter(service_name=service_name,
host_name=host_name,
port=port,
transport=sync.SyncTransport)
mock_registry = mock.Mock(spec=Registry)
mock_registry.settings = {}
mock_registry.settings['OPENCENSUS_TRACE'] = {
'EXPORTER': exporter,
}
middleware = pyramid_middleware.OpenCensusTweenFactory(
dummy_handler,
mock_registry,
)
assert isinstance(middleware.sampler, always_on.AlwaysOnSampler)
assert isinstance(middleware.exporter, zipkin_exporter.ZipkinExporter)
assert isinstance(middleware.propagator,
google_cloud_format.GoogleCloudFormatPropagator)
self.assertEqual(middleware.exporter.service_name, service_name)
self.assertEqual(middleware.exporter.host_name, host_name)
self.assertEqual(middleware.exporter.port, port)
def create_exporter(service_name):
"""Creates and returns new Zipkin exporter populated from settings values."""
return zipkin.ZipkinExporter(
service_name=service_name,
host_name=getattr(settings, 'TRACING_HOST', 'zipkin'),
port=getattr(settings, 'TRACING_PORT', 9411),
endpoint=getattr(settings, 'TRACING_API', '/api/v2/spans'),
)
def test_emit_failed(self, translate_mock, requests_mock):
import json
trace = {'test': 'this_is_for_test'}
exporter = trace_exporter.ZipkinExporter(service_name='my_service')
response = mock.Mock()
response.status_code = 400
requests_mock.return_value = response
translate_mock.return_value = trace
exporter.emit([])
requests_mock.assert_called_once_with(
url=exporter.url,
data=json.dumps(trace),
headers=trace_exporter.ZIPKIN_HEADERS)
def test_constructor(self):
service_name = 'my_service'
host_name = '0.0.0.0'
port = 2333
endpoint = '/api/v2/test'
ipv4 = '127.0.0.1'
exporter = trace_exporter.ZipkinExporter(service_name=service_name,
host_name=host_name,
port=port,
endpoint=endpoint,
ipv4=ipv4)
expected_url = 'http://0.0.0.0:2333/api/v2/test'
self.assertEqual(exporter.service_name, service_name)
self.assertEqual(exporter.host_name, host_name)
self.assertEqual(exporter.port, port)
self.assertEqual(exporter.endpoint, endpoint)
self.assertEqual(exporter.url, expected_url)
self.assertEqual(exporter.ipv4, ipv4)
def test_translate_to_zipkin_span_kind_none(self):
trace_id = '6e0c63257de34c92bf9efcd03927272e'
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=None,
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=None,
links=None,
status=None,
same_process_as_parent_span=None,
span_kind=None,
),
]
trace_id = '6e0c63257de34c92bf9efcd03927272e'
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=None,
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': [],
},
{
'traceId': '6e0c63257de34c92bf9efcd03927272e',
'id': '6e0c63257de34c92',
'parentId': '6e0c63257de34c93',
'name': 'child_span',
'timestamp': 1502820146071158,
'duration': 10000000,
'localEndpoint': local_endpoint_ipv4,
'tags': {
'test_key': '1'
},
'annotations': [],
},
]
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': [],
},
]
# 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_export(self):
exporter = trace_exporter.ZipkinExporter(service_name='my_service',
transport=MockTransport)
exporter.export({})
self.assertTrue(exporter.transport.export_called)
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)
from opencensus.trace.samplers import always_on, always_off
from opencensus.trace.tracer import Tracer
logger = logging.getLogger(__name__)
logger.setLevel(logging.INFO)
def is_enabled():
return getattr(settings, 'TRACING_ENABLED', False)
# Setup the exporter
ze = zipkin.ZipkinExporter(service_name=getattr(settings, 'TRACING_SERVICE',
'snoop'),
host_name=getattr(settings, 'TRACING_HOST',
'zipkin'),
port=getattr(settings, 'TRACING_PORT', 9411),
endpoint=getattr(settings, 'TRACING_API',
'/api/v2/spans'))
# If enabled configure 100% sample rate, otherwise, 0% sample rate
if is_enabled():
sampler = always_on.AlwaysOnSampler()
else:
sampler = always_off.AlwaysOffSampler()
# Set the tracer to use the exporter
# Get the global singleton Tracer object
tracer = Tracer(exporter=ze, sampler=sampler)
tracer.span('root')
