Add monitorType JMX #472

alaturqua · 2024-09-17T23:49:04Z

Description

This pull request introduces a new monitorType for JMX-based monitoring in Trino Gateway. It includes documentation and configuration details for retrieving cluster information using specific JMX metrics.

Details

Component: JMX Monitoring in Trino Gateway
New Feature: Added support for monitorType: JMX to enable cluster monitoring via JMX metrics.
Metrics Used:
- trino.execution:name=QueryManager
- trino.metadata:name=DiscoveryNodeManager
Configuration Instructions:
- Users can configure a username and password using backendState.
- Credentials must be valid across all clusters with read rights on system_information.

Example Configuration:

backendState:
  username: "user"
  password: "password"
clusterStatsConfiguration:
  monitorType: JMX

Additional context and related issues

Release notes

( ) This is not user-visible or is docs only, and no release notes are required.
( ) Release notes are required. Please propose a release note for me.
(x) Release notes are required, with the following suggested text:

* Monitor backend health via JMX

alaturqua · 2024-09-17T23:49:45Z

I am not very experienced with Java and Testing in Java. Please feel free to add tests.

gateway-ha/src/main/java/io/trino/gateway/ha/config/ClusterStatsMonitorType.java

ebyhr

Just skimmed.

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java

gateway-ha/src/main/java/io/trino/gateway/ha/handler/QueryIdCachingProxyHandler.java

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java

alaturqua · 2024-10-14T22:53:39Z

Thanks for the reviews. I was on vacation and didn't have time to implement the requested changes yet. I will take care of them in the next days.

I might need some support to activate the /v1/jmx/mbean endpoint in the test environment for testing.

willmostly · 2024-10-29T21:30:26Z

@alaturqua please ping me when this is ready for another look

alaturqua · 2024-11-17T22:00:02Z

I had to sync my fork to be able to change my PR. But it got automatically closed, when I did so.
I am reopening.

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java

alaturqua · 2025-01-25T14:27:30Z

@willmostly

addressed all comments, ptal.

I didn't change the part, where @ebyhr had reacted with a thumb down.

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/JmxResponse.java

gateway-ha/src/test/java/io/trino/gateway/ha/clustermonitor/TestClusterStatsMonitor.java

alaturqua

@ebyhr

Thank you for taking time and reviewing. I adjusted the points. Please take a look again.

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java

docs/installation.md

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java

gateway-ha/src/test/java/io/trino/gateway/ha/clustermonitor/TestClusterStatsMonitor.java

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/JmxResponse.java

gateway-ha/src/test/java/io/trino/gateway/ha/clustermonitor/TestClusterStatsMonitor.java

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java

alaturqua · 2025-02-03T05:52:30Z

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java

