[Metricbeat] Apache Tomcat lightweight module #13491

sayden · 2019-09-04T12:46:07Z

This is the metrics I think that we should add to the module. Some descriptions are missing in the docs but they are self-explanatory (We can add our own description but let's decide first what to add).

At the same time. I think we shouldn't do a single metricset:

Requests

requests.total: Number of requests processed
requests.bytes.received: Amount of data received, in bytes
requests.bytes.sent: Amount of data sent, in bytes
requests.processing.ms: Total time to process the requests
requests.errors.total: Number of errors

Threads

threads.busy:
threads.max:
threads.current:
keep_alive.total:
keep_alive.timeout.ms:
thread.started.total:
thread.user.time.ms:
thread.cpu.time.ms:
thread.total:
thread.peak:

Cache

cache.hit.total: The number of requests for resources that were served from the cache
cache.size.total: The current estimate of the cache size in kB
cache.size.max: The maximum permitted size of the cache in kB
cache.lookup.total: The number of requests for resources
cache.ttl.ms: The time-to-live for cache entries in milliseconds

Memory

memory.heap.usage.committed:
memory.heap.usage.max:
memory.heap.usage.used:
memory.heap.usage.init:
memory.other.usage.committed:
memory.other.usage.max:
memory.other.usage.used:
memory.other.usage.init:

kaiyan-sheng · 2019-09-13T13:50:53Z

👍👍👍👍 How about https://github.com/elastic/beats/blob/master/x-pack/metricbeat/magefile.go#L93?

jsoriano

Metrics collected LGTM, could you create a couple of data.json examples to see what events this module would generate?

x-pack/metricbeat/module/tomcat/README.md

metricbeat/docs/modules/tomcat.asciidoc

Titch990 · 2019-09-20T15:52:08Z

metricbeat/docs/fields.asciidoc

+*`tomcat.cache.size.total.kb`*::
+
+--
+The current estimate of the cache size in kB


Suggested change

The current estimate of the cache size in kB

The current estimate of the cache size in kilobytes

A tiny thing (and elsewhere too). KB is usually only used if it follows a number, otherwise it's usually spelled out in full (where "usually" means "as defined in the Microsoft Manual of Style").

That's really interesting! I didn't know it. Fixed!

jsoriano

Please use a fixed version for the docker image. For the rest it looks great to me.

jsoriano · 2019-09-23T17:52:29Z

x-pack/metricbeat/module/tomcat/cache/_meta/data.json

+    },
+    "tomcat": {
+        "cache": {
+            "mbean": "Catalina:context=/docs,host=localhost,name=Cache,type=WebResourceRoot",


Umm, these mbeans should probably be placed in a common field, like jmx.mbean. But this would be something to solve in the Jolokia module, or as part of #13604.

@jsoriano We are looking into why the tomcat module is not working for us, and the issue is that the domain should be Tomcat instead of Catalina. I tried to override the mbean from its configuration file tomcat.yml, however it doesn't seem possible to set e.g. cache.mbean or requests.mbean ourselves.

Hey @dagwieers, thanks for pointing this out. Do you know on what cases tomcat uses the Tomcat domain and when the Catalina one? I think the tomcat module should support both cases. Could you please open a new issue to add support for the Tomcat domain?
In the meantime you can consider using the Jolokia module with a custom configuration: https://www.elastic.co/guide/en/beats/metricbeat/7.9/metricbeat-metricset-jolokia-jmx.html

If you are trying to override the mappings used by the tomcat module, I think but you should be using each metricset separatedly, and use the jmx.mappings setting in the configuration for the overrides. But I am not sure if this would work well, I haven't tried it. It'd be for example something like this for the cache metricset:

- module: tomcat metricsets: [cache] jmx.mappings: - mbean: 'Tomcat....' attributes: - attr: hitCount field: hit.total - attr: size field: size.total.kb - attr: maxSize field: size.max.kb - attr: lookupCount field: lookup.total - attr: ttl field: ttl.ms

Btw, it seems there was an attempt to change this also in the example configuration for Tomcat in the Prometheus jmx exporter: prometheus/jmx_exporter#92

Do you know on what cases tomcat uses the Tomcat domain and when the Catalina one? I think the tomcat module should support both cases. Could you please open a new issue to add support for the Tomcat domain?

I am afraid I am not that experienced with Tomcat to tell you. But a way to influence that (or detect that) would be useful. I will open a ticket.

In the meantime you can consider using the Jolokia module with a custom configuration: https://www.elastic.co/guide/en/beats/metricbeat/7.9/metricbeat-metricset-jolokia-jmx.html

Yes, in the meantime I created my own config that uses jolokia and this basically removed the need to use the tomcat module altogether. Personally, I am unsure what the tomcat module brings to the table if it is just a standard listing for dashboards. We might as well go with just a tomcat.yml like your example. Here is the one that implements exactly the same:

# Ansible managed # Module: jolokia # Docs: https://www.elastic.co/guide/en/beats/metricbeat/7.9/metricbeat-module-jolokia.html - module: jolokia period: 10s metricsets: - jmx hosts: - localhost:8778 path: /jolokia/?ignoreErrors=true&canonicalNaming=false namespace: tomcat jmx.mappings: # Reimplementation of tomcat/cache - mbean: Tomcat:context=*,host=*,name=Cache,type=WebResourceRoot attributes: - attr: hitCount field: cache.hit.total - attr: size field: cache.size.total.kb - attr: maxSize field: cache.size.max.kb - attr: lookupCount field: cache.lookup.total - attr: ttl field: cache.ttl.ms # Reimplementation of tomcat/memory - mbean: java.lang:type=Memory attributes: - attr: HeapMemoryUsage field: memory.heap.usage - attr: NonHeapMemoryUsage field: memory.other.usage # Reimplementation of tomcat/requests - mbean: Tomcat:name=*,type=GlobalRequestProcessor attributes: - attr: requestCount field: requests.total - attr: bytesReceived field: requests.bytes.received - attr: bytesSent field: requests.bytes.sent - attr: processingTime field: requests.processing.ms - attr: errorCount field: requests.errors.total # Reimplementation of tomcat/threading - mbean: Tomcat:name=*,type=ThreadPool attributes: - attr: currentThreadsBusy field: threading.busy - attr: maxThreads field: threading.max - attr: currentThreadCount field: threading.current - attr: keepAliveCount field: threading.keep_alive.total - attr: keepAliveTimeout field: threading.keep_alive.timeout.ms - mbean: java.lang:type=Threading attributes: - attr: TotalStartedThreadCount field: threading.started.total - attr: CurrentThreadUserTime field: threading.user.time.ms - attr: CurrentThreadCpuTime field: threading.cpu.time.ms - attr: ThreadCount field: threading.total - attr: PeakThreadCount field: threading.peak

BTW another concern I had was that I could not find the tomcat module in de codebase and it took some time to find this PR (given I did not have a reference). Now I see it is under x-pack, but that is non-trivial for people to find. And unfortunately searching for tomcat does not help ;-)

Maybe it would be worthwhile to merge modules together in the code, but split them for packaging/distribution/documentation instead?

jsoriano · 2019-09-23T17:59:39Z

x-pack/metricbeat/module/tomcat/_meta/Dockerfile

@@ -0,0 +1,7 @@
+FROM tomcat:jdk13-openjdk-oracle


Sorry I didn't see it before, we should fix a version here, and we might also add a build arg.

Suggested change

FROM tomcat:jdk13-openjdk-oracle

ARG TOMCAT_VERSION=9.0.26

FROM tomcat:${TOMCAT_VERSION}-jdk13-openjdk-oracle

Ohhh 😍 very good point

kaiyan-sheng · 2019-09-24T14:48:28Z

👍👍👍👍 How about https://github.com/elastic/beats/blob/master/x-pack/metricbeat/magefile.go#L93?

@jsoriano just want to clarify here, is the change here needed? 😬

jsoriano · 2019-09-24T15:16:00Z

+1+1+1+1 How about https://github.com/elastic/beats/blob/master/x-pack/metricbeat/magefile.go#L93?

@jsoriano just want to clarify here, is the change here needed? grimacing

It was more needed when we had one or two metricsets, it is not so important now.

sayden · 2019-09-27T19:34:21Z

Error is not related. Merging

andresrc · 2019-12-10T11:27:43Z

cf. #13860

sayden added enhancement Metricbeat Metricbeat Team:Integrations Label for the Integrations team labels Sep 4, 2019

sayden self-assigned this Sep 4, 2019

andresrc added [zube]: Inbox in progress Pull request is currently in progress. [zube]: In Progress and removed [zube]: Inbox labels Sep 9, 2019

sayden added [zube]: In Review review and removed [zube]: In Progress in progress Pull request is currently in progress. labels Sep 13, 2019

jsoriano reviewed Sep 16, 2019

View reviewed changes

x-pack/metricbeat/module/tomcat/README.md Outdated Show resolved Hide resolved

sayden added in progress Pull request is currently in progress. [zube]: In Progress and removed review [zube]: In Review labels Sep 18, 2019

sayden force-pushed the feature/xp/mb/tomcat-lm branch from dc6e977 to 63b8fdb Compare September 20, 2019 10:38

sayden marked this pull request as ready for review September 20, 2019 11:01

sayden requested a review from a team as a code owner September 20, 2019 11:01

sayden added [zube]: In Review review and removed [zube]: In Progress in progress Pull request is currently in progress. labels Sep 20, 2019

Titch990 reviewed Sep 20, 2019

View reviewed changes

metricbeat/docs/modules/tomcat.asciidoc Outdated Show resolved Hide resolved

Titch990 reviewed Sep 20, 2019

View reviewed changes

jsoriano approved these changes Sep 23, 2019

View reviewed changes

sayden added [zube]: In Progress and removed [zube]: In Review labels Sep 24, 2019

kaiyan-sheng approved these changes Sep 24, 2019

View reviewed changes

sayden force-pushed the feature/xp/mb/tomcat-lm branch from 6c6ca08 to 40f0215 Compare September 25, 2019 09:07

sayden added 6 commits September 26, 2019 15:57

Atomic commit

361f21d

Delete README.md file from root folder

42879bd

Update docs

27e8115

Address comments by Titch990

c48aee2

Set a fixed version of Tomcat for tests

91881d6

Add changelog entry

f5e4f0c

sayden force-pushed the feature/xp/mb/tomcat-lm branch from 40f0215 to f5e4f0c Compare September 26, 2019 13:58

sayden merged commit d0c34f9 into elastic:master Sep 27, 2019

zube bot added [zube]: Done and removed [zube]: In Progress labels Sep 27, 2019

andresrc removed the [zube]: Done label Oct 1, 2019

urso added the v7.5.0 label Oct 22, 2019

dagwieers mentioned this pull request Aug 25, 2020

tomcat module doesn't allow to set mbean (or mbean domain) #20773

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Metricbeat] Apache Tomcat lightweight module #13491

[Metricbeat] Apache Tomcat lightweight module #13491

sayden commented Sep 4, 2019 •

edited

Loading

kaiyan-sheng commented Sep 13, 2019

jsoriano left a comment

Titch990 Sep 20, 2019 •

edited

Loading

sayden Sep 23, 2019

jsoriano left a comment

jsoriano Sep 23, 2019

dagwieers Aug 24, 2020

jsoriano Aug 25, 2020 •

edited

Loading

jsoriano Aug 25, 2020

dagwieers Aug 25, 2020 •

edited

Loading

dagwieers Aug 25, 2020

jsoriano Sep 23, 2019

sayden Sep 24, 2019

kaiyan-sheng commented Sep 24, 2019

jsoriano commented Sep 24, 2019

sayden commented Sep 27, 2019

andresrc commented Dec 10, 2019

	The current estimate of the cache size in kB
	The current estimate of the cache size in kilobytes

	FROM tomcat:jdk13-openjdk-oracle
	ARG TOMCAT_VERSION=9.0.26
	FROM tomcat:${TOMCAT_VERSION}-jdk13-openjdk-oracle

[Metricbeat] Apache Tomcat lightweight module #13491

[Metricbeat] Apache Tomcat lightweight module #13491

Conversation

sayden commented Sep 4, 2019 • edited Loading

