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

NIFI-10471 Document and apply standard deprecation logging #6390

Closed
wants to merge 3 commits into from

Conversation

exceptionfactory
Copy link
Contributor

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 class
  • InvokeHTTP proxy properties
  • ListHDFS distributed cache property
  • PersistentProvenanceRepository class
  • RocksDBFlowFileRepository class
  • RecordSetWriterFactory interface methods
  • SchemaRegistry interface methods
  • StandardSSLContextService interface methods

Additional 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

  • Pull Request title starts with Apache NiFi Jira issue number, such as NIFI-00000
  • Pull Request commit message starts with Apache NiFi Jira issue number, as such NIFI-00000

Pull Request Formatting

  • Pull Request based on current revision of the main branch
  • 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

  • Build completed using mvn clean install -P contrib-check
    • 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 and NOTICE files

Documentation

  • Documentation formatting appears as expected in rendered files

- 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
@greyp9 greyp9 self-requested a review September 13, 2022 15:11
Copy link
Contributor

@greyp9 greyp9 left a 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.

@exceptionfactory
Copy link
Contributor Author

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.

Copy link
Contributor

@greyp9 greyp9 left a 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.

@greyp9 greyp9 closed this in 04c0df1 Sep 13, 2022
p-kimberley pushed a commit to p-kimberley/nifi that referenced this pull request Oct 15, 2022
- 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants