Skip to content

Commit

Permalink
chore: fix link/format config code
Browse files Browse the repository at this point in the history 
broken link and code indentation fixed. Also wrapped config settings in backticks instead of bold
  • Loading branch information
@brnhensley
brnhensley committed May 6, 2024
1 parent 12e5aaf commit 7b97956
Showing 1 changed file with 82 additions and 82 deletions.
164 changes: 82 additions & 82 deletions src/install/jmx/whatsNext.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The JMX integration collects both metrics and inventory information. This table

<tr>
<td>
<DoNotTranslate>**JMX_HOST**</DoNotTranslate>
`JMX_HOST`
</td>

<td>
Expand All @@ -67,15 +67,15 @@ The JMX integration collects both metrics and inventory information. This table

<tr>
<td>
<DoNotTranslate>**JMX_PORT**</DoNotTranslate>
`JMX_PORT`
</td>

<td>
The port JMX is running on.
</td>

<td>
9999
`9999`
</td>

<td style={{ 'text-align': 'center' }}>
Expand All @@ -89,7 +89,7 @@ The JMX integration collects both metrics and inventory information. This table

<tr>
<td>
<DoNotTranslate>**JMX_URI_PATH**</DoNotTranslate>
`JMX_URI_PATH`
</td>

<td>
Expand All @@ -112,7 +112,7 @@ The JMX integration collects both metrics and inventory information. This table

<tr>
<td>
<DoNotTranslate>**JMX_USER**</DoNotTranslate>
`JMX_USER`
</td>

<td>
Expand All @@ -134,7 +134,7 @@ The JMX integration collects both metrics and inventory information. This table

<tr>
<td>
<DoNotTranslate>**JMX_PASS**</DoNotTranslate>
`JMX_PASS`
</td>

<td>
Expand All @@ -156,7 +156,7 @@ The JMX integration collects both metrics and inventory information. This table

<tr>
<td>
<DoNotTranslate>**JMX_REMOTE**</DoNotTranslate>
`JMX_REMOTE`
</td>

<td>
Expand All @@ -179,12 +179,12 @@ The JMX integration collects both metrics and inventory information. This table

<tr>
<td>
<DoNotTranslate>**JMX_REMOTE_JBOSS_STANDLONE**</DoNotTranslate>
`JMX_REMOTE_JBOSS_STANDLONE`
</td>

<td>
(JBoss specific) Whether or not to use the JBoss standalone connection
format. Only relevant if `jmx_remote` is set.
format. Only relevant if `JMX_REMOTE` is set.
</td>

<td>
Expand All @@ -198,7 +198,7 @@ The JMX integration collects both metrics and inventory information. This table

<tr>
<td>
<DoNotTranslate>**CONNECTION_URL**</DoNotTranslate>
`CONNECTION_URL`
</td>

<td>
Expand All @@ -222,7 +222,7 @@ The JMX integration collects both metrics and inventory information. This table

<tr>
<td>
<DoNotTranslate>**COLLECTION_FILES**</DoNotTranslate>
`COLLECTION_FILES`
</td>

<td>
Expand All @@ -241,7 +241,7 @@ The JMX integration collects both metrics and inventory information. This table

<tr>
<td>
<DoNotTranslate>**COLLECTION_CONFIG**</DoNotTranslate>
`COLLECTION_CONFIG`
</td>

