Rename attributes to the default naming schema and use standard http attributes (#272)

Author: Liudmila Molkova

opencensus/trace/attributes_helper.py

@@ -14,28 +14,28 @@
 
 COMMON_ATTRIBUTES = {
     'AGENT': 'g.co/agent',
-    'COMPONENT': '/component',
-    'ERROR_MESSAGE': '/error/message',
-    'ERROR_NAME': '/error/name',
-    'HTTP_CLIENT_CITY': '/http/client_city',
-    'HTTP_CLIENT_COUNTRY': '/http/client_country',
-    'HTTP_CLIENT_PROTOCOL': '/http/client_protocol',
-    'HTTP_CLIENT_REGION': '/http/client_region',
-    'HTTP_HOST': '/http/host',
-    'HTTP_METHOD': '/http/method',
-    'HTTP_REDIRECTED_URL': '/http/redirected_url',
-    'HTTP_REQUEST_SIZE': '/http/request/size',
-    'HTTP_RESPONSE_SIZE': '/http/response/size',
-    'HTTP_STATUS_CODE': '/http/status_code',
-    'HTTP_URL': '/http/url',
-    'HTTP_USER_AGENT': '/http/user_agent',
-    'PID': '/pid',
-    'STACKTRACE': '/stacktrace',
-    'TID': '/tid',
+    'COMPONENT': 'component',
+    'ERROR_MESSAGE': 'error.message',
+    'ERROR_NAME': 'error.name',
+    'HTTP_CLIENT_CITY': 'http.client_city',
+    'HTTP_CLIENT_COUNTRY': 'http.client_country',
+    'HTTP_CLIENT_PROTOCOL': 'http.client_protocol',
+    'HTTP_CLIENT_REGION': 'http.client_region',
+    'HTTP_HOST': 'http.host',
+    'HTTP_METHOD': 'http.method',
+    'HTTP_REDIRECTED_URL': 'http.redirected_url',
+    'HTTP_REQUEST_SIZE': 'http.request_size',
+    'HTTP_RESPONSE_SIZE': 'http.response_size',
+    'HTTP_STATUS_CODE': 'http.status_code',
+    'HTTP_URL': 'http.url',
+    'HTTP_USER_AGENT': 'http.user_agent',
+    'PID': 'pid',
+    'STACKTRACE': 'stacktrace',
+    'TID': 'tid',
 }
 
 
 GRPC_ATTRIBUTES = {
-    'GRPC_HOST_PORT': '/grpc/host_port',
-    'GRPC_METHOD': '/grpc/method',
+    'GRPC_HOST_PORT': 'grpc.host_port',
+    'GRPC_METHOD': 'grpc.method',
 }

opencensus/trace/exporters/stackdriver_exporter.py

@@ -125,6 +125,7 @@ class StackdriverExporter(base.Exporter):
                       :class:`.SyncTransport`. The other option is
                       :class:`.BackgroundThreadTransport`.
     """
+
     def __init__(self, client=None, project_id=None,
                  transport=sync.SyncTransport):
         # The client will handle the case when project_id is None
@@ -187,7 +188,7 @@ def translate_to_stackdriver(self, trace):
                 'startTime': span.get('startTime'),
                 'endTime': span.get('endTime'),
                 'spanId': str(span.get('spanId')),
-                'attributes': span.get('attributes'),
+                'attributes': self.map_attributes(span.get('attributes')),
                 'links': span.get('links'),
                 'status': span.get('status'),
                 'stackTrace': span.get('stackTrace'),
@@ -204,3 +205,46 @@ def translate_to_stackdriver(self, trace):
 
         spans = {'spans': spans_list}
         return spans
+
+    def map_attributes(self, attribute_map):
+        if attribute_map is None:
+            return attribute_map
+
+        for (key, value) in attribute_map.items():
+            if (key != 'attributeMap'):
+                continue
+            for attribute_key in list(value.keys()):
+                if (attribute_key in ATTRIBUTE_MAPPING):
+                    new_key = ATTRIBUTE_MAPPING.get(attribute_key)
+                    value[new_key] = value.pop(attribute_key)
+
+        return attribute_map
+
+
+ATTRIBUTE_MAPPING = {
+    'component': '/component',
+    'error.message': '/error/message',
+    'error.name': '/error/name',
+    'http.client_city': '/http/client_city',
+    'http.client_country': '/http/client_country',
+    'http.client_protocol': '/http/client_protocol',
+    'http.client_region': '/http/client_region',
+
+    'http.host': '/http/host',
+    'http.method': '/http/method',
+
+    'http.redirected_url': '/http/redirected_url',
+    'http.request_size': '/http/request/size',
+    'http.response_size': '/http/response/size',
+
+    'http.status_code': '/http/status_code',
+    'http.url': '/http/url',
+    'http.user_agent': '/http/user_agent',
+
+    'pid': '/pid',
+    'stacktrace': '/stacktrace',
+    'tid': '/tid',
+
+    'grpc.host_port': '/grpc/host_port',
+    'grpc.method': '/grpc/method',
+}

opencensus/trace/ext/dbapi/trace.py

@@ -57,9 +57,9 @@ def call(query, *args, **kwargs):
         _span = _tracer.start_span()
         _span.name = 'mysql.query'
         _span.span_kind = span_module.SpanKind.CLIENT
-        _tracer.add_attribute_to_current_span('mysql/query', query)
+        _tracer.add_attribute_to_current_span('mysql.query', query)
         _tracer.add_attribute_to_current_span(
-            'mysql/cursor/method/name',
+            'mysql.cursor.method.name',
             query_func.__name__)
 
         result = query_func(query, *args, **kwargs)

opencensus/trace/ext/django/middleware.py

@@ -85,10 +85,10 @@ def _set_django_attributes(tracer, request):
 
     # User id is the django autofield for User model as the primary key
     if user_id is not None:
-        tracer.add_attribute_to_current_span('/django/user/id', str(user_id))
+        tracer.add_attribute_to_current_span('django.user.id', str(user_id))
 
     if user_name is not None:
-        tracer.add_attribute_to_current_span('/django/user/name', user_name)
+        tracer.add_attribute_to_current_span('django.user.name', user_name)
 
 
 class OpencensusMiddleware(MiddlewareMixin):

opencensus/trace/ext/httplib/trace.py

@@ -58,6 +58,7 @@ def wrap_httplib_request(request_func):
     """Wrap the httplib request function to trace. Create a new span and update
     and close the span in the response later.
     """
+
     def call(self, method, url, body, headers, *args, **kwargs):
         _tracer = execution_context.get_opencensus_tracer()
         _span = _tracer.start_span()
@@ -90,6 +91,7 @@ def wrap_httplib_response(response_func):
     If there is a corresponding httplib request span, update and close it.
     If not, return the response.
     """
+
     def call(self, *args, **kwargs):
         _tracer = execution_context.get_opencensus_tracer()
         current_span_id = execution_context.get_opencensus_attr(

opencensus/trace/ext/postgresql/trace.py

@@ -58,9 +58,9 @@ def call(query, *args, **kwargs):
             _span.name = '{}.query'.format(MODULE_NAME)
             _span.span_kind = span_module.SpanKind.CLIENT
             _tracer.add_attribute_to_current_span(
-                '{}/query'.format(MODULE_NAME), query)
+                '{}.query'.format(MODULE_NAME), query)
             _tracer.add_attribute_to_current_span(
-                '{}/cursor/method/name'.format(MODULE_NAME),
+                '{}.cursor.method.name'.format(MODULE_NAME),
                 query_func.__name__)
 
         result = query_func(query, *args, **kwargs)

opencensus/trace/ext/pyramid/pyramid_middleware.py

@@ -43,6 +43,7 @@ class OpenCensusTweenFactory(object):
     For details on pyramid tweens, see
     https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/hooks.html#creating-a-tween
     """
+
     def __init__(self, handler, registry):
         """Constructor for the pyramid tween
 

opencensus/trace/ext/requests/trace.py

@@ -16,6 +16,7 @@
 import requests
 import wrapt
 
+from opencensus.trace import attributes_helper
 from opencensus.trace import execution_context
 from opencensus.trace import span as span_module
 
@@ -27,6 +28,9 @@
 SESSION_WRAP_METHODS = 'request'
 SESSION_CLASS_NAME = 'Session'
 
+HTTP_URL = attributes_helper.COMMON_ATTRIBUTES['HTTP_URL']
+HTTP_STATUS_CODE = attributes_helper.COMMON_ATTRIBUTES['HTTP_STATUS_CODE']
+
 
 def trace_integration(tracer=None):
     """Wrap the requests library to trace it."""
@@ -54,13 +58,13 @@ def call(url, *args, **kwargs):
         _span.span_kind = span_module.SpanKind.CLIENT
 
         # Add the requests url to attributes
-        _tracer.add_attribute_to_current_span('requests/url', url)
+        _tracer.add_attribute_to_current_span(HTTP_URL, url)
 
         result = requests_func(url, *args, **kwargs)
 
         # Add the status code to attributes
         _tracer.add_attribute_to_current_span(
-            'requests/status_code', str(result.status_code))
+            HTTP_STATUS_CODE, str(result.status_code))
 
         _tracer.end_span()
         return result