kaiyan-sheng commented Sep 13, 2019

jsoriano left a comment

Choose a reason for hiding this comment

Titch990 Sep 20, 2019 • edited Loading

Choose a reason for hiding this comment

sayden Sep 23, 2019

Choose a reason for hiding this comment

jsoriano left a comment

Choose a reason for hiding this comment

jsoriano Sep 23, 2019

Choose a reason for hiding this comment

dagwieers Aug 24, 2020

Choose a reason for hiding this comment

jsoriano Aug 25, 2020 • edited Loading

Choose a reason for hiding this comment

jsoriano Aug 25, 2020

Choose a reason for hiding this comment

dagwieers Aug 25, 2020 • edited Loading

Choose a reason for hiding this comment

dagwieers Aug 25, 2020

Choose a reason for hiding this comment

jsoriano Sep 23, 2019

Choose a reason for hiding this comment

sayden Sep 24, 2019

Choose a reason for hiding this comment

kaiyan-sheng commented Sep 24, 2019

jsoriano commented Sep 24, 2019

sayden commented Sep 27, 2019

andresrc commented Dec 10, 2019

sayden commented Sep 4, 2019 •

edited

Loading

Titch990 Sep 20, 2019 •

edited

Loading

jsoriano Aug 25, 2020 •

edited

Loading

dagwieers Aug 25, 2020 •

edited

Loading