feat: Update Apache ActiveMQ mixin to use modern libraries #1471

schmikei · 2025-08-14T20:24:31Z

This PR modernizes the Apache ActiveMQ mixin to utilize an updated common-lib, logs-lib and best match the kafka-observ-lib.

Apache ActiveMQ cluster Overview

Apache ActiveMQ instance Overview

Apache ActiveMQ queue Overview

Apache ActiveMQ Overview

Apache ActiveMQ logs

Dasomeone

Hey @schmikei, sorry for the delay in reviewing these jsonnet-libs PRs!
Overall this is looking good, but I have a couple stylistic comments throughout that I think we need to have a look at.

First though, mixtool linting (with latest update) passes!

But yeah, I think we need to have a look at the groupLabels as there's a bunch of hardcoded label usage, especially in the legends throughout where it'd make sense to combine into one. Speficically with how often job and activemq_cluster are used together.

Dasomeone · 2025-08-21T12:40:44Z

apache-activemq-mixin/signals/clusters.libsonnet

+      unit: 'none',
+      sources: {
+        prometheus: {
+          expr: 'sum by (activemq_cluster, job) (increase(activemq_queue_enqueue_count{%(queriesSelector)s}[$__interval:])) + sum by (activemq_cluster, job) (increase(activemq_topic_enqueue_count{%(queriesSelector)s, destination!~"ActiveMQ.Advisory.*"}[$__interval:]))',


Just a thought, what do you think of adding a specific selector variable for job + activemq_cluster? Seems to me they're used together frequently

Hmm correct me if I'm wrong but my at least initial understanding was that we were trying to use the queriesSelector for anything related to groupLabels? Or is this comment pertaining to the sum by expression? Apologies if I'm misunderstanding the suggestion!

Excellent question, I should've been more clear! My comment was specifically with regards to the sum and group by used throughout, where it appears we might want another selector. I may be wrong, but that's just my gut feeling here to avoid hardcoding too many things (and combining hard-coded with selectors)

Dasomeone · 2025-08-21T12:47:16Z

apache-activemq-mixin/signals/instance.libsonnet

+        sources: {
+          prometheus: {
+            expr: 'avg(activemq_memory_usage_ratio{%(queriesSelector)s})',
+            legendCustomTemplate: '{{activemq_cluster}} - {{instance}}',


Thinking out loud here, would poke vitaly but he's out on PTO currently.

Thoughts on using instanceLabels and activemqLabels in the legend here? I know there's a slight risk if there's multiple labels defined, but I think it might make sense for most uses?

Ah yep I can explore some options for templating the legends a tad bit better 👍

Dasomeone · 2025-08-21T12:50:51Z

apache-activemq-mixin/signals/instance.libsonnet

+        unit: 'none',
+        sources: {
+          prometheus: {
+            expr: 'sum by (instance, activemq_cluster, job) (increase(activemq_topic_enqueue_count{%(queriesSelector)s})[$__interval:])',


do we use the basic cluster anywhere?

I'm commenting as I go here, so I'm just wondering because I've not seen groupLabels used yet

groupLabels gets mostly propogated via the commonlib.variables.new() but I am curious if you are expecting another usage outside of the queriesSelector?

Ah I think for this comment I meant in the sum and group by as well, given that we specifically call out activemq_cluster, and users may want to optionally have sum by k8s cluster as well

Dasomeone · 2025-08-21T12:52:59Z

apache-activemq-mixin/signals/clusters.libsonnet

+  filteringSelector: this.filteringSelector,
+  groupLabels: this.groupLabels,
+  instanceLabels: this.instanceLabels,
+  enableLokiLogs: this.enableLokiLogs,


Seems we don't use these at all outside the queriesSelector abstraction?

Ahh good catch 👍

Just realized that these change the behavior of the signals API if not present on the signal... i.e. we change datasource specifically if enableLokiLogs is set

with enableLokiLogs

"uid": "${prometheus_datasource}"

=>

without enableLokiLogs

"uid": "${datasource}"

I'm not sure if this is an intentional but does break my local setup by doing this. Do you have any insight into the reasoning for this? My local setup does get broken without these fields set on the signals...

This is done for legacy linting reasons, as the linter expects ${datasource}, but this truly is something we're moving away from. Fine to leave it as-is for now then, we'll revisit in another clean-up pass later on though I'm curious what errors you get?

Dasomeone · 2025-08-21T13:08:14Z

apache-activemq-mixin/signals/queues.libsonnet

+        sources: {
+          prometheus: {
+            expr: 'sum (activemq_queue_queue_size{%(queriesSelector)s})',
+            legendCustomTemplate: '__auto',


Where at all possible, I'd like to avoid using auto. Are there no good consistent labels we could use here? Even a hardcoded name might be better than the formatting auto provides?

Ah this was mostly to match parity with the current mixin... this is rendered as a single statistical sum so I'd imagine its a single latestValue that gets rendered. I suppose with this being a signal it might make sense to remove the legendCustomTemplate = __auto but the legend is a static string like queues?
=>
I'll go ahead and make that change but let me know if you want a revert or anything :)

Ah that's a great point, I was fully thinking of it from a point of view of a timeseries panel and not wanting {instance=xyz, cluster=123}=value as the legend. For stat panels auto is just fine.

E.g. could you update any use of __auto for anything but stat panels to be more descriptive, and leave it as __auto for stat panels?

apache-activemq-mixin/signals/topics.libsonnet

apache-activemq-mixin/signals/clusters.libsonnet

apache-activemq-mixin/README.md

apache-activemq-mixin/config.libsonnet

schmikei · 2025-08-27T17:38:10Z

Okay I believe that pieces of feedback have been addressed. Looking forward to hear your thoughts on this one #1471 (comment)

…/jsonnet-libs into schmikei/activemq-modernization

…i/activemq-modernization

Dasomeone · 2025-09-18T15:27:10Z

@schmikei looks like I had in fact missed this PR, adding to my list to clean up and go over in the morning!

Dasomeone

One teensy comment left, otherwise everything else has been addressed and looks great!!

I just want to say apologies again for letting this one stay in review and continually forgetting about it 😓

apache-activemq-mixin/README.md

…i/activemq-modernization

…/jsonnet-libs into schmikei/activemq-modernization

schmikei added 2 commits August 14, 2025 16:18

update apache-activemq mixin to use signals, logs-lib, common-lib more

f87a5f5

fix typo

3cd5712

schmikei marked this pull request as ready for review August 18, 2025 13:42

schmikei requested a review from a team as a code owner August 18, 2025 13:42

update readme and fix typo

e1873ed

schmikei marked this pull request as draft August 18, 2025 15:48

schmikei added 3 commits August 18, 2025 17:43

wip

a01b844

finish tidying up bsaed off original format

5a4b114

fix lint

ff0f6dd

schmikei marked this pull request as ready for review August 19, 2025 17:34

some more cleanup

0cbc641

Dasomeone added the monitoring-mixins label Aug 21, 2025

Dasomeone requested changes Aug 21, 2025

View reviewed changes

Dasomeone reviewed Aug 21, 2025

View reviewed changes

apache-activemq-mixin/README.md Show resolved Hide resolved

Dasomeone reviewed Aug 21, 2025

View reviewed changes

apache-activemq-mixin/config.libsonnet Outdated Show resolved Hide resolved

apply some pr feedback; still some open questions

8318149

schmikei force-pushed the schmikei/activemq-modernization branch from 9ea3c61 to 11cbd40 Compare August 28, 2025 13:54

remove __autos

64bd26c

schmikei force-pushed the schmikei/activemq-modernization branch from 11cbd40 to 64bd26c Compare August 28, 2025 13:55

schmikei and others added 7 commits August 28, 2025 13:10

Merge branch 'master' into schmikei/activemq-modernization

66cfb58

update to use more recent feedback

9040b6c

Merge branch 'schmikei/activemq-modernization' of github.com:schmikei…

f6a306d

…/jsonnet-libs into schmikei/activemq-modernization

Merge branch 'master' of github.com:grafana/jsonnet-libs into schmike…

73304ce

…i/activemq-modernization

Merge branch 'master' into schmikei/activemq-modernization

ee5b6b3

improve handling of dashboard panel legends for signals

cb08956

make lint

19b2912

Merge branch 'master' into schmikei/activemq-modernization

cb39aad

Dasomeone approved these changes Sep 24, 2025

View reviewed changes

apache-activemq-mixin/README.md Outdated Show resolved Hide resolved

schmikei added 3 commits September 25, 2025 09:10

Merge branch 'master' of github.com:grafana/jsonnet-libs into schmike…

cce2dfc

…i/activemq-modernization

update readme sample config

afe4e3a

Merge branch 'schmikei/activemq-modernization' of github.com:schmikei…

a90da5c

…/jsonnet-libs into schmikei/activemq-modernization

Dasomeone approved these changes Sep 25, 2025

View reviewed changes

Dasomeone enabled auto-merge (squash) September 25, 2025 13:48

Dasomeone merged commit 874d8f2 into grafana:master Sep 25, 2025
10 checks passed

feat: Update Apache ActiveMQ mixin to use modern libraries #1471

feat: Update Apache ActiveMQ mixin to use modern libraries #1471

Uh oh!

Conversation

schmikei commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Dasomeone left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Dasomeone Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Dasomeone Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

schmikei commented Aug 27, 2025

Uh oh!

Dasomeone commented Sep 18, 2025

Uh oh!

Dasomeone left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

schmikei commented Aug 14, 2025 •

edited

Loading

Dasomeone Sep 1, 2025 •

edited

Loading

Dasomeone Sep 1, 2025 •

edited

Loading