@@ -79,13 +83,13 @@ def wrap_session_request(wrapped, instance, args, kwargs):
     _span.span_kind = span_module.SpanKind.CLIENT
 
     # Add the requests url to attributes
-    _tracer.add_attribute_to_current_span('requests/url', url)
+    _tracer.add_attribute_to_current_span(HTTP_URL, url)
 
     result = wrapped(*args, **kwargs)
 
     # Add the status code to attributes
     _tracer.add_attribute_to_current_span(
-        'requests/status_code', str(result.status_code))
+        HTTP_STATUS_CODE, str(result.status_code))
 
     _tracer.end_span()
     return result

opencensus/trace/ext/sqlalchemy/trace.py

@@ -68,15 +68,15 @@ def _before_cursor_execute(conn, cursor, statement, parameters,
 
     # Set query statement attribute
     _tracer.add_attribute_to_current_span(
-        '{}/query'.format(MODULE_NAME), statement)
+        '{}.query'.format(MODULE_NAME), statement)
 
     # Set query parameters attribute
     _tracer.add_attribute_to_current_span(
-        '{}/query/parameters'.format(MODULE_NAME), str(parameters))
+        '{}.query.parameters'.format(MODULE_NAME), str(parameters))
 
     # Set query function attribute
     _tracer.add_attribute_to_current_span(
-        '{}/cursor/method/name'.format(MODULE_NAME),
+        '{}.cursor.method.name'.format(MODULE_NAME),
         query_func)
 
 

