nifi
nifi copied to clipboard
NIFI-9374 Add Standard Deprecation Logger
Summary
NIFI-9374 Adds a DeprecationLogger
interface with standard implementation and factory to provide a common approach to logging deprecated components and features.
The nifi-deprecation-log
module has a single dependency on the SLF4J API to provide the logging implementation.
The DeprecationLogger
interface has a single warn()
method that should be sufficient for general use across components. The DeprecationLoggerFactory
and StandardDeprecationLogger
implementation prefix logger names with deprecation
, enabling discrete logging to a separate appender.
The introduction of a new nifi-deprecation.log
enables a standard approach for administrators to determine whether an installation of Apache NiFi is using components or features that will be removed in future releases. Log messages should indicate deprecated properties or capabilities, and a standard internal DeprecationException
provides a reference to the classes and methods calling the deprecated elements.
The initial set of changes includes updates to NiFiLegacyCipherProvider
providing example usage. The Cipher Provider supports the legacy Sensitive Properties Algorithm configuration values from Apache NiFi 1.13.2 and earlier. Deprecation logs can be observed by configuring a legacy algorithm such as PBEWITHMD5AND256BITAES-CBC-OPENSSL
.
Tracking
Please complete the following tracking steps prior to pull request creation.
Issue Tracking
- [X] Apache NiFi Jira issue created
Pull Request Tracking
- [X] Pull Request title starts with Apache NiFi Jira issue number, such as
NIFI-00000
- [X] Pull Request commit message starts with Apache NiFi Jira issue number, as such
NIFI-00000
Pull Request Formatting
- [X] Pull Request based on current revision of the
main
branch - [X] Pull Request refers to a feature branch with one commit containing changes
Verification
Please indicate the verification steps performed prior to pull request creation.
Build
- [X] Build completed using
mvn clean install -P contrib-check
- [X] JDK 8
- [ ] JDK 11
- [ ] JDK 17
Licensing
- [ ] New dependencies are compatible with the Apache License 2.0 according to the License Policy
- [ ] New dependencies are documented in applicable
LICENSE
andNOTICE
files
Documentation
- [ ] Documentation formatting appears as expected in rendered files