Rename reporters to exporters (#42)

Author: liyanhui1228

…e/opencensus/trace/reporters/__init__.py …e/opencensus/trace/exporters/__init__.pytrace/opencensus/trace/reporters/__init__.py renamed to trace/opencensus/trace/exporters/__init__.py trace/opencensus/trace/reporters/__init__.py renamed to trace/opencensus/trace/exporters/__init__.py

@@ -12,15 +12,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Module containing base class for reporters."""
+"""Module containing base class for exporters."""
 
 
-class Reporter(object):
-    """Base class for opencensus trace request reporters.
+class Exporter(object):
+    """Base class for opencensus trace request exporters.
 
-    Subclasses of :class:`Reporter` must override :meth:`report`.
+    Subclasses of :class:`Exporter` must override :meth:`export`.
     """
 
-    def report(self, trace):
+    def export(self, trace):
         """Export the trace."""
         raise NotImplementedError

trace/opencensus/trace/reporters/base.py trace/opencensus/trace/exporters/base.pytrace/opencensus/trace/reporters/base.py renamed to trace/opencensus/trace/exporters/base.py

@@ -16,12 +16,12 @@
 
 import json
 
-from opencensus.trace.reporters import base
+from opencensus.trace.exporters import base
 
 DEFAULT_FILENAME = 'opencensus-traces.json'
 
 
-class FileReporter(base.Reporter):
+class FileExporter(base.Exporter):
     """
     :type file_name: str
     :param file_name: The name of the output file.
@@ -30,7 +30,7 @@ class FileReporter(base.Reporter):
     def __init__(self, file_name=DEFAULT_FILENAME):
         self.file_name = file_name
 
-    def report(self, trace):
+    def export(self, trace):
         """
         :type trace: dict
         :param trace: Trace collected.

…ncensus/trace/reporters/file_reporter.py …ncensus/trace/exporters/file_exporter.pytrace/opencensus/trace/reporters/file_reporter.py renamed to trace/opencensus/trace/exporters/file_exporter.py trace/opencensus/trace/reporters/file_reporter.py renamed to trace/opencensus/trace/exporters/file_exporter.py

@@ -12,13 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from opencensus.trace.reporters import base
+from opencensus.trace.exporters import base
 
 from google.cloud.trace.client import Client
 
 
-class GoogleCloudReporter(base.Reporter):
-    """A reporter that send traces and trace spans to Google Cloud Stackdriver
+class GoogleCloudExporter(base.Exporter):
+    """A exporter that send traces and trace spans to Google Cloud Stackdriver
     Trace.
     """
     def __init__(self, client=None, project_id=None):
@@ -29,7 +29,7 @@ def __init__(self, client=None, project_id=None):
         self.client = client
         self.project_id = client.project
 
-    def report(self, trace):
+    def export(self, trace):
         """
         :type trace: dict
         :param trace: Trace collected.

…trace/reporters/google_cloud_reporter.py …trace/exporters/google_cloud_exporter.pytrace/opencensus/trace/reporters/google_cloud_reporter.py renamed to trace/opencensus/trace/exporters/google_cloud_exporter.py trace/opencensus/trace/reporters/google_cloud_reporter.py renamed to trace/opencensus/trace/exporters/google_cloud_exporter.py

@@ -16,11 +16,11 @@
 
 import logging
 
-from opencensus.trace.reporters import base
+from opencensus.trace.exporters import base
 
 
-class LoggingReporter(base.Reporter):
-    """A reporter to export the spans data to python logging. Also can use
+class LoggingExporter(base.Exporter):
+    """A exporter to export the spans data to python logging. Also can use
     handlers like CloudLoggingHandler to log to Stackdriver Logging API.
 
     :type handler: :class:`logging.handler`
@@ -32,16 +32,16 @@ class LoggingReporter(base.Reporter):
 
         import google.cloud.logging
         from google.cloud.logging.handlers import CloudLoggingHandler
-        from opencensus.trace.reporters import logging_reporter
+        from opencensus.trace.exporters import logging_exporter
 
         client = google.cloud.logging.Client()
         cloud_handler = CloudLoggingHandler(client)
-        reporter = logging_reporter.LoggingReporter(handler=cloud_handler)
+        exporter = logging_exporter.LoggingExporter(handler=cloud_handler)
 
-        reporter.report(your_spans_list)
+        exporter.export(your_spans_list)
 
-    Or initialize a context tracer with the logging reporter, then the traces
-    will be reported to logging when finished.
+    Or initialize a context tracer with the logging exporter, then the traces
+    will be exported to logging when finished.
     """
 
     def __init__(self, handler=None):
@@ -54,7 +54,7 @@ def __init__(self, handler=None):
         self.logger.addHandler(handler)
         self.logger.setLevel(logging.INFO)
 
-    def report(self, trace):
+    def export(self, trace):
         """
         :type traces: dict
         :param traces: Trace collected.

…nsus/trace/reporters/logging_reporter.py …nsus/trace/exporters/logging_exporter.pytrace/opencensus/trace/reporters/logging_reporter.py renamed to trace/opencensus/trace/exporters/logging_exporter.py trace/opencensus/trace/reporters/logging_reporter.py renamed to trace/opencensus/trace/exporters/logging_exporter.py

@@ -14,12 +14,12 @@
 
 """Export the trace spans by printing them out."""
 
-from opencensus.trace.reporters import base
+from opencensus.trace.exporters import base
 
 
-class PrintReporter(base.Reporter):
-    def report(self, trace):
-        """Report the traces by printing it out.
+class PrintExporter(base.Exporter):
+    def export(self, trace):
+        """export the traces by printing it out.
 
         :type trace: dict
         :param trace: Trace collected.

…census/trace/reporters/print_reporter.py …census/trace/exporters/print_exporter.pytrace/opencensus/trace/reporters/print_reporter.py renamed to trace/opencensus/trace/exporters/print_exporter.py trace/opencensus/trace/reporters/print_reporter.py renamed to trace/opencensus/trace/exporters/print_exporter.py

@@ -20,7 +20,7 @@
 import requests
 import calendar
 
-from opencensus.trace.reporters import base
+from opencensus.trace.exporters import base
 
 DEFAULT_ENDPOINT = '/api/v2/spans'
 DEFAULT_HOST_NAME = 'localhost'
@@ -38,8 +38,8 @@
 SUCCESS_STATUS_CODE = (200, 202)
 
 
-class ZipkinReporter(base.Reporter):
-    """Report the spans to Zipkin.
+class ZipkinExporter(base.Exporter):
+    """export the spans to Zipkin.
 
     See: http://zipkin.io/zipkin-api/#
 
@@ -54,7 +54,7 @@ class ZipkinReporter(base.Reporter):
     :param port: (Optional) The port of the Zipkin server.
 
     :type end_point: str
-    :param end_point: (Optional) The path for the span reporting endpoint.
+    :param end_point: (Optional) The path for the span exporting endpoint.
     """
 
     def __init__(
@@ -76,7 +76,7 @@ def get_url(self):
             self.port,
             self.endpoint)
 
-    def report(self, trace):
+    def export(self, trace):
         """Send trace to Zipkin server, default using the v1 API.
 
         :type trace: dict
@@ -106,7 +106,7 @@ def translate_to_zipkin(self, trace_id, spans):
         :param trace_id: Trace ID.
 
         :type spans: list
-        :param spans: List of spans to be reported.
+        :param spans: List of spans to be exported.
 
         :rtype: list
         :returns: List of zipkin format spans.

…ensus/trace/reporters/zipkin_reporter.py …ensus/trace/exporters/zipkin_exporter.pytrace/opencensus/trace/reporters/zipkin_reporter.py renamed to trace/opencensus/trace/exporters/zipkin_exporter.py trace/opencensus/trace/reporters/zipkin_reporter.py renamed to trace/opencensus/trace/exporters/zipkin_exporter.py

@@ -19,18 +19,18 @@
 
 DEFAULT_DJANGO_TRACER_CONFIG = {
     'SAMPLER': 'opencensus.trace.samplers.always_on.AlwaysOnSampler',
-    'REPORTER':
-        'opencensus.trace.reporters.print_reporter.PrintReporter',
+    'EXPORTER':
+        'opencensus.trace.exporters.print_exporter.PrintExporter',
     'PROPAGATOR': 'opencensus.trace.propagation.google_cloud_format.'
                   'GoogleCloudFormatPropagator',
 }
 
 DEFAULT_DJANGO_TRACER_PARAMS = {
     'SAMPLING_RATE': 0.5,
-    'GCP_REPORTER_PROJECT': None,
-    'ZIPKIN_REPORTER_SERVICE_NAME': 'my_service',
-    'ZIPKIN_REPORTER_HOST_NAME': 'localhost',
-    'ZIPKIN_REPORTER_PORT': 9411,
+    'GCP_EXPORTER_PROJECT': None,
+    'ZIPKIN_EXPORTER_SERVICE_NAME': 'my_service',
+    'ZIPKIN_EXPORTER_HOST_NAME': 'localhost',
+    'ZIPKIN_EXPORTER_PORT': 9411,
 }
 
 
@@ -41,7 +41,7 @@
 
 class DjangoTraceSettings(object):
     """Set the params for a django tracer, including the tracer, sampler and
-    reporter. If the user did not define the settings in django settings file.
+    exporter. If the user did not define the settings in django settings file.
     then use the dafaults.
     """
 

trace/opencensus/trace/ext/django/config.py

@@ -30,11 +30,11 @@
 
 _DJANGO_TRACE_HEADER = 'HTTP_X_CLOUD_TRACE_CONTEXT'
 
-GCP_REPORTER_PROJECT = 'GCP_REPORTER_PROJECT'
+GCP_EXPORTER_PROJECT = 'GCP_EXPORTER_PROJECT'
 SAMPLING_RATE = 'SAMPLING_RATE'
-ZIPKIN_REPORTER_SERVICE_NAME = 'ZIPKIN_REPORTER_SERVICE_NAME'
-ZIPKIN_REPORTER_HOST_NAME = 'ZIPKIN_REPORTER_HOST_NAME'
-ZIPKIN_REPORTER_PORT = 'ZIPKIN_REPORTER_PORT'
+ZIPKIN_EXPORTER_SERVICE_NAME = 'ZIPKIN_EXPORTER_SERVICE_NAME'
+ZIPKIN_EXPORTER_HOST_NAME = 'ZIPKIN_EXPORTER_HOST_NAME'
+ZIPKIN_EXPORTER_PORT = 'ZIPKIN_EXPORTER_PORT'
 
 log = logging.getLogger(__name__)
 
@@ -91,7 +91,7 @@ def __init__(self, get_response=None):
         # One-time configuration and initialization.
         self.get_response = get_response
         self._sampler = settings.SAMPLER
-        self._reporter = settings.REPORTER
+        self._exporter = settings.EXPORTER
         self._propagator = settings.PROPAGATOR
 
         # Initialize the sampler
@@ -102,23 +102,23 @@ def __init__(self, get_response=None):
         else:
             self.sampler = self._sampler()
 
-        # Initialize the reporter
-        if self._reporter.__name__ == 'GoogleCloudReporter':
-            _project_id = settings.params.get(GCP_REPORTER_PROJECT, None)
-            self.reporter = self._reporter(project_id=_project_id)
-        elif self._reporter.__name__ == 'ZipkinReporter':
+        # Initialize the exporter
+        if self._exporter.__name__ == 'GoogleCloudExporter':
+            _project_id = settings.params.get(GCP_EXPORTER_PROJECT, None)
+            self.exporter = self._exporter(project_id=_project_id)
+        elif self._exporter.__name__ == 'ZipkinExporter':
             _zipkin_service_name = settings.params.get(
-                ZIPKIN_REPORTER_SERVICE_NAME, 'my_service')
+                ZIPKIN_EXPORTER_SERVICE_NAME, 'my_service')
             _zipkin_host_name = settings.params.get(
-                ZIPKIN_REPORTER_HOST_NAME, 'localhost')
+                ZIPKIN_EXPORTER_HOST_NAME, 'localhost')
             _zipkin_port = settings.params.get(
-                ZIPKIN_REPORTER_PORT, 9411)
-            self.reporter = self._reporter(
+                ZIPKIN_EXPORTER_PORT, 9411)
+            self.exporter = self._exporter(
                 service_name=_zipkin_service_name,
                 host_name=_zipkin_host_name,
                 port=_zipkin_port)
         else:
