Remove blacklist sensitive language (#977)

Author: lzchen

.pylintrc

@@ -5,11 +5,11 @@
 # run arbitrary code.
 extension-pkg-whitelist=
 
-# Add files or directories to the blacklist. They should be base names, not
+# Add files or directories to the excludelist. They should be base names, not
 # paths.
 ignore=CVS
 
-# Add files or directories matching the regex patterns to the blacklist. The
+# Add files or directories matching the regex patterns to the excludelist. The
 # regex matches against base names, not paths.
 ignore-patterns=
 

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 - PeriodicMetricTask flush on exit
 ([#943](https://github.com/census-instrumentation/opencensus-python/pull/943))
+- Change blacklist to excludelist
+([#977](https://github.com/census-instrumentation/opencensus-python/pull/977))
 
 ## 0.7.10
 Released 2020-06-29

README.rst

@@ -118,9 +118,9 @@ Customization
 
 There are several things you can customize in OpenCensus:
 
-* **Blacklist**, which excludes certain hosts and paths from being tracked.
+* **Excludelist**, which excludes certain hosts and paths from being tracked.
   By default, the health check path for the App Engine flexible environment is
-  not tracked, you can turn it on by excluding it from the blacklist setting.
+  not tracked, you can turn it on by excluding it from the excludelist setting.
 
 * **Exporter**, which sends the traces.
   By default, the traces are printed to stdout in JSON format. You can choose
@@ -174,8 +174,8 @@ information, please read the
 
     'OPENCENSUS': {
         'TRACE': {
-            'BLACKLIST_HOSTNAMES': ['localhost', '127.0.0.1'],
-            'BLACKLIST_PATHS': ['_ah/health'],
+            'EXCLUDELIST_HOSTNAMES': ['localhost', '127.0.0.1'],
+            'EXCLUDELIST_PATHS': ['_ah/health'],
             'SAMPLER': 'opencensus.trace.samplers.ProbabilitySampler(rate=1)',
             'EXPORTER': '''opencensus.ext.ocagent.trace_exporter.TraceExporter(
                 service_name='foobar',

contrib/opencensus-ext-datadog/examples/datadog.py

@@ -6,7 +6,7 @@
 
 app = Flask(__name__)
 middleware = FlaskMiddleware(app,
-                             blacklist_paths=['/healthz'],
+                             excludelist_paths=['/healthz'],
                              sampler=AlwaysOnSampler(),
                              exporter=DatadogTraceExporter(
                                  Options(service='python-export-test',

contrib/opencensus-ext-django/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+- Change blacklist to excludelist
+([#977](https://github.com/census-instrumentation/opencensus-python/pull/977))
+
 ## 0.7.2
 Released 2019-09-30
 

contrib/opencensus-ext-django/opencensus/ext/django/middleware.py

@@ -46,8 +46,8 @@
 REQUEST_THREAD_LOCAL_KEY = 'django_request'
 SPAN_THREAD_LOCAL_KEY = 'django_span'
 
-BLACKLIST_PATHS = 'BLACKLIST_PATHS'
-BLACKLIST_HOSTNAMES = 'BLACKLIST_HOSTNAMES'
+EXCLUDELIST_PATHS = 'EXCLUDELIST_PATHS'
+EXCLUDELIST_HOSTNAMES = 'EXCLUDELIST_HOSTNAMES'
 
 log = logging.getLogger(__name__)
 
@@ -160,9 +160,9 @@ def __init__(self, get_response=None):
         if isinstance(self.propagator, six.string_types):
             self.propagator = configuration.load(self.propagator)
 
-        self.blacklist_paths = settings.get(BLACKLIST_PATHS, None)
+        self.excludelist_paths = settings.get(EXCLUDELIST_PATHS, None)
 
-        self.blacklist_hostnames = settings.get(BLACKLIST_HOSTNAMES, None)
+        self.excludelist_hostnames = settings.get(EXCLUDELIST_HOSTNAMES, None)
 
         if django.VERSION >= (2,):  # pragma: NO COVER
             connection.execute_wrappers.append(_trace_db_call)
@@ -173,8 +173,8 @@ def process_request(self, request):
         :type request: :class:`~django.http.request.HttpRequest`
         :param request: Django http request.
         """
-        # Do not trace if the url is blacklisted
-        if utils.disable_tracing_url(request.path, self.blacklist_paths):
+        # Do not trace if the url is excludelisted
+        if utils.disable_tracing_url(request.path, self.excludelist_paths):
             return
 
         # Add the request to thread local
@@ -183,8 +183,8 @@ def process_request(self, request):
             request)
 
         execution_context.set_opencensus_attr(
-            'blacklist_hostnames',
-            self.blacklist_hostnames)
+            'excludelist_hostnames',
+            self.excludelist_hostnames)
 
         try:
             # Start tracing this request
@@ -234,8 +234,8 @@ def process_view(self, request, view_func, *args, **kwargs):
         function name add set it as the span name.
         """
 
-        # Do not trace if the url is blacklisted
-        if utils.disable_tracing_url(request.path, self.blacklist_paths):
+        # Do not trace if the url is excludelisted
+        if utils.disable_tracing_url(request.path, self.excludelist_paths):
             return
 
         try:
@@ -248,8 +248,8 @@ def process_view(self, request, view_func, *args, **kwargs):
             log.error('Failed to trace request', exc_info=True)
 
     def process_response(self, request, response):
-        # Do not trace if the url is blacklisted
-        if utils.disable_tracing_url(request.path, self.blacklist_paths):
+        # Do not trace if the url is excludelisted
+        if utils.disable_tracing_url(request.path, self.excludelist_paths):
             return response
 
         try:

contrib/opencensus-ext-django/tests/test_django_middleware.py

@@ -127,17 +127,17 @@ def test_process_request(self):
 
         self.assertEqual(span.name, 'mock.mock.Mock')
 
-    def test_blacklist_path(self):
+    def test_excludelist_path(self):
         from opencensus.ext.django import middleware
 
         execution_context.clear()
 
-        blacklist_paths = ['test_blacklist_path']
+        excludelist_paths = ['test_excludelist_path']
         settings = type('Test', (object,), {})
         settings.OPENCENSUS = {
             'TRACE': {
                 'SAMPLER': 'opencensus.trace.samplers.AlwaysOnSampler()',  # noqa
-                'BLACKLIST_PATHS': blacklist_paths,
+                'EXCLUDELIST_PATHS': excludelist_paths,
                 'EXPORTER': mock.Mock(),
             }
         }
@@ -148,11 +148,11 @@ def test_blacklist_path(self):
         with patch_settings:
             middleware_obj = middleware.OpencensusMiddleware()
 
-        django_request = RequestFactory().get('/test_blacklist_path')
+        django_request = RequestFactory().get('/test_excludelist_path')
         disabled = utils.disable_tracing_url(django_request.path,
-                                             blacklist_paths)
+                                             excludelist_paths)
         self.assertTrue(disabled)
-        self.assertEqual(middleware_obj.blacklist_paths, blacklist_paths)
+        self.assertEqual(middleware_obj.excludelist_paths, excludelist_paths)
 
         # test process_request
         middleware_obj.process_request(django_request)

contrib/opencensus-ext-flask/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+- Change blacklist to excludelist
+([#977](https://github.com/census-instrumentation/opencensus-python/pull/977))
+
 ## 0.7.3
 Released 2019-10-01
 

contrib/opencensus-ext-flask/README.rst

@@ -22,7 +22,7 @@ Usage
     from opencensus.ext.flask.flask_middleware import FlaskMiddleware
     
     app = Flask(__name__)
-    middleware = FlaskMiddleware(app, blacklist_paths=['_ah/health'])
+    middleware = FlaskMiddleware(app, excludelist_paths=['_ah/health'])
     
     @app.route('/')
     def hello():

contrib/opencensus-ext-flask/opencensus/ext/flask/flask_middleware.py

@@ -40,8 +40,8 @@
 HTTP_URL = attributes_helper.COMMON_ATTRIBUTES['HTTP_URL']
 HTTP_STATUS_CODE = attributes_helper.COMMON_ATTRIBUTES['HTTP_STATUS_CODE']
 
-BLACKLIST_PATHS = 'BLACKLIST_PATHS'
-BLACKLIST_HOSTNAMES = 'BLACKLIST_HOSTNAMES'
+EXCLUDELIST_PATHS = 'EXCLUDELIST_PATHS'
+EXCLUDELIST_HOSTNAMES = 'EXCLUDELIST_HOSTNAMES'
 
 log = logging.getLogger(__name__)
 
@@ -52,8 +52,8 @@ class FlaskMiddleware(object):
     :type app: :class: `~flask.Flask`
     :param app: A flask application.
 
-    :type blacklist_paths: list
-    :param blacklist_paths: Paths that do not trace.
+    :type excludelist_paths: list
+    :param excludelist_paths: Paths that do not trace.
 
     :type sampler: :class:`~opencensus.trace.samplers.base.Sampler`
     :param sampler: A sampler. It should extend from the base
@@ -76,10 +76,10 @@ class FlaskMiddleware(object):
                        :class:`.TextFormatPropagator`.
     """
 
-    def __init__(self, app=None, blacklist_paths=None, sampler=None,
+    def __init__(self, app=None, excludelist_paths=None, sampler=None,
                  exporter=None, propagator=None):
         self.app = app
-        self.blacklist_paths = blacklist_paths
+        self.excludelist_paths = excludelist_paths
         self.sampler = sampler
         self.exporter = exporter
         self.propagator = propagator
@@ -112,10 +112,10 @@ def init_app(self, app):
             if isinstance(self.propagator, six.string_types):
                 self.propagator = configuration.load(self.propagator)
 
-        self.blacklist_paths = settings.get(BLACKLIST_PATHS,
-                                            self.blacklist_paths)
+        self.excludelist_paths = settings.get(EXCLUDELIST_PATHS,
+                                              self.excludelist_paths)
 
-        self.blacklist_hostnames = settings.get(BLACKLIST_HOSTNAMES, None)
+        self.excludelist_hostnames = settings.get(EXCLUDELIST_HOSTNAMES, None)
 
         self.setup_trace()
 
@@ -129,8 +129,10 @@ def _before_request(self):
 
         See: http://flask.pocoo.org/docs/0.12/api/#flask.Flask.before_request
         """
-        # Do not trace if the url is blacklisted
-        if utils.disable_tracing_url(flask.request.url, self.blacklist_paths):
+        # Do not trace if the url is in the exclude list
+        if utils.disable_tracing_url(
+            flask.request.url, self.excludelist_paths
+        ):
             return
 
         try:
@@ -161,8 +163,8 @@ def _before_request(self):
                 HTTP_URL, str(flask.request.url)
             )
             execution_context.set_opencensus_attr(
-                'blacklist_hostnames',
-                self.blacklist_hostnames
+                'excludelist_hostnames',
+                self.excludelist_hostnames
             )
         except Exception:  # pragma: NO COVER
             log.error('Failed to trace request', exc_info=True)
@@ -172,8 +174,10 @@ def _after_request(self, response):
 
         See: http://flask.pocoo.org/docs/0.12/api/#flask.Flask.after_request
         """
-        # Do not trace if the url is blacklisted
-        if utils.disable_tracing_url(flask.request.url, self.blacklist_paths):
+        # Do not trace if the url is in the exclude list
+        if utils.disable_tracing_url(
+            flask.request.url, self.excludelist_paths
+        ):
             return response
 
         try:
@@ -193,8 +197,10 @@ def _after_request(self, response):
             return response
 
     def _teardown_request(self, exception):
-        # Do not trace if the url is blacklisted
-        if utils.disable_tracing_url(flask.request.url, self.blacklist_paths):
+        # Do not trace if the url is in the exclude list
+        if utils.disable_tracing_url(
+            flask.request.url, self.excludelist_paths
+        ):
             return
 
         try: