NEWRELIC-3834 add embedded tomcat jmx instrumentation #1039
Conversation
This file contains 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
tbradellis
changed the title
tbradellis
force-pushed
the
embedded-tomcat-jmx
branch
from
d658dd1
to
fe4d8ca
Compare
|
|
tbradellis
commented
Oct 16, 2022
newrelic-agent/src/main/java/com/newrelic/agent/jmx/values/EmbeddedTomcatJmxValues.java
Outdated
Show resolved
Hide resolved
tbradellis
force-pushed
the
embedded-tomcat-jmx
branch
2 times, most recently
from
b6d9fe4
to
48ec53c
Compare
|
Tested locally with Spring Boot and embedded Tomcat. Visually confirmed that the correct charts on JVMs page light up. |
tbradellis
force-pushed
the
embedded-tomcat-jmx
branch
from
48ec53c
to
6215956
Compare
tbradellis
commented
Oct 20, 2022
instrumentation/tomcat-jmx/src/main/java/com/nr/agent/instrumentation/tomcat/TomcatUtils.java
Outdated
Show resolved
Hide resolved
tbradellis
force-pushed
the
embedded-tomcat-jmx
branch
from
6215956
to
019360f
Compare
tbradellis
commented
Nov 11, 2022
| //found | ||
| try { | ||
| if (server.queryNames(new ObjectName("Tomcat:type=Server"), null).size() == 1) { | ||
| AgentBridge.jmxApi.addJmxMBeanGroup(JMX_EMBEDDED_PREFIX); |
There was a problem hiding this comment.
Embedded tomcat will have
Tomcat:type=Server
Non-embedded will have:
Catalina:type=Server
update copyright different name for datasource mbean reorganize tomcat jmx fix tomcat utils check for embedded signal clarify comment for non embedded tc log different paths by name also check datasource b4 adding jmx clarify comment
tbradellis
force-pushed
the
embedded-tomcat-jmx
branch
from
bb2be1d
to
e1effa1
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add instrumentation to cover embedded tomcat.
The agent doesn’t correctly query the following Tomcat JMX metrics when using embedded Tomcat with SpringBoot:
type=DataSource
type=ThreadPool
type=Manager
We add Tomcat JMX values for the above categories if the server was started via one of the following two methods:
It appears that when using embedded Tomcat with Spring Boot StandardServer does get instrumented properly:
By default, embedded Tomcat JMX is disabled by Spring Boot. In application.properties Tomcat mbeans need to be enabled by adding: server.tomcat.mbeanregistry.enabled=true
The problem though is that the Mbean group namespaces are different, standalone Tomcat uses the prefix Catalina for queries whereas embedded Tomcat uses the prefix Tomcat. Our tomcat-jmx instrumentation only queries MBeans with the Catalina prefix thus queries initiated by embedded Tomcat fail due to an incorrect group name.
Standalone Tomcat JMX:
Embedded Tomcat JMX
For now, the recommended workaround would be to utilize Custom JMX instrumentation by YAML and create a dashboard to view the metrics.
Overview
Describe the changes present in the pull request
Related Github Issue
Include a link to the related GitHub issue, if applicable
Testing
run local tests against embedded tomcat to confirm metrics are collected
Checks