From dfae5afa334d40dfdaefd7f6eba05d22dc751f7d Mon Sep 17 00:00:00 2001 From: Madhuri Agarwal Date: Wed, 13 Mar 2024 19:05:47 +0530 Subject: [PATCH] Replacing non-inclusive term "blacklist", "whitelist" with neutral language #1611 --- README.rst | 2 +- docs/Changelog.rst | 8 ++++---- docs/asciidoc/configuration.asciidoc | 10 +++++----- docs/usage.rst | 4 ++-- examples/curator.yml | 2 +- tests/integration/testvars.py | 4 ++-- 6 files changed, 15 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 551fc8c3..787b85d8 100644 --- a/README.rst +++ b/README.rst @@ -56,7 +56,7 @@ The updated configuration file structure requires ``elasticsearch`` at the root loglevel: INFO logfile: /path/to/file.log logformat: default - blacklist: [] + denylist: [] Action File Configuration ------------------------- diff --git a/docs/Changelog.rst b/docs/Changelog.rst index 185bfc44..44c5d9aa 100644 --- a/docs/Changelog.rst +++ b/docs/Changelog.rst @@ -270,7 +270,7 @@ which is why I didn't start with 8.6.0 as my release version. Curator is going to use it. Welcome, ``ecs-logging``! As before, just use ``logformat: ecs``, but now it has all of the goodness right there! * rST docs are improved and updated. Check out https://curator.readthedocs.io to see. - * Logging turned out to be too verbose due to a shift. Now the ``blacklist`` defaults to + * Logging turned out to be too verbose due to a shift. Now the ``denylist`` defaults to ``['elastic_transport', 'urllib3']``. Documentation updated accordingly. * Default behavior is now to not verify snapshot repository access for Snapshot and Restore actions. It was a hacky fix for older versions of Elasticsearch that just shouldn't be needed. @@ -1631,7 +1631,7 @@ improves documentation and includes new linux binary packages. * Community contributed doc fixes. * Reduced logging verbosity by making most messages debug level. #684 (untergeek) - * Fixed log whitelist behavior (and switched to blacklisting instead). + * Fixed log allowlist behavior (and switched to denylisting instead). Default behavior will now filter traffic from the ``elasticsearch`` and ``urllib3`` modules. * Fix Travis CI testing to accept some skipped tests, as needed. #695 @@ -1653,7 +1653,7 @@ improves documentation and includes new linux binary packages. * Community contributed doc fixes. * Reduced logging verbosity by making most messages debug level. #684 (untergeek) - * Fixed log whitelist behavior (and switched to blacklisting instead). + * Fixed log allowlist behavior (and switched to denylisting instead). Default behavior will now filter traffic from the ``elasticsearch`` and ``urllib3`` modules. * Fix Travis CI testing to accept some skipped tests, as needed. #695 @@ -2558,7 +2558,7 @@ testing exists, right?), and fixed a few of them. **Bug fix** * Updated ``README.md`` to briefly explain what curator does #117 (untergeek) - * Fixed ``es_repo_mgr`` logging whitelist #119 (untergeek) + * Fixed ``es_repo_mgr`` logging allowlist #119 (untergeek) * Fixed absent ``months`` time-unit #120 (untergeek) * Filter out ``.marvel-kibana`` when prefix is ``.marvel-`` #120 (untergeek) * Clean up arg parsing code where redundancy exists #123 (untergeek) diff --git a/docs/asciidoc/configuration.asciidoc b/docs/asciidoc/configuration.asciidoc index 78ee98f7..a29b6854 100644 --- a/docs/asciidoc/configuration.asciidoc +++ b/docs/asciidoc/configuration.asciidoc @@ -208,7 +208,7 @@ logging: loglevel: INFO logfile: logformat: default - blacklist: ['elastic_transport', 'urllib3'] + denylist: ['elastic_transport', 'urllib3'] ----------- It is a YAML configuration file. The two root keys must be `elasticsearch` and @@ -525,15 +525,15 @@ ACTIONNAME"},"process":{"name":"MainProcess","pid":12345,"thread": The default value is `default`. -[[blacklist]] -=== blacklist +[[denylist]] +=== denylist This should be an empty array `[]`, an array of log handler strings, or left empty. [source,sh] ----------- -blacklist: ['elastic_transport', 'urllib3'] +denylist: ['elastic_transport', 'urllib3'] ----------- The default value is `['elastic_transport', 'urllib3']`, which will result in @@ -541,6 +541,6 @@ logs for the `elastic_transport` and `urllib3` Python modules _not_ being output These can be quite verbose, so unless you need them to debug an issue, you should accept the default value. -TIP: If you do need to troubleshoot an issue, set `blacklist` to `[]`, which is +TIP: If you do need to troubleshoot an issue, set `denylist` to `[]`, which is an empty array. Leaving it unset will result in the default behavior, which is to filter out `elastic_transport` and `urllib3` log traffic. diff --git a/docs/usage.rst b/docs/usage.rst index 4ff35b22..4d9d2d3f 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -64,7 +64,7 @@ This is quite simple: 'loglevel': 'INFO', 'logfile': None, 'logformat': 'default', - 'blacklist': ['elastic_transport', 'urllib3'] + 'denylist': ['elastic_transport', 'urllib3'] } set_logging(LOG) @@ -91,7 +91,7 @@ Available settings for ``logformat`` are: ``default``, ``json``, and ``ecs``. Th uses `the Python ECS Log Formatter`_ and is great if you plan on ingesting your logs into Elasticsearch. -Blacklisting logs by way of the ``blacklist`` setting should remain configured with the defaults +Denylisting logs by way of the ``denylist`` setting should remain configured with the defaults (``['elastic_transport', 'urllib3']``), unless you are troubleshooting a connection issue. The ``elastic_transport`` and ``urllib3`` modules logging is exceptionally chatty for inclusion with Curator action tracing. diff --git a/examples/curator.yml b/examples/curator.yml index 7c17a205..a9d1b397 100644 --- a/examples/curator.yml +++ b/examples/curator.yml @@ -29,4 +29,4 @@ logging: loglevel: INFO logfile: /path/to/file.log logformat: default - blacklist: ['elastic_transport', 'urllib3'] + denylist: ['elastic_transport', 'urllib3'] diff --git a/tests/integration/testvars.py b/tests/integration/testvars.py index dea4d11b..647ba4d3 100644 --- a/tests/integration/testvars.py +++ b/tests/integration/testvars.py @@ -10,7 +10,7 @@ ' loglevel: DEBUG\n' ' logfile:\n' ' logformat: default\n' -' blacklist: []\n') +' denylist: []\n') client_conf_logfile = ('---\n' 'elasticsearch:\n' @@ -33,7 +33,7 @@ ' loglevel: DEBUG\n' ' logfile:\n' ' logformat: default\n' -' blacklist: []\n') +' denylist: []\n') bad_client_config = ('---\n' 'elasticsearch:\n'