<td>
Expand All @@ -259,7 +259,7 @@ Tomcat Example:
COLLECTION_CONFIG={"collect":[{"domain":"Catalina","event_type":"TomcatSample","beans":[{"query":"type=UtilityExecutor","attributes":["completedTaskCount"]}]}]}
```

`COLLECTION_CONFIG` is useful to [configure nri-jmx in Kubernetes using annotations](#metrics-collection-kubernetes-annotations).
`COLLECTION_CONFIG` is useful to [configure `nri-jmx` in Kubernetes using annotations](#metrics-collection-kubernetes-annotations).
</td>

<td>
Expand All @@ -277,7 +277,7 @@ COLLECTION_CONFIG={"collect":[{"domain":"Catalina","event_type":"TomcatSample","

<tr>
<td>
<DoNotTranslate>**KEY_STORE**</DoNotTranslate>
`KEY_STORE`
</td>

<td>
Expand All @@ -299,7 +299,7 @@ COLLECTION_CONFIG={"collect":[{"domain":"Catalina","event_type":"TomcatSample","

<tr>
<td>
<DoNotTranslate>**KEY_STORE_PASSWORD**</DoNotTranslate>
`KEY_STORE_PASSWORD`
</td>

<td>
Expand All @@ -321,7 +321,7 @@ COLLECTION_CONFIG={"collect":[{"domain":"Catalina","event_type":"TomcatSample","

<tr>
<td>
<DoNotTranslate>**LOCAL_ENTITY**</DoNotTranslate>
`LOCAL_ENTITY`
</td>

<td>
Expand All @@ -343,15 +343,15 @@ COLLECTION_CONFIG={"collect":[{"domain":"Catalina","event_type":"TomcatSample","

<tr>
<td>
<DoNotTranslate>**TIMEOUT**</DoNotTranslate>
`TIMEOUT`
</td>

<td>
The timeout for individual JMX queries, in milliseconds.
</td>

<td>
10000
`10000`
</td>

<td style={{ 'text-align': 'center' }}>
Expand All @@ -365,7 +365,7 @@ COLLECTION_CONFIG={"collect":[{"domain":"Catalina","event_type":"TomcatSample","

<tr>
<td>
<DoNotTranslate>**TRUST_STORE**</DoNotTranslate>
`TRUST_STORE`
</td>

<td>
Expand All @@ -387,7 +387,7 @@ COLLECTION_CONFIG={"collect":[{"domain":"Catalina","event_type":"TomcatSample","

<tr>
<td>
<DoNotTranslate>**TRUST_STORE_PASSWORD**</DoNotTranslate>
`TRUST_STORE_PASSWORD`
</td>

<td>
Expand All @@ -409,16 +409,16 @@ COLLECTION_CONFIG={"collect":[{"domain":"Catalina","event_type":"TomcatSample","

<tr>
<td>
<DoNotTranslate>**METRIC_LIMIT**</DoNotTranslate>
`METRIC_LIMIT`
</td>

<td>
Number of metrics that can be collected per entity. If this limit is
exceeded the entity will not be reported. A limit of 0 implies no limit.
exceeded the entity will not be reported. A limit of `0` implies no limit.
</td>

<td>
200
`200`
</td>

<td style={{ 'text-align': 'center' }}>
Expand All @@ -432,7 +432,7 @@ COLLECTION_CONFIG={"collect":[{"domain":"Catalina","event_type":"TomcatSample","

<tr>
<td>
<DoNotTranslate>**METRICS**</DoNotTranslate>
`METRICS*`
</td>

<td>
Expand All @@ -452,7 +452,7 @@ COLLECTION_CONFIG={"collect":[{"domain":"Catalina","event_type":"TomcatSample","

<tr>
<td>
<DoNotTranslate>**INVENTORY**</DoNotTranslate>
`INVENTORY`
</td>

<td>
Expand Down Expand Up @@ -484,9 +484,9 @@ You can customize your labels, too. Add key or value pair attributes to your met
Our default sample config file has examples of labels. These aren't mandatory, and you can remove, modify, or add new ones of your choice.

```yml
labels:
env: production
role: jmx
labels:
env: production
role: jmx
```
</Collapser>
</CollapserGroup>
Expand Down Expand Up @@ -738,16 +738,16 @@ Example file configurations for an on-host install:
>
```yaml
integrations:
- name: nri-jmx
env:
COLLECTION_FILES: "/etc/newrelic-infra/integrations.d/jvm-metrics.yml,/etc/newrelic-infra/integrations.d/tomcat-metrics.yml"
JMX_HOST: jmx-host.localnet
JMX_PASS: admin
JMX_PORT: 9999
JMX_USER: admin
interval: 15s
labels:
env: production
- name: nri-jmx
env:
COLLECTION_FILES: "/etc/newrelic-infra/integrations.d/jvm-metrics.yml,/etc/newrelic-infra/integrations.d/tomcat-metrics.yml"
JMX_HOST: jmx-host.localnet
JMX_PASS: admin
JMX_PORT: 9999
JMX_USER: admin
interval: 15s
labels:
env: production
```
</Collapser>

Expand All @@ -757,47 +757,47 @@ Example file configurations for an on-host install:
>
```yaml
collect:
# The event type for this domain will be JavaLangSample
- domain: java.lang
beans:
# Collect all beans of type Threading
- query: type=Threading
# Attributes can be either a string or a map
attribute:
# When unspecified, the metric_type is inferred
# and the metric name is just the attribute name
- ThreadCount
# If using a map attribute, a custom metric name can be set
- attr: TotalStartedThreadCount
metric_name: ThreadsStarted
# Attributes can be collected with regex matches and
# the metric type can be overridden if the integration
# can not correctly infer the type
- attr_regex: "ThreadCpu.*Enabled"
metric_type: attribute
- query: type=Memory
attributes:
# Composite attributes can be collected with this syntax
- HeapMemoryUsage.Max
- NonHeapMemoryUsage.Max
# Queries can be wildcarded where
- query: type=GarbageCollector,name=*
# If a specific bean is unwanted, it can be excluded
# with a regex match pattern. Useful if using a wildcard query
exclude_regex:
# This will match any bean where the name is YoungGen
- name=YoungGen
attributes:
- attr: LastGcInfo.GcThreadCount
metric_type: gauge
metric_name: GCThreadCount
# Domains can be wildcarded
- domain: java.util.*
# If the domain is wildcarded, a custom event must be defined
event_type: JavaUtilSample
beans:
# If no attributes are defined, all are collected by default
- query: type=Logging
# The event type for this domain will be JavaLangSample
- domain: java.lang
beans:
# Collect all beans of type Threading
- query: type=Threading
# Attributes can be either a string or a map
attribute:
# When unspecified, the metric_type is inferred
# and the metric name is just the attribute name
- ThreadCount
# If using a map attribute, a custom metric name can be set
- attr: TotalStartedThreadCount
metric_name: ThreadsStarted
# Attributes can be collected with regex matches and
# the metric type can be overridden if the integration
# can not correctly infer the type
- attr_regex: "ThreadCpu.*Enabled"
metric_type: attribute
- query: type=Memory
attributes:
# Composite attributes can be collected with this syntax
- HeapMemoryUsage.Max
- NonHeapMemoryUsage.Max
# Queries can be wildcarded where
- query: type=GarbageCollector,name=*
# If a specific bean is unwanted, it can be excluded
# with a regex match pattern. Useful if using a wildcard query
exclude_regex:
# This will match any bean where the name is YoungGen
- name=YoungGen
attributes:
- attr: LastGcInfo.GcThreadCount
metric_type: gauge
metric_name: GCThreadCount
# Domains can be wildcarded
- domain: java.util.*
# If the domain is wildcarded, a custom event must be defined
event_type: JavaUtilSample
beans:
# If no attributes are defined, all are collected by default
- query: type=Logging
```
</Collapser>
</CollapserGroup>
Expand Down Expand Up @@ -853,7 +853,7 @@ Each event contains the following metadata:
</td>

<td>
The JMX domain name for these metrics with the entity type “domain:” prepended.
The JMX domain name for these metrics with the entity type `domain:` prepended.
</td>
</tr>

Expand Down Expand Up @@ -893,7 +893,7 @@ Each event contains the following metadata:
</td>

<td>
For each key in the bean name, an attribute is added to the metric set called `“key:<mbean_key>` with the value of the bean's key.
For each key in the bean name, an attribute is added to the metric set called `key:<mbean_key>` with the value of the bean's key.
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -1097,7 +1097,7 @@ Troubleshooting tips:
id="jmxterm"
title="Troubleshooting via JMXTerm"
>
You can use the CLI interactive tool [JMXTerm](https://docs.cyclopsgroup.org/jmxterm) for troubleshooting. Find documentation for JMXTerm in our [`nrjmx` troubleshooting page](https://github.com/newrelic/nrjmx/blob/master/TROUBLESHOOT.md). As of `nrjmx` v1.7.0, JMXTerm is no longer bundled with `nrjmx`, and needs to be downloaded independently. Check the [`nrjmx` installation instructions] \([https://github.com/newrelic/nrjmx#installation](https://github.com/newrelic/nrjmx#installation)).
You can use the CLI interactive tool [JMXTerm](https://docs.cyclopsgroup.org/jmxterm) for troubleshooting. Find documentation for JMXTerm in our [`nrjmx` troubleshooting page](https://github.com/newrelic/nrjmx/blob/master/TROUBLESHOOT.md). As of `nrjmx` v1.7.0, JMXTerm is no longer bundled with `nrjmx`, and needs to be downloaded independently. Check the [`nrjmx` installation instructions](https://github.com/newrelic/nrjmx#installation).
</Collapser>
</CollapserGroup>

Expand Down

0 comments on commit 7b97956

Please sign in to comment.