Skip to content

Commit 0bcd1d7

Browse files
JV0812jpipkin1
andauthored
Added monitors informations to the OTEL apps (#4742)
* Added monitors informations to the OTEL apps * minor path fix * added alerts information * Fix broken links * Update docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/integrations/databases/opentelemetry/mysql-opentelemetry.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/integrations/hosts-operating-systems/opentelemetry/linux-opentelemetry.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/integrations/hosts-operating-systems/opentelemetry/macos-opentelemetry.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/integrations/hosts-operating-systems/opentelemetry/windows-opentelemetry.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/integrations/databases/opentelemetry/mysql-opentelemetry.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/integrations/databases/opentelemetry/mysql-opentelemetry.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * minor fixes --------- Co-authored-by: John Pipkin <[email protected]>
1 parent 0fb7880 commit 0bcd1d7

File tree

13 files changed

+522
-295
lines changed

13 files changed

+522
-295
lines changed

docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ Java Management Extensions (JMX) is a standard component of the Java Platform. J
1515

1616
The Sumo Logic app for JMX allows you to analyze and gain insights about Java applications. The dashboards provide a quick glance at various deployment metrics like memory, GC performance, and thread behavior, so you can troubleshoot unexpected behavior in your Java environment and the applications running in it.
1717

18+
:::info
19+
This app includes [built-in monitors](#jmx-alerts). For details on creating custom monitors, refer to [Create monitors for JMX app](#create-monitors-for-jmx-app).
20+
:::
21+
1822
## Metrics types
1923

2024
The Sumo Logic app for JMX collects metrics from Java applications via the [JMX Receiver for OpenTelemetry](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver).
@@ -29,7 +33,7 @@ The following types of metrics are collected from JMX:
2933

3034
For more information on different metrics collected, refer to the [JMX receiver docs](https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/jmx-metrics/docs/target-systems/jvm.md).
3135

32-
### Sample queries
36+
### Sample metrics query
3337

3438
```sql
3539
sumo.datasource=jmx metric=jvm.memory.heap.used
@@ -100,7 +104,7 @@ Click on the **Download YAML File** button to get the yaml file.
100104

101105
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/JMX-OpenTelemetry/JMX-OTEL-YAML.png' style={{border:'1px solid gray'}} alt="YAML" />
102106

103-
### Step 3: Send logs and metrics to Sumo
107+
### Step 3: Send logs and metrics to Sumo Logic
104108

105109
import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md';
106110

@@ -180,13 +184,11 @@ If you have multiple Java processes running on the same host, then you need to s
180184
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/JMX-OpenTelemetry/JMX-Add-New-Host.png' alt="Add Another Host" />
181185
:::
182186

187+
## Viewing JMX dashboards
183188

184-
185-
## Viewing JMX Dashboards
186-
187-
:::tip Filter with template variables
188-
Template variables provide dynamic dashboards that can rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you view dynamic changes to the data for a quicker resolution to the root cause. You can use template variables to drill down and examine the data on a granular level. For more information, see [Filter with template variables](/docs/dashboards/filter-template-variables.md).
189-
:::
189+
All dashboards have a set of filters that you can apply to the entire dashboard. Use these filters to drill down and examine the data to a granular level.
190+
- You can change the time range for a dashboard or panel by selecting a predefined interval from a drop-down list, choosing a recently used time range, or specifying custom dates and times. [Learn more](/docs/dashboards/set-custom-time-ranges/).
191+
- You can use template variables to drill down and examine the data on a granular level. For more information, see [Filtering Dashboards with Template Variables](/docs/dashboards/filter-template-variables/).
190192

191193
### Overview
192194

@@ -222,14 +224,10 @@ Use this dashboard to:
222224

223225
### Class Loading and Threads
224226

225-
The **JMX - Class Loading and Threads** dashboard shows key information about the number and type of threads deadlocked, peak, and GC threads of your java virtual machine running on the deployment.
226-
227-
Use this dashboard to:
228-
* Identify abnormal spikes in Threads and Loaded Classes.
227+
The **JMX - Class Loading and Threads** dashboard shows key information about the number and type of threads deadlocked, peak, and GC threads of your Java virtual machine running on the deployment. Use this dashboard to identify the abnormal spikes in Threads and Loaded Classes.
229228

230229
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/JMX-OpenTelemetry/JMX-Class-Loading-and-Threads.png' alt="Class Loading and Threads" />
231230

232-
233231
### Memory Pool
234232

235233
The **JMX - Memory Pool** dashboard provides key information about the memory pool usage, peak usage, collection usage, garbage collection across various memory pools of your Java virtual machine.
@@ -239,3 +237,18 @@ Use this dashboard to:
239237
* Gain insights into garbage collection impact on different memory pools.
240238

241239
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/JMX-OpenTelemetry/JMX-Memory-Pool.png' alt="Memory Pool" />
240+
241+
## Create monitors for JMX app
242+
243+
import CreateMonitors from '../../../reuse/apps/create-monitors.md';
244+
245+
<CreateMonitors/>
246+
247+
### JMX alerts
248+
249+
| Alert Name | Alert Description and conditions | Alert Condition | Recover Condition |
250+
|:--|:--|:--|:--|
251+
| `JMX - High Heap Memory Usage Alert` | This alert gets triggered when heap memory usage exceeds threshold. | Count < 20 | Count >= 20 |
252+
| `JMX - High Memory Pool Usage Alert` | This alert gets triggered when memory pool usage exceeds threshold. | Count < 20 | Count >= 20 |
253+
| `JMX - High Non Heap Memory Usage Alert` | This alert gets triggered when non heap memory usage exceeds threshold. | Count < 20 | Count >= 20 |
254+
| `JMX - High Number Of Classes Loaded Alert` | This alert gets triggered when high number of classes are loaded. | Count > 1000 | Count < = 1000 |

docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md

Lines changed: 51 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -19,31 +19,34 @@ The diagram below illustrates the components of the ActiveMQ collection for each
1919

2020
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/ActiveMQ-OpenTelemetry/ActiveMQ-OTel-Collection-architecture.png' alt="ActiveMQ OTel Collection architecture" />
2121

22-
This app has been tested with following ActiveMQ versions:
23-
* 5.17.4
24-
* 5.18.2
22+
This app has been tested with the following ActiveMQ versions:
23+
* `5.17.4`
24+
* `5.18.2`
25+
26+
:::info
27+
This app includes [built-in monitors](#activemq-alerts). For details on creating custom monitors, refer to [Create monitors for ActiveMQ app](#create-monitors-for-activemq-app).
28+
:::
2529

2630
## Log and metrics types
2731

28-
The Sumo Logic App for ActiveMQ assumes:
32+
The Sumo Logic app for ActiveMQ uses:
2933

30-
- ActiveMQ app supports the below log format in the log4j2.properties file.
34+
- ActiveMQ app supports the below log format in the `log4j2.properties` file.
3135

32-
* [Audit Logs](https://activemq.apache.org/audit-logging): Every management action made through JMX or Web Console management interface is logged in audit log files.
36+
* [Audit Logs](https://activemq.apache.org/audit-logging). Every management action made through JMX or Web Console management interface is logged in audit log files.
3337

3438
`appender.auditlog.layout.pattern=%d | %-5p | %m | %t%n`
3539

3640
* ActiveMQ Logs:
3741

3842
`appender.logfile.layout.pattern=%d | %-5p | %m | %c | %t%n%throwable{full}`
3943

40-
41-
- For a list of metrics that are collected and used by the app, see [ActiveMQ Metrics](https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/jmx-metrics/docs/target-systems/activemq.md).
44+
- For a list of metrics that are collected and used by the app, refer to the [ActiveMQ Metrics](https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/jmx-metrics/docs/target-systems/activemq.md).
4245

4346

4447
## Fields creation in Sumo Logic for ActiveMQ
4548

46-
Following are the [fields](/docs/manage/fields/) which will be created as part of ActiveMQ App install if not already present.
49+
Following are the [fields](/docs/manage/fields/) which will be created as part of ActiveMQ app installation, if not already present.
4750

4851
* `messaging.cluster.name`. User configured. Enter a name to uniquely identify your ActiveMQ cluster. This cluster name will be shown in the Sumo Logic dashboards.
4952
* `messaging.node.name`. Has value of `host name`.
@@ -55,7 +58,7 @@ If process metrics are enabled it will also create [fields for JMX metrics](/doc
5558

5659
## Prerequisites
5760

58-
### Configure logging in ActiveMQ:
61+
### Configure logging in ActiveMQ
5962

6063
1. By default, ActiveMQ logs (`audit.log` and `activemq.log`) are stored in the directory called `${ACTIVEMQ_HOME}/data/activemq.log`. Make a note of this logs directory.
6164
1. [Enable auditing](https://activemq.apache.org/audit-logging) if not enabled by default.
@@ -135,7 +138,7 @@ Click on the **Download YAML File** button to get the YAML file.
135138

136139
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/ActiveMQ-OpenTelemetry/ActiveMQ-OTEL-YAML.png' style={{border:'1px solid gray'}} alt="YAML" />
137140

138-
### Step 3: Send logs and metrics to Sumo
141+
### Step 3: Send logs and metrics to Sumo Logic
139142

140143
import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md';
141144

@@ -216,26 +219,32 @@ import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md';
216219

217220
## Sample log messages
218221

219-
*activemq.log*
220-
221-
```json
222+
```json title="ActiveMQ Logs"
222223
2021-06-22 15:00:41,922 | DEBUG | Stopping transport tcp:///192.168.100.8:36302@61616 | org.apache.activemq.transport.tcp.TcpTransport | ActiveMQ BrokerService[localhost] Task-15300
223224
```
224225

225-
*audit.log*
226-
227-
```json
226+
```json title="Audit Logs"
228227
2010-12-22 12:12:07,225 | INFO | admin requested /admin/createDestination.action [JMSDestination='test' JMSDestinationType='queue' secret='4eb0bc3e-9d7a-4256-844c-24f40fda98f1' ] from 127.0.0.1 | qtp12205619-39
229228
2010-12-22 12:12:14,512 | INFO | admin requested /admin/purgeDestination.action [JMSDestination='test' JMSDestinationType='queue' secret='eff6a932-1b58-45da-a64a-1b30b246cfc9' ] from 127.0.0.1 | qtp12205619-36
230229
2010-12-22 12:12:17,802 | INFO | admin requested /admin/sendMessage.action [JMSTimeToLive='' JMSXGroupSeq='' AMQ_SCHEDULED_DELAY='' JMSType='' JMSMessageCountHeader='JMSXMessageCounter' JMSXGroupID='' JMSReplyTo='' JMSDestination='test' AMQ_SCHEDULED_PERIOD='' JMSText='Enter some text
231230
here for the message body...' JMSDestinationType='queue' AMQ_SCHEDULED_CRON='' JMSCorrelationID='' AMQ_SCHEDULED_REPEAT='' JMSMessageCount='1' secret='a0e1df62-14d6-4425-82a2-17aa01a16e7d' JMSPriority='' ] from 127.0.0.1 | qtp12205619-37
232231
```
233232

233+
## Sample metrics
234+
235+
```sql
236+
"Query","metric","deployment.environment","host.name","messaging.cluster.name","messaging.node.name","messaging.system","os.type","sumo.datasource","broker","destination","unit","latest"
237+
```
238+
239+
```sql
240+
"#A","activemq.message.wait_time.avg","testprod","ip-10-0-10-92","activemq_cluster","ip-10-0-10-92","activemq","linux","activemq","localhost","testtopic","ms","254.4"
241+
```
242+
234243
## Sample queries
235244

236245
### Log query
237246

238-
This sample Query is from the **Events by Severity** panel of the **ActiveMQ - Logs** dashboard.
247+
This sample log query is from the **Events by Severity** panel of the **ActiveMQ - Logs** dashboard.
239248

240249
```sql
241250
sumo.datasource=activemq deployment.environment={{deployment.environment}} messaging.cluster.name={{messaging.cluster.name}} messaging.node.name={{messaging.node.name}}
@@ -246,29 +255,17 @@ sumo.datasource=activemq deployment.environment={{deployment.environment}} messa
246255

247256
### Metrics query
248257

249-
Sample query from **Average Enqueue Latency** panel in **ActiveMQ - Destinations** dashboard.
258+
This sample metrics query from the **Average Enqueue Latency** panel of the **ActiveMQ - Destinations** dashboard.
250259

251-
```
260+
```sql
252261
sumo.datasource=activemq deployment.environment={{deployment.environment}} messaging.cluster.name={{messaging.cluster.name}} messaging.node.name={{messaging.node.name}} destination={{destination}} !(destination=activemq.*) metric=activemq.message.wait_time.avg | avg by destination,messaging.cluster.name
253262
```
254263

255-
256-
## Sample metrics
257-
258-
```
259-
"Query","metric","deployment.environment","host.name","messaging.cluster.name","messaging.node.name","messaging.system","os.type","sumo.datasource","broker","destination","unit","latest"
260-
```
261-
262-
```
263-
"#A","activemq.message.wait_time.avg","testprod","ip-10-0-10-92","activemq_cluster","ip-10-0-10-92","activemq","linux","activemq","localhost","testtopic","ms","254.4"
264-
```
265-
266-
267264
## Viewing the ActiveMQ dashboards
268265

269-
### Dashboard filters with template variables
270-
271-
Template variables provide dynamic dashboards that rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you can view dynamic changes to the data for a fast resolution to the root cause. For more information, see the [Filter with template variables](/docs/dashboards/filter-template-variables.md) help page.
266+
All dashboards have a set of filters that you can apply to the entire dashboard. Use these filters to drill down and examine the data to a granular level.
267+
- You can change the time range for a dashboard or panel by selecting a predefined interval from a drop-down list, choosing a recently used time range, or specifying custom dates and times. [Learn more](/docs/dashboards/set-custom-time-ranges/).
268+
- You can use template variables to drill down and examine the data on a granular level. For more information, see [Filtering Dashboards with Template Variables](/docs/dashboards/filter-template-variables/).
272269

273270
### Overview
274271

@@ -283,7 +280,6 @@ Use this dashboard to:
283280

284281
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/ActiveMQ-OpenTelemetry/ActiveMQ-Overview.png' alt="ActiveMQ dashboards" />
285282

286-
287283
### Brokers
288284

289285
The **ActiveMQ - Brokers** dashboard provides an at-a-glance view of the state of your brokers in the ActiveMQ cluster.
@@ -295,8 +291,6 @@ Use this dashboard to:
295291

296292
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/ActiveMQ-OpenTelemetry/ActiveMQ-Brokers.png' alt="ActiveMQ dashboards" />
297293

298-
299-
300294
### Destinations
301295

302296
The **ActiveMQ - Destinations** dashboard provides an at-a-glance view of the state of your topics/queues in ActiveMQ clusters.
@@ -307,10 +301,8 @@ Use this dashboard to:
307301
* Monitor producers, consumers and expired messages on topics/queues.
308302
* Determine the number of topics/queues.
309303

310-
311304
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/ActiveMQ-OpenTelemetry/ActiveMQ-Destinations.png' alt="ActiveMQ dashboards" />
312305

313-
314306
### Resource utilization
315307

316308
The **ActiveMQ - Resource Utilization** dashboard provides an at-a-glance view of the state of system loads in clusters: Virtual memory usage, physical memory usage, CPU utilization, disk operations, disk writes, and I/O wait.
@@ -322,8 +314,6 @@ Use this dashboard to:
322314

323315
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/ActiveMQ-OpenTelemetry/ActiveMQ-Resource-Utilization.png' alt="ActiveMQ dashboards" />
324316

325-
326-
327317
### Logs
328318

329319
The **ActiveMQ - Logs** dashboard helps you quickly analyze your ActiveMQ error logs across all clusters.
@@ -347,3 +337,22 @@ Use this dashboard to:
347337
* Quickly determine patterns across all audit logs in a given ActiveMQ cluster.
348338

349339
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/ActiveMQ-OpenTelemetry/ActiveMQ-Audit.png' alt="ActiveMQ dashboards" />
340+
341+
## Create monitors for ActiveMQ app
342+
343+
import CreateMonitors from '../../../reuse/apps/create-monitors.md';
344+
345+
<CreateMonitors/>
346+
347+
### ActiveMQ alerts
348+
349+
| Alert Name | Alert Description and conditions | Alert Condition | Recover Condition |
350+
|:--|:--|:--|:--|
351+
| `ActiveMQ - High CPU Usage Alert` | This alert gets triggered when CPU usage on a node in a ActiveMQ cluster is high. | Count >= 80 | Count < 80 |
352+
| `ActiveMQ - High Memory Usage Alert` | This alert gets triggered when memory usage on a node in a ActiveMQ cluster is high. | Count >= 80 | Count < 80 |
353+
| `ActiveMQ - High Storage Used Alert` | This alert gets triggered when there is high store usage on a node in a ActiveMQ cluster. | Count >= 80 | Count < 80 |
354+
| `ActiveMQ - Maximum Connection Alert` | This alert gets triggered when one node in ActiveMQ cluster exceeds the maximum allowed client connection limit. | Count >= 1 | Count < 1 |
355+
| `ActiveMQ - No Consumers on Queues Alert` | This alert gets triggered when a ActiveMQ queue has no consumers. | Count < 1 | Count >= 1 |
356+
| `ActiveMQ - Node Down Alert` | This alert gets triggered when a node in the ActiveMQ cluster is down. | Count >= 1 | Count < 1 |
357+
| `ActiveMQ - Too Many Connections Alert` | This alert gets triggered when there are too many connections to a node in a ActiveMQ cluster. | Count >= 1000 | Count < 1000 |
358+

0 commit comments

Comments
 (0)