exceptionfactory opened a new pull request #5571:
URL: https://github.com/apache/nifi/pull/5571
#### Description of PR
NIFI-9435 Adds `includedRegistries` and `includedNames` as optional query
parameters to the Flow Metrics REST API method to support filtering returned
metrics. Both query parameters can be provided multiple times to include
multiple selected elements. Specifying the `includedRegistries` parameter
performs initial filtering and `includedNames` filters the metric family names
from the selected registries.
The `includedRegistries` parameter supports the following four values based
on the current Prometheus Collector Registries:
- NIFI
- JVM
- BULLETIN
- CONNECTION
The `includedNames` parameter supports any of the metric family names
returned from any of the collector registries, such as `nifi_jvm_heap_usage`
for the `JVM` registry or `nifi_total_bytes_written` from the `NIFI` registry.
These optional parameters preserve the current default behavior while also
supporting a reduced response for NiFi deployments with a large number of
configured components.
Additional improvements include removing redundant `required = false`
annotation property settings in `FlowResource` and streamlining several inline
function definitions.
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
### For all changes:
- [X] Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
- [X] Does your PR title start with **NIFI-XXXX** where XXXX is the JIRA
number you are trying to resolve? Pay particular attention to the hyphen "-"
character.
- [X] Has your PR been rebased against the latest commit within the target
branch (typically `main`)?
- [X] Is your initial contribution a single, squashed commit? _Additional
commits in response to PR reviewer feedback should be made on this branch and
pushed to allow change tracking. Do not `squash` or use `--force` when pushing
to allow for clean monitoring of changes._
### For code changes:
- [X] Have you ensured that the full suite of tests is executed via `mvn
-Pcontrib-check clean install` at the root `nifi` folder?
- [X] Have you written or updated unit tests to verify your changes?
- [X] Have you verified that the full build is successful on JDK 8?
- [ ] Have you verified that the full build is successful on JDK 11?
- [ ] If adding new dependencies to the code, are these dependencies
licensed in a way that is compatible for inclusion under [ASF
2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] If applicable, have you updated the `LICENSE` file, including the main
`LICENSE` file under `nifi-assembly`?
- [ ] If applicable, have you updated the `NOTICE` file, including the main
`NOTICE` file found under `nifi-assembly`?
- [ ] If adding new Properties, have you added `.displayName` in addition to
.name (programmatic access) for each of the new properties?
### For documentation related changes:
- [X] Have you ensured that format looks appropriate for the output in which
it is rendered?
### Note:
Please ensure that once the PR is submitted, you check GitHub Actions CI for
build issues and submit an update to your PR as soon as possible.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
