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
NIFI-10471 Document and apply standard deprecation logging #6390
Conversation
- Updated Admin Guide with section on Logging Configuration and Deprecation Logging - Updated Developer Guide with section on Deprecating Components and Features - Added Deprecation Logging when adding components marked with DeprecationNotice to the Flow Configuration - Added Deprecation Logging on deprecated methods in standard Controller Service implementations - Removed integration tests for deprecated PersistentProvenanceRepository
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good!
A few places where additional documentation/text would be helpful; please give those some consideration.
...ance-repository/src/main/java/org/apache/nifi/provenance/PersistentProvenanceRepository.java
Outdated
Show resolved
Hide resolved
...op-bundle/nifi-hdfs-processors/src/main/java/org/apache/nifi/processors/hadoop/ListHDFS.java
Show resolved
Hide resolved
Thanks for the review and feedback @greyp9! I pushed an update with more logging for the repository class and additional paragraphs in the Administrator's Guide. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the updates; these should be helpful for users. The automation looks good.
- Updated Admin Guide with section on Logging Configuration and Deprecation Logging - Updated Developer Guide with section on Deprecating Components and Features - Added Deprecation Logging when adding components marked with DeprecationNotice to the Flow Configuration - Added Deprecation Logging on deprecated methods in standard Controller Service implementations - Removed integration tests for deprecated PersistentProvenanceRepository - Updated logging and added documentation on minor upgrade steps - Updated logging for HDFSNarProvider and RocksDB Repository This closes apache#6390 Signed-off-by: Paul Grey <greyp@apache.org>
Summary
NIFI-10471 Updates the Administrator's Guide and Developer Guide with configuration and implementation details for component and feature deprecation logging. Additional deprecation logging includes warning when a component with a
DeprecationNotice
is added to the Flow Configuration, and warning when several components use deprecated methods or properties.The following components include specific usage deprecation warnings:
HDFSNarProvider
classInvokeHTTP
proxy propertiesListHDFS
distributed cache propertyPersistentProvenanceRepository
classRocksDBFlowFileRepository
classRecordSetWriterFactory
interface methodsSchemaRegistry
interface methodsStandardSSLContextService
interface methodsAdditional changes include removing integration test class for the deprecated
PersistentProvenanceRepository
class.Tracking
Please complete the following tracking steps prior to pull request creation.
Issue Tracking
Pull Request Tracking
NIFI-00000
NIFI-00000
Pull Request Formatting
main
branchVerification
Please indicate the verification steps performed prior to pull request creation.
Build
mvn clean install -P contrib-check
Licensing
LICENSE
andNOTICE
filesDocumentation