Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replacing non-inclusive term "blacklist", "whitelist" with neutral language #1705

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------------------
Expand Down
8 changes: 4 additions & 4 deletions docs/Changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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)
Expand Down
10 changes: 5 additions & 5 deletions docs/asciidoc/configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -525,22 +525,22 @@ 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
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.
4 changes: 2 additions & 2 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion examples/curator.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ logging:
loglevel: INFO
logfile: /path/to/file.log
logformat: default
blacklist: ['elastic_transport', 'urllib3']
denylist: ['elastic_transport', 'urllib3']
4 changes: 2 additions & 2 deletions tests/integration/testvars.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
' loglevel: DEBUG\n'
' logfile:\n'
' logformat: default\n'
' blacklist: []\n')
' denylist: []\n')

client_conf_logfile = ('---\n'
'elasticsearch:\n'
Expand All @@ -33,7 +33,7 @@
' loglevel: DEBUG\n'
' logfile:\n'
' logformat: default\n'
' blacklist: []\n')
' denylist: []\n')

bad_client_config = ('---\n'
'elasticsearch:\n'
Expand Down