Rename label(s) to attribute(s) (#89)

Author: liyanhui1228

README.rst

@@ -69,7 +69,6 @@ Alternatively, you can explicitly start and end a span:
 
     # Initialize a tracer, by default using the `PrintExporter`
     tracer = request_tracer.RequestTracer()
-    tracer.start_trace()
 
     tracer.start_span(name='span1')
     do_something_to_trace()

trace/opencensus/trace/labels_helper.py …ce/opencensus/trace/attributes_helper.pytrace/opencensus/trace/labels_helper.py renamed to trace/opencensus/trace/attributes_helper.py trace/opencensus/trace/labels_helper.py renamed to trace/opencensus/trace/attributes_helper.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-COMMON_LABELS = {
+COMMON_ATTRIBUTES = {
     'AGENT': '/agent',
     'COMPONENT': '/component',
     'ERROR_MESSAGE': '/error/message',

trace/opencensus/trace/exporters/stackdriver_exporter.py

@@ -25,10 +25,10 @@
 # Environment variable set in App Engine when env:flex is set.
 _APPENGINE_FLEXIBLE_ENV_FLEX = 'GAE_INSTANCE'
 
-# GAE common labels
+# GAE common attributes
 # See: https://cloud.google.com/appengine/docs/flexible/python/runtime#
 #      environment_variables
-GAE_LABELS = {
+GAE_ATTRIBUTES = {
     'GAE_FLEX_VERSION': 'g.co/gae/app/version',
     'GAE_FLEX_SERVICE': 'g.co/gae/app/service',
     'GAE_FLEX_PROJECT': 'g.co/gae/app/project',
@@ -37,31 +37,31 @@
     'GAE_FLEX_PORT': 'g.co/gae/app/port',
 }
 
-# GCE common labels
-GCE_LABELS = {
+# GCE common attributes
+GCE_ATTRIBUTES = {
     'GCE_INSTANCE_ID': 'g.co/gce/instanceid',
     'GCE_HOSTNAME': 'g.co/gce/hostname',
 }
 
 
-def set_labels(trace):
-    """Automatically set labels for Google Cloud environment."""
+def set_attributes(trace):
+    """Automatically set attributes for Google Cloud environment."""
     if is_gae_environment():
-        set_gae_labels(trace)
+        set_gae_attributes(trace)
 
 
-def set_gae_labels(trace):
-    """Set the GAE environment common labels."""
+def set_gae_attributes(trace):
+    """Set the GAE environment common attributes."""
     spans = trace.get('spans')
 
-    for env_var, label_key in GAE_LABELS.items():
-        label_value = os.environ.get(env_var)
+    for env_var, attribute_key in GAE_ATTRIBUTES.items():
+        attribute_value = os.environ.get(env_var)
 
-        if label_value is not None:
+        if attribute_value is not None:
             for span in spans:
-                labels = span.get('labels')
-                labels[label_key] = label_value
-                span['labels'] = labels
+                attributes = span.get('attributes')
+                attributes[attribute_key] = attribute_value
+                span['attributes'] = attributes
 
 
 def is_gae_environment():
@@ -117,7 +117,27 @@ def translate_to_stackdriver(self, trace):
         :rtype: dict
         :returns: Traces in Google Cloud StackDriver Trace format.
         """
-        set_labels(trace)
-        trace['projectId'] = self.project_id
-        traces = {'traces': [trace]}
+        set_attributes(trace)
+        spans = trace.get('spans')
+        trace_id = trace.get('traceId')
+        spans_json = []
+
+        for span in spans:
+            span_json = {
+                'name': span.get('name'),
+                'startTime': span.get('startTime'),
+                'endTime': span.get('endTime'),
+                'spanId': span.get('spanId'),
+                'parentSpanId': span.get('parentSpanId'),
+                'labels': span.get('attributes')
+            }
+            spans_json.append(span_json)
+
+        trace_json = {
+            'projectId': self.project_id,
+            'traceId': trace_id,
+            'spans': spans_json
+        }
+
+        traces = {'traces': [trace_json]}
         return traces

trace/opencensus/trace/exporters/zipkin_exporter.py

@@ -155,7 +155,7 @@ def translate_to_zipkin(self, trace_id, spans):
                 'timestamp': int(round(start_timestamp_ms)),
                 'duration': int(round(duration_ms)),
                 'localEndpoint': local_endpoint,
-                'tags': span.get('labels'),
+                'tags': span.get('attributes'),
             }
 
             span_kind = span.get('kind')

trace/opencensus/trace/ext/dbapi/trace.py

@@ -55,8 +55,8 @@ def call(query, *args, **kwargs):
         _tracer = execution_context.get_opencensus_tracer()
         _span = _tracer.start_span()
         _span.name = 'mysql.query'
-        _tracer.add_label_to_current_span('mysql/query', query)
-        _tracer.add_label_to_current_span(
+        _tracer.add_attribute_to_current_span('mysql/query', query)
+        _tracer.add_attribute_to_current_span(
             'mysql/cursor/method/name',
             query_func.__name__)
 

trace/opencensus/trace/ext/django/middleware.py

@@ -17,7 +17,7 @@
 
 from opencensus.trace.ext import utils
 from opencensus.trace.ext.django.config import (settings, convert_to_import)
-from opencensus.trace import labels_helper
+from opencensus.trace import attributes_helper
 from opencensus.trace import request_tracer
 from opencensus.trace import execution_context
 from opencensus.trace.samplers import probability
@@ -27,9 +27,9 @@
 except ImportError:  # pragma: NO COVER
     MiddlewareMixin = object
 
-HTTP_METHOD = labels_helper.COMMON_LABELS['HTTP_METHOD']
-HTTP_URL = labels_helper.COMMON_LABELS['HTTP_URL']
-HTTP_STATUS_CODE = labels_helper.COMMON_LABELS['HTTP_STATUS_CODE']
+HTTP_METHOD = attributes_helper.COMMON_ATTRIBUTES['HTTP_METHOD']
+HTTP_URL = attributes_helper.COMMON_ATTRIBUTES['HTTP_URL']
+HTTP_STATUS_CODE = attributes_helper.COMMON_ATTRIBUTES['HTTP_STATUS_CODE']
 
 REQUEST_THREAD_LOCAL_KEY = 'django_request'
 
@@ -61,8 +61,8 @@ def _get_current_request_tracer():
     return execution_context.get_opencensus_tracer()
 
 
-def _set_django_labels(tracer, request):
-    """Set the django related labels."""
+def _set_django_attributes(tracer, request):
+    """Set the django related attributes."""
     django_user = getattr(request, 'user', None)
 
     if django_user is None:
@@ -73,10 +73,10 @@ def _set_django_labels(tracer, request):
 
     # User id is the django autofield for User model as the primary key
     if user_id is not None:
-        tracer.add_label_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_label_to_current_span('/django/user/name', user_name)
+        tracer.add_attribute_to_current_span('/django/user/name', user_name)
 
 
 def get_django_header():
@@ -167,12 +167,12 @@ def process_request(self, request):
 
             # Span name is being set at process_view
             tracer.start_span()
-            tracer.add_label_to_current_span(
-                label_key=HTTP_METHOD,
-                label_value=request.method)
-            tracer.add_label_to_current_span(
-                label_key=HTTP_URL,
-                label_value=request.path)
+            tracer.add_attribute_to_current_span(
+                attribute_key=HTTP_METHOD,
+                attribute_value=request.method)
+            tracer.add_attribute_to_current_span(
+                attribute_key=HTTP_URL,
+                attribute_value=request.path)
         except Exception:  # pragma: NO COVER
             log.error('Failed to trace request', exc_info=True)
 
@@ -200,11 +200,11 @@ def process_response(self, request, response):
 
         try:
             tracer = _get_current_request_tracer()
-            tracer.add_label_to_current_span(
-                label_key=HTTP_STATUS_CODE,
-                label_value=str(response.status_code))
+            tracer.add_attribute_to_current_span(
+                attribute_key=HTTP_STATUS_CODE,
+                attribute_value=str(response.status_code))
 
-            _set_django_labels(tracer, request)
+            _set_django_attributes(tracer, request)
 
             tracer.end_span()
             tracer.finish()

trace/opencensus/trace/ext/flask/flask_middleware.py

@@ -15,7 +15,7 @@
 import flask
 import logging
 
-from opencensus.trace import labels_helper
+from opencensus.trace import attributes_helper
 from opencensus.trace import execution_context
 from opencensus.trace.propagation import google_cloud_format
 from opencensus.trace.exporters import print_exporter
@@ -25,9 +25,9 @@
 
 _FLASK_TRACE_HEADER = 'X_CLOUD_TRACE_CONTEXT'
 
-HTTP_METHOD = labels_helper.COMMON_LABELS['HTTP_METHOD']
-HTTP_URL = labels_helper.COMMON_LABELS['HTTP_URL']
-HTTP_STATUS_CODE = labels_helper.COMMON_LABELS['HTTP_STATUS_CODE']
+HTTP_METHOD = attributes_helper.COMMON_ATTRIBUTES['HTTP_METHOD']
+HTTP_URL = attributes_helper.COMMON_ATTRIBUTES['HTTP_URL']
+HTTP_STATUS_CODE = attributes_helper.COMMON_ATTRIBUTES['HTTP_STATUS_CODE']
 
 log = logging.getLogger(__name__)
 
@@ -107,8 +107,9 @@ def _before_request(self):
             span.name = '[{}]{}'.format(
                 flask.request.method,
                 flask.request.url)
-            tracer.add_label_to_current_span(HTTP_METHOD, flask.request.method)
-            tracer.add_label_to_current_span(HTTP_URL, flask.request.url)
+            tracer.add_attribute_to_current_span(
+                HTTP_METHOD, flask.request.method)
+            tracer.add_attribute_to_current_span(HTTP_URL, flask.request.url)
         except Exception:  # pragma: NO COVER
             log.error('Failed to trace request', exc_info=True)
 
@@ -123,7 +124,7 @@ def _after_request(self, response):
 
         try:
             tracer = execution_context.get_opencensus_tracer()
-            tracer.add_label_to_current_span(
+            tracer.add_attribute_to_current_span(
                 HTTP_STATUS_CODE,
                 str(response.status_code))
 

trace/opencensus/trace/ext/postgresql/trace.py

@@ -50,9 +50,9 @@ def call(query, *args, **kwargs):
         _tracer = execution_context.get_opencensus_tracer()
         _span = _tracer.start_span()
         _span.name = '{}.query'.format(MODULE_NAME)
-        _tracer.add_label_to_current_span(
+        _tracer.add_attribute_to_current_span(
             '{}/query'.format(MODULE_NAME), query)
-        _tracer.add_label_to_current_span(
+        _tracer.add_attribute_to_current_span(
             '{}/cursor/method/name'.format(MODULE_NAME),
             query_func.__name__)
 

trace/opencensus/trace/ext/requests/trace.py

@@ -47,13 +47,13 @@ def call(url, *args, **kwargs):
         _span = _tracer.start_span()
         _span.name = '[requests]{}'.format(requests_func.__name__)
 
-        # Add the requests url to labels
-        _tracer.add_label_to_current_span('requests/url', url)
+        # Add the requests url to attributes
+        _tracer.add_attribute_to_current_span('requests/url', url)
 
         result = requests_func(url, *args, **kwargs)
 
-        # Add the status code to labels
-        _tracer.add_label_to_current_span(
+        # Add the status code to attributes
+        _tracer.add_attribute_to_current_span(
             'requests/status_code', str(result.status_code))
 
         _tracer.end_span()
@@ -69,13 +69,13 @@ def call(method, url, *args, **kwargs):
         _span = _tracer.start_span()
         _span.name = '[requests]{}'.format(method)
 
-        # Add the requests url to labels
-        _tracer.add_label_to_current_span('requests/url', url)
+        # Add the requests url to attributes
+        _tracer.add_attribute_to_current_span('requests/url', url)
 
         result = request_func(method, url, *args, **kwargs)
 
-        # Add the status code to labels
-        _tracer.add_label_to_current_span(
+        # Add the status code to attributes
+        _tracer.add_attribute_to_current_span(
             'requests/status_code', str(result.status_code))
 
         _tracer.end_span()

trace/opencensus/trace/ext/sqlalchemy/trace.py

@@ -64,16 +64,16 @@ def _before_cursor_execute(conn, cursor, statement, parameters,
     _span = _tracer.start_span()
     _span.name = '[{}.query]{}'.format(MODULE_NAME, statement)
 
-    # Set query statement label
-    _tracer.add_label_to_current_span(
+    # Set query statement attribute
+    _tracer.add_attribute_to_current_span(
         '{}/query'.format(MODULE_NAME), statement)
 
-    # Set query parameters label
-    _tracer.add_label_to_current_span(
+    # Set query parameters attribute
+    _tracer.add_attribute_to_current_span(
         '{}/query/parameters'.format(MODULE_NAME), str(parameters))
 
-    # Set query function label
-    _tracer.add_label_to_current_span(
+    # Set query function attribute
+    _tracer.add_attribute_to_current_span(
         '{}/cursor/method/name'.format(MODULE_NAME),
         query_func)