-            self.reporter = self._reporter()
+            self.exporter = self._exporter()
 
         # Initialize the propagator
         self.propagator = self._propagator()
@@ -143,7 +143,7 @@ def process_request(self, request):
             tracer = request_tracer.RequestTracer(
                 span_context=span_context,
                 sampler=self.sampler,
-                reporter=self.reporter,
+                exporter=self.exporter,
                 propagator=self.propagator)
 
             tracer.start_trace()

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

@@ -18,7 +18,7 @@
 from opencensus.trace import labels_helper
 from opencensus.trace import execution_context
 from opencensus.trace.propagation import google_cloud_format
-from opencensus.trace.reporters import print_reporter
+from opencensus.trace.exporters import print_exporter
 from opencensus.trace.samplers import always_on
 from opencensus.trace import request_tracer
 
@@ -44,24 +44,24 @@ class FlaskMiddleware(object):
                     :class:`.AlwaysOnSampler`. The rest options are
                     :class:`.AlwaysOffSampler`, :class:`.FixedRateSampler`.
 
-    :type reporter: :class: `type`
-    :param reporter: Class for creating new Reporter objects. Default to
-                     :class:`.PrintReporter`. The rest option is
-                     :class:`.FileReporter`.
+    :type exporter: :class: `type`
+    :param exporter: Class for creating new exporter objects. Default to
+                     :class:`.PrintExporter`. The rest option is
+                     :class:`.FileExporter`.
     """
-    def __init__(self, app, sampler=None, reporter=None, propagator=None):
+    def __init__(self, app, sampler=None, exporter=None, propagator=None):
         if sampler is None:
             sampler = always_on.AlwaysOnSampler()
 
-        if reporter is None:
-            reporter = print_reporter.PrintReporter()
+        if exporter is None:
+            exporter = print_exporter.PrintExporter()
 
         if propagator is None:
             propagator = google_cloud_format.GoogleCloudFormatPropagator()
 
         self.app = app
         self.sampler = sampler
-        self.reporter = reporter
+        self.exporter = exporter
         self.propagator = propagator
         self.setup_trace()
 
@@ -81,7 +81,7 @@ def _before_request(self):
             tracer = request_tracer.RequestTracer(
                 span_context=span_context,
                 sampler=self.sampler,
-                reporter=self.reporter,
+                exporter=self.exporter,
                 propagator=self.propagator)
 
             tracer.start_trace()