lordgamez commented on code in PR #2092: URL: https://github.com/apache/nifi-minifi-cpp/pull/2092#discussion_r2826410677
########## extensions/prometheus/tests/features/steps/prometheus_container.py: ########## @@ -0,0 +1,92 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import logging +from OpenSSL import crypto +from minifi_test_framework.containers.container import Container +from minifi_test_framework.core.helpers import wait_for_condition +from minifi_test_framework.core.minifi_test_context import MinifiTestContext +from minifi_test_framework.core.ssl_utils import make_cert_without_extended_usage +from minifi_test_framework.containers.file import File + + +class PrometheusContainer(Container): + def __init__(self, test_context: MinifiTestContext, ssl: bool = False): + super().__init__("prom/prometheus:v2.35.0", f"prometheus-{test_context.scenario_id}", test_context.network) Review Comment: Updated in https://github.com/apache/nifi-minifi-cpp/pull/2092/commits/5544be3a99c9af122c16e200e7a51638170a2c3a ########## extensions/prometheus/tests/features/resources/prometheus_checker.py: ########## @@ -0,0 +1,156 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +import argparse +import sys +import requests +from prometheus_api_client import PrometheusConnect + + +class PrometheusChecker: + def __init__(self, prometheus_host: str): + self.prometheus_client = PrometheusConnect(url=f"http://{prometheus_host}:9090";, disable_ssl=True) + + def verify_processor_metric(self, metric_class: str, processor_name: str) -> bool: + if metric_class == "GetFileMetrics": + return self._verify_getfile_metrics(metric_class, processor_name) + else: + return self._verify_general_processor_metrics(metric_class, processor_name) + + def verify_metric_class(self, metric_class: str) -> bool: + if metric_class == "RepositoryMetrics": + return self._verify_repository_metrics() + elif metric_class == "QueueMetrics": + return self._verify_queue_metrics() + elif metric_class == "FlowInformation": + return self._verify_flow_information_metrics() + elif metric_class == "DeviceInfoNode": + return self._verify_device_info_node_metrics() + elif metric_class == "AgentStatus": + return self._verify_agent_status_metrics() + else: + raise Exception("Metric class '%s' verification is not implemented" % metric_class) + + def _verify_repository_metrics(self) -> bool: + label_list = [{'repository_name': 'provenance'}, {'repository_name': 'flowfile'}, {'repository_name': 'content'}] + # Only flowfile and content repositories are using rocksdb by default, so rocksdb specific metrics are only present there + return all((self._verify_metrics_exist(['minifi_is_running', 'minifi_is_full', 'minifi_repository_size_bytes', 'minifi_max_repository_size_bytes', 'minifi_repository_entry_count'], 'RepositoryMetrics', labels) for labels in label_list)) and \ + all((self._verify_metric_larger_than_zero('minifi_repository_size_bytes', 'RepositoryMetrics', labels) for labels in label_list[1:3])) and \ + all((self._verify_metrics_exist(['minifi_rocksdb_table_readers_size_bytes', 'minifi_rocksdb_all_memory_tables_size_bytes'], 'RepositoryMetrics', labels) for labels in label_list[1:3])) + + def _verify_queue_metrics(self) -> bool: + return self._verify_metrics_exist(['minifi_queue_data_size', 'minifi_queue_data_size_max', 'minifi_queue_size', 'minifi_queue_size_max'], 'QueueMetrics') + + def _verify_general_processor_metrics(self, metric_class: str, processor_name: str) -> bool: + labels = {'processor_name': processor_name} + return self._verify_metrics_exist(['minifi_average_onTrigger_runtime_milliseconds', 'minifi_last_onTrigger_runtime_milliseconds', + 'minifi_average_session_commit_runtime_milliseconds', 'minifi_last_session_commit_runtime_milliseconds', + 'minifi_incoming_flow_files', 'minifi_incoming_bytes', 'minifi_bytes_read', 'minifi_bytes_written'], metric_class, labels) and \ + self._verify_metrics_larger_than_zero(['minifi_onTrigger_invocations', 'minifi_transferred_flow_files', 'minifi_transferred_to_success', + 'minifi_transferred_bytes', 'minifi_processing_nanos'], + metric_class, labels) + + def _verify_getfile_metrics(self, metric_class: str, processor_name: str) -> bool: + labels = {'processor_name': processor_name} + return self._verify_general_processor_metrics(metric_class, processor_name) and \ + self._verify_metrics_exist(['minifi_input_bytes', 'minifi_accepted_files'], metric_class, labels) + + def _verify_flow_information_metrics(self) -> bool: + return self._verify_metrics_exist(['minifi_queue_data_size', 'minifi_queue_data_size_max', 'minifi_queue_size', 'minifi_queue_size_max', + 'minifi_bytes_read', 'minifi_bytes_written', 'minifi_flow_files_in', 'minifi_flow_files_out', 'minifi_bytes_in', 'minifi_bytes_out', + 'minifi_invocations', 'minifi_processing_nanos'], 'FlowInformation') and \ + self._verify_metric_exists('minifi_is_running', 'FlowInformation', {'component_name': 'FlowController'}) + + def _verify_device_info_node_metrics(self) -> bool: + return self._verify_metrics_exist(['minifi_physical_mem', 'minifi_memory_usage', 'minifi_cpu_utilization', 'minifi_cpu_load_average'], 'DeviceInfoNode') + + def _verify_agent_status_metrics(self) -> bool: + label_list = [{'repository_name': 'flowfile'}, {'repository_name': 'content'}] + # Only flowfile and content repositories are using rocksdb by default, so rocksdb specific metrics are only present there + for labels in label_list: + if not (self._verify_metric_exists('minifi_is_running', 'AgentStatus', labels) + and self._verify_metric_exists('minifi_is_full', 'AgentStatus', labels) + and self._verify_metric_exists('minifi_max_repository_size_bytes', 'AgentStatus', labels) + and self._verify_metric_larger_than_zero('minifi_repository_size_bytes', 'AgentStatus', labels) + and self._verify_metric_exists('minifi_repository_entry_count', 'AgentStatus', labels) + and self._verify_metric_exists('minifi_rocksdb_table_readers_size_bytes', 'AgentStatus', labels) + and self._verify_metric_exists('minifi_rocksdb_all_memory_tables_size_bytes', 'AgentStatus', labels)): + return False + + # provenance repository is NoOpRepository by default which has zero size + if not (self._verify_metric_exists('minifi_is_running', 'AgentStatus', {'repository_name': 'provenance'}) + and self._verify_metric_exists('minifi_is_full', 'AgentStatus', {'repository_name': 'provenance'}) + and self._verify_metric_exists('minifi_max_repository_size_bytes', 'AgentStatus', {'repository_name': 'provenance'}) + and self._verify_metric_exists('minifi_repository_size_bytes', 'AgentStatus', {'repository_name': 'provenance'}) + and self._verify_metric_exists('minifi_repository_entry_count', 'AgentStatus', {'repository_name': 'provenance'})): + return False + return self._verify_metric_exists('minifi_uptime_milliseconds', 'AgentStatus') and \ + self._verify_metric_exists('minifi_agent_memory_usage_bytes', 'AgentStatus') and \ + self._verify_metric_exists('minifi_agent_cpu_utilization', 'AgentStatus') + + def _verify_metric_exists(self, metric_name: str, metric_class: str, labels: dict = {}) -> bool: + labels['metric_class'] = metric_class + labels['agent_identifier'] = "Agent1" + return len(self.prometheus_client.get_current_metric_value(metric_name=metric_name, label_config=labels)) > 0 + + def _verify_metrics_exist(self, metric_names: list, metric_class: str, labels: dict = {}) -> bool: + return all((self._verify_metric_exists(metric_name, metric_class, labels) for metric_name in metric_names)) + + def _verify_metric_larger_than_zero(self, metric_name: str, metric_class: str, labels: dict = {}) -> bool: + labels['metric_class'] = metric_class + result = self.prometheus_client.get_current_metric_value(metric_name=metric_name, label_config=labels) + return len(result) > 0 and int(result[0]['value'][1]) > 0 + + def _verify_metrics_larger_than_zero(self, metric_names: list, metric_class: str, labels: dict = {}) -> bool: + return all((self._verify_metric_larger_than_zero(metric_name, metric_class, labels) for metric_name in metric_names)) + + +def verify_all_metric_types_are_defined_once(prometheus_target: str) -> bool: + response = requests.get(f"http://{prometheus_target}:9936/metrics";) + if response.status_code < 200 or response.status_code >= 300: + return False + + metric_types = set() + for line in response.text.split("\n"): + if line.startswith("# TYPE"): + metric_type = line.split(" ")[2] + if metric_type in metric_types: + return False + metric_types.add(metric_type) + + return True + + +if __name__ == "__main__": + parser = argparse.ArgumentParser(description='Prometheus Checker') + parser.add_argument('--verify-defined-metrics-on-target', type=str, required=False, help='Prometheus target to verify all defined metrics are unique') Review Comment: Updated the argument name in https://github.com/apache/nifi-minifi-cpp/pull/2092/commits/5544be3a99c9af122c16e200e7a51638170a2c3a -- 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]