+    {
+        try {
+            Map<String, Integer> stats = response.attributes().stream()
+                    .filter(attr -> "QueuedQueries".equals(attr.name()) ||


alaturqua

@ebyhr

Thanks again, seems like I had overseen things. I changed them as well. Can you please take a look again?

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java

willmostly

Just some cleanup

docs/installation.md

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java

alaturqua

@willmostly

Thanks for your feedback and reviewing. I did the changes, you commented. Can you please take a look again?

mosabua · 2025-02-05T15:06:11Z

@willmostly and @alaturqua discussed in the dev sync today and @willmostly will do a final review and merge

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java

alaturqua · 2025-02-05T17:11:32Z

@willmostly
I have addressed your comments. Please take a look again.

willmostly

LGTM!

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java

ebyhr · 2025-02-05T21:17:07Z

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java

+            JsonNode response = client.execute(preparedRequest, JMX_JSON_RESPONSE_HANDLER);
+            return Optional.ofNullable(response).map(JmxResponse::fromJson);


Is response really nullable?

gateway-ha/src/test/java/io/trino/gateway/ha/clustermonitor/TestClusterStatsMonitor.java

alaturqua · 2025-02-05T21:34:40Z

@ebyhr

thanks for your feedback. I will open another PR to address your comments.

alaturqua · 2025-02-06T07:14:49Z

@ebyhr

Addressed your concerns in a new PR:

#611

Please take a look there.

cla-bot bot added the cla-signed label Sep 17, 2024

alaturqua requested a review from mosabua September 17, 2024 23:49

alaturqua force-pushed the ii-add-monitortype-jmx branch from 512ce06 to 82cf53d Compare September 17, 2024 23:59

alaturqua changed the title ~~Add monitorType JMX via trino's /v1/jmx/mbean endpoint~~ Add monitorType JMX Sep 17, 2024

alaturqua force-pushed the ii-add-monitortype-jmx branch from 82cf53d to 40cb273 Compare September 18, 2024 00:02

ebyhr reviewed Sep 21, 2024

View reviewed changes

gateway-ha/src/main/java/io/trino/gateway/ha/config/ClusterStatsMonitorType.java Show resolved Hide resolved

ebyhr requested a review from willmostly September 24, 2024 05:00

alaturqua force-pushed the ii-add-monitortype-jmx branch from 40cb273 to 5389a0d Compare September 25, 2024 07:27

alaturqua requested a review from ebyhr September 25, 2024 07:29

ebyhr reviewed Sep 27, 2024

View reviewed changes

ebyhr assigned willmostly Oct 1, 2024

andythsu reviewed Oct 14, 2024

View reviewed changes

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java Outdated Show resolved Hide resolved

alaturqua force-pushed the ii-add-monitortype-jmx branch 5 times, most recently from fb4ac57 to b333076 Compare November 17, 2024 21:46

alaturqua closed this Nov 17, 2024

alaturqua force-pushed the ii-add-monitortype-jmx branch from b333076 to a11e5a4 Compare November 17, 2024 21:49

alaturqua reopened this Nov 17, 2024

alaturqua force-pushed the ii-add-monitortype-jmx branch from 6aebdfb to 995229a Compare November 17, 2024 22:23

andythsu reviewed Nov 18, 2024

View reviewed changes

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java Outdated Show resolved Hide resolved

andythsu reviewed Nov 18, 2024

View reviewed changes

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java Outdated Show resolved Hide resolved

alaturqua force-pushed the ii-add-monitortype-jmx branch 3 times, most recently from a79acde to 7671694 Compare November 20, 2024 09:07

alaturqua force-pushed the ii-add-monitortype-jmx branch from 0abf92c to df3f071 Compare January 25, 2025 14:10

alaturqua requested a review from willmostly January 25, 2025 14:22

ebyhr reviewed Feb 3, 2025

View reviewed changes

alaturqua force-pushed the ii-add-monitortype-jmx branch 3 times, most recently from 17bcc60 to ebd3b4f Compare February 3, 2025 05:45

alaturqua commented Feb 3, 2025

View reviewed changes

alaturqua self-assigned this Feb 3, 2025

alaturqua force-pushed the ii-add-monitortype-jmx branch 2 times, most recently from e4ae9be to 8a00bb7 Compare February 3, 2025 06:49

alaturqua commented Feb 3, 2025

View reviewed changes

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java Outdated Show resolved Hide resolved

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java Outdated Show resolved Hide resolved

alaturqua force-pushed the ii-add-monitortype-jmx branch 2 times, most recently from 4f38500 to fc3bfd3 Compare February 3, 2025 07:23

willmostly requested changes Feb 3, 2025

View reviewed changes

alaturqua force-pushed the ii-add-monitortype-jmx branch from f1eeb61 to 07e67f6 Compare February 3, 2025 22:54

alaturqua commented Feb 3, 2025

View reviewed changes

willmostly requested changes Feb 5, 2025

View reviewed changes

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java Outdated Show resolved Hide resolved

gateway-ha/src/main/java/io/trino/gateway/ha/clustermonitor/ClusterStatsJmxMonitor.java Outdated Show resolved Hide resolved

willmostly approved these changes Feb 5, 2025

View reviewed changes

add monitorType JMX

3e4a6fb

alaturqua force-pushed the ii-add-monitortype-jmx branch from e0e088f to 3e4a6fb Compare February 5, 2025 17:15

willmostly merged commit 908cec3 into trinodb:main Feb 5, 2025
2 checks passed

github-actions bot added this to the 14 milestone Feb 5, 2025

ebyhr reviewed Feb 5, 2025

View reviewed changes

alaturqua mentioned this pull request Feb 6, 2025

Cleanup monitorType JMX #611

Merged

mosabua mentioned this pull request Feb 11, 2025

Add Trino Gateway 14 release notes #589

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add monitorType JMX #472

Add monitorType JMX #472

alaturqua commented Sep 17, 2024 •

edited by willmostly

Loading

alaturqua commented Sep 17, 2024

ebyhr left a comment

alaturqua commented Oct 14, 2024

willmostly commented Oct 29, 2024

alaturqua commented Nov 17, 2024

alaturqua commented Jan 25, 2025

alaturqua left a comment

alaturqua Feb 3, 2025

alaturqua left a comment

willmostly left a comment

alaturqua left a comment

mosabua commented Feb 5, 2025

alaturqua commented Feb 5, 2025

willmostly left a comment

ebyhr Feb 5, 2025

alaturqua commented Feb 5, 2025

alaturqua commented Feb 6, 2025

		JsonNode response = client.execute(preparedRequest, JMX_JSON_RESPONSE_HANDLER);
		return Optional.ofNullable(response).map(JmxResponse::fromJson);

Add monitorType JMX #472

Add monitorType JMX #472

Conversation

alaturqua commented Sep 17, 2024 • edited by willmostly Loading

Description

Details

Additional context and related issues

Release notes

alaturqua commented Sep 17, 2024

ebyhr left a comment

Choose a reason for hiding this comment

alaturqua commented Oct 14, 2024

willmostly commented Oct 29, 2024

alaturqua commented Nov 17, 2024

alaturqua commented Jan 25, 2025

alaturqua left a comment

Choose a reason for hiding this comment

alaturqua Feb 3, 2025

Choose a reason for hiding this comment

alaturqua left a comment

Choose a reason for hiding this comment

willmostly left a comment

Choose a reason for hiding this comment

alaturqua left a comment

Choose a reason for hiding this comment

mosabua commented Feb 5, 2025

alaturqua commented Feb 5, 2025

willmostly left a comment

Choose a reason for hiding this comment

ebyhr Feb 5, 2025

Choose a reason for hiding this comment

alaturqua commented Feb 5, 2025

alaturqua commented Feb 6, 2025

alaturqua commented Sep 17, 2024 •

edited by willmostly

Loading