tests/system/trace/django/django_system_test.py

@@ -30,8 +30,8 @@
 HOST_PORT = 'localhost:8000'
 BASE_URL = 'http://localhost:8000/'
 
-RETRY_WAIT_PERIOD = 8000 # Wait 8 seconds between each retry
-RETRY_MAX_ATTEMPT = 10 # Retry 10 times
+RETRY_WAIT_PERIOD = 8000  # Wait 8 seconds between each retry
+RETRY_MAX_ATTEMPT = 10  # Retry 10 times
 
 
 def wait_app_to_start():
@@ -53,7 +53,8 @@ def generate_header():
 
 def run_application():
     """Start running the django application."""
-    cmd = 'python tests/system/trace/django/manage.py runserver {}'.format(HOST_PORT)
+    cmd = 'python tests/system/trace/django/manage.py runserver {}'.format(
+        HOST_PORT)
     process = subprocess.Popen(
         cmd,
         stdout=subprocess.PIPE,
@@ -138,8 +139,9 @@ def test_with_retry(self):
                     request_succeeded = True
 
                 if span.get('name') == '[mysql.query]SELECT 2*3':
-                    self.assertEqual(labels.get('mysql/cursor/method/name'), 'execute')
-                    self.assertEqual(labels.get('mysql/query'), 'SELECT 2*3')
+                    self.assertEqual(labels.get(
+                        'mysql.cursor.method.name'), 'execute')
+                    self.assertEqual(labels.get('mysql.query'), 'SELECT 2*3')
 
             self.assertTrue(request_succeeded)
 
@@ -170,8 +172,10 @@ def test_with_retry(self):
                     request_succeeded = True
 
                 if span.get('name') == '[postgresql.query]SELECT 2*3':
-                    self.assertEqual(labels.get('postgresql/cursor/method/name'), 'execute')
-                    self.assertEqual(labels.get('postgresql/query'), 'SELECT 2*3')
+                    self.assertEqual(labels.get(
+                        'postgresql.cursor.method.name'), 'execute')
+                    self.assertEqual(labels.get(
+                        'postgresql.query'), 'SELECT 2*3')
 
             self.assertTrue(request_succeeded)