[NIFI-9435] Add Filtering Parameters to Flow Metrics

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.16.0
• Component/s: Core Framework
• Assignee: David Handermann
• Reporter: David Handermann
• Created: 02/Dec/21 14:07
• Updated: 13/Jan/22 20:59
• Resolved: 13/Jan/22 20:59

Description

The NiFi REST API includes support for generating metrics using Prometheus as the specified Producer. The current implementation gathers metrics in multiple registries, including Process Groups, Connections, Bulletins, and Java Virtual Machine status.

On installations with a large number of components, the metrics resource can generate a very large amount of information, resulting in timeouts when requesting clients have low timeout settings. In some cases, returning all metrics may not be necessary. Adding optional filter parameters to the REST API would support returning a smaller amount of information, providing better support for NiFi installations with a large number of components. Potential filtering parameters could include limiting the selected registry or metrics component type.

Issue Links

• links to: GitHub Pull Request #5571