-
Notifications
You must be signed in to change notification settings - Fork 4k
Added configuration options to disable Prometheus metrics and endpoints #15499
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
Open
kenliao94
wants to merge
3
commits into
rabbitmq:main
Choose a base branch
from
kenliao94:change_prometheus
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| %% This Source Code Form is subject to the terms of the Mozilla Public | ||
| %% License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| %% file, You can obtain one at https://mozilla.org/MPL/2.0/. | ||
| %% | ||
| %% Copyright (c) 2007-2026 Broadcom. All Rights Reserved. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries. All rights reserved. | ||
| %% | ||
|
|
||
| -module(rabbit_prometheus_util). | ||
|
|
||
| -export([normalize_disabled_metrics/1, | ||
| normalize_metric_name/1]). | ||
|
|
||
| -spec normalize_disabled_metrics([atom()]) -> [atom()]. | ||
| normalize_disabled_metrics(Metrics) -> | ||
| [normalize_metric_name(M) || M <- Metrics]. | ||
|
|
||
| -spec normalize_metric_name(atom()) -> atom(). | ||
| normalize_metric_name(Metric) when is_atom(Metric) -> | ||
| case atom_to_list(Metric) of | ||
| "rabbitmq_detailed_" ++ Rest -> list_to_atom(Rest); | ||
| "rabbitmq_cluster_" ++ Rest -> list_to_atom(Rest); | ||
| "rabbitmq_" ++ Rest -> list_to_atom(Rest); | ||
| _ -> Metric | ||
| end. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
126 changes: 126 additions & 0 deletions
126
deps/rabbitmq_prometheus/test/rabbit_prometheus_disabled_metrics_SUITE.erl
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| %% This Source Code Form is subject to the terms of the Mozilla Public | ||
| %% License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| %% file, You can obtain one at https://mozilla.org/MPL/2.0/. | ||
| %% | ||
| %% Copyright (c) 2007-2026 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. All rights reserved. | ||
| %% | ||
|
|
||
| -module(rabbit_prometheus_disabled_metrics_SUITE). | ||
|
|
||
| -include_lib("common_test/include/ct.hrl"). | ||
| -include_lib("eunit/include/eunit.hrl"). | ||
| -include_lib("rabbitmq_ct_helpers/include/rabbit_mgmt_test.hrl"). | ||
|
|
||
| -compile([export_all, nowarn_export_all]). | ||
|
|
||
| all() -> | ||
| [ | ||
| {group, default_settings}, | ||
| {group, disabled_endpoints}, | ||
| {group, disabled_metrics} | ||
| ]. | ||
|
|
||
| groups() -> | ||
| [ | ||
| {default_settings, [], [ | ||
| per_object_endpoint_disabled_by_default_test | ||
| ]}, | ||
| {disabled_endpoints, [], [ | ||
| disable_per_object_endpoint_test, | ||
| disable_detailed_endpoint_test, | ||
| disable_memory_breakdown_endpoint_test | ||
| ]}, | ||
| {disabled_metrics, [], [ | ||
| disable_single_metric_test, | ||
| disable_multiple_metrics_test, | ||
| normalize_metric_name_test | ||
| ]} | ||
| ]. | ||
|
|
||
| init_per_group(default_settings, Config) -> | ||
| init_group(Config); | ||
| init_per_group(disabled_endpoints, Config) -> | ||
| EndpointConfig = {rabbitmq_prometheus, [ | ||
| {disable_per_object_endpoint, true}, | ||
| {disable_detailed_endpoint, true}, | ||
| {disable_memory_breakdown_endpoint, true} | ||
| ]}, | ||
| Config1 = rabbit_ct_helpers:merge_app_env(Config, EndpointConfig), | ||
| init_group(Config1); | ||
| init_per_group(disabled_metrics, Config) -> | ||
| MetricsConfig = {rabbitmq_prometheus, [ | ||
| {disabled_metrics, [queue_messages, connection_incoming_bytes_total]} | ||
| ]}, | ||
| Config1 = rabbit_ct_helpers:merge_app_env(Config, MetricsConfig), | ||
| init_group(Config1). | ||
|
|
||
| init_group(Config) -> | ||
| rabbit_ct_helpers:log_environment(), | ||
| inets:start(), | ||
| rabbit_ct_helpers:run_setup_steps(Config, | ||
| rabbit_ct_broker_helpers:setup_steps() ++ | ||
| rabbit_ct_client_helpers:setup_steps()). | ||
|
|
||
| end_per_group(_, Config) -> | ||
| inets:stop(), | ||
| rabbit_ct_helpers:run_teardown_steps(Config, | ||
| rabbit_ct_client_helpers:teardown_steps() ++ | ||
| rabbit_ct_broker_helpers:teardown_steps()). | ||
|
|
||
| init_per_testcase(Testcase, Config) -> | ||
| rabbit_ct_helpers:testcase_started(Config, Testcase). | ||
|
|
||
| end_per_testcase(Testcase, Config) -> | ||
| rabbit_ct_helpers:testcase_finished(Config, Testcase). | ||
|
|
||
| %% Tests | ||
|
|
||
| disable_per_object_endpoint_test(Config) -> | ||
| Port = rabbit_mgmt_test_util:config_port(Config, tcp_port_prometheus), | ||
| URI = lists:flatten(io_lib:format("http://localhost:~tp/metrics/per-object", [Port])), | ||
| {ok, {{_, Code, _}, _, _}} = httpc:request(get, {URI, []}, ?HTTPC_OPTS, []), | ||
| ?assertEqual(404, Code). | ||
|
|
||
| disable_detailed_endpoint_test(Config) -> | ||
| Port = rabbit_mgmt_test_util:config_port(Config, tcp_port_prometheus), | ||
| URI = lists:flatten(io_lib:format("http://localhost:~tp/metrics/detailed", [Port])), | ||
| {ok, {{_, Code, _}, _, _}} = httpc:request(get, {URI, []}, ?HTTPC_OPTS, []), | ||
| ?assertEqual(404, Code). | ||
|
|
||
| disable_memory_breakdown_endpoint_test(Config) -> | ||
| Port = rabbit_mgmt_test_util:config_port(Config, tcp_port_prometheus), | ||
| URI = lists:flatten(io_lib:format("http://localhost:~tp/metrics/memory-breakdown", [Port])), | ||
| {ok, {{_, Code, _}, _, _}} = httpc:request(get, {URI, []}, ?HTTPC_OPTS, []), | ||
| ?assertEqual(404, Code). | ||
|
|
||
| per_object_endpoint_disabled_by_default_test(Config) -> | ||
| Port = rabbit_mgmt_test_util:config_port(Config, tcp_port_prometheus), | ||
| URI = lists:flatten(io_lib:format("http://localhost:~tp/metrics/per-object", [Port])), | ||
| {ok, {{_, Code, _}, _, _}} = httpc:request(get, {URI, []}, ?HTTPC_OPTS, []), | ||
| ?assertEqual(404, Code). | ||
|
|
||
| disable_single_metric_test(Config) -> | ||
| {_, Body} = http_get(Config, [], 200), | ||
| ?assertEqual(nomatch, re:run(Body, "^rabbitmq_queue_messages ", [{capture, none}, multiline])), | ||
| ?assertEqual(match, re:run(Body, "^rabbitmq_connections ", [{capture, none}, multiline])). | ||
|
|
||
| disable_multiple_metrics_test(Config) -> | ||
| {_, Body} = http_get(Config, [], 200), | ||
| ?assertEqual(nomatch, re:run(Body, "^rabbitmq_queue_messages ", [{capture, none}, multiline])), | ||
| ?assertEqual(nomatch, re:run(Body, "^rabbitmq_connection_incoming_bytes_total ", [{capture, none}, multiline])). | ||
|
|
||
| normalize_metric_name_test(_Config) -> | ||
| ?assertEqual(queue_messages, rabbit_prometheus_util:normalize_metric_name(rabbitmq_queue_messages)), | ||
| ?assertEqual(queue_messages, rabbit_prometheus_util:normalize_metric_name(rabbitmq_detailed_queue_messages)), | ||
| ?assertEqual(vhost_status, rabbit_prometheus_util:normalize_metric_name(rabbitmq_cluster_vhost_status)), | ||
| ?assertEqual(other_metric, rabbit_prometheus_util:normalize_metric_name(other_metric)). | ||
|
|
||
| %% Helpers | ||
|
|
||
| http_get(Config, ReqHeaders, CodeExp) -> | ||
| Port = rabbit_mgmt_test_util:config_port(Config, tcp_port_prometheus), | ||
| URI = lists:flatten(io_lib:format("http://localhost:~tp/metrics", [Port])), | ||
| {ok, {{_, CodeAct, _}, Headers, Body}} = | ||
| httpc:request(get, {URI, ReqHeaders}, ?HTTPC_OPTS, []), | ||
| ?assertMatch(CodeExp, CodeAct), | ||
| {Headers, Body}. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
With Cuttlefish
3.9.x, you can use thebooleantype.