ALERT: Some images may not load properly within the Knowledge Base Article. If you see a broken image, please right-click and select 'Open image in a new tab'. We apologize for this inconvenience.

DX OI - Examples of how to query for Alarms in SaaS?

book

Article ID: 226446

calendar_today

Updated On:

Products

DX Operational Intelligence DX Application Performance Management

Issue/Introduction

How to query for Alarms in SaaS?

Environment

DX SaaS 

Resolution

STEP 1: Generate a Tenant token

Two options available:

a) From APM: Go to Security > Create a new Token

https://techdocs.broadcom.com/us/en/ca-enterprise-software/it-operations-management/application-performance-management/20-2/administrating/configure-your-monitoring-environment/Generate-Security-Token.html

b) From Cluster Management > Tenant> Create a Tenant Token

https://techdocs.broadcom.com/us/en/ca-enterprise-software/it-operations-management/dx-platform-on-premise/20-2/cluster-management/configure-and-manage-tenants.html#concept.dita_7f15de48ee2d22d61cf0aeffec12a3170fd0872a_GenerateTenantToken

STEP 2: Query for Alarms

Syntax

GET https://apmgw.dxi-na1.saas.broadcom.com:443/oipublic/aoanalytics/alarms/alarms_all/_search?q=<query string>

Authorization: Bearer Token <tenant token>

 

Important

Search Query should be encoded format, you can simply encode the query parameters using online tool such as https://www.urldecoder.org/ 

 

Available Filter Operators : 

AND, OR, NOT 

Also can use wildcards in the values(*) 

 

Query String Examples

1. Filter APM Critical Alarms only

- Plain text format:

product:"Application Performance Management" AND (severity:critical)AND (status:NEW OR status:UPDATED)

- Encoded:

product%3A%22Application%20Performance% 20Management%22%20AND%20(severity%3Acritical)AND%20(status%3ANEW%20OR%20status%3AUPDATED)

- Complete URL to test from Postman client 

https://apmgw.dxi-na1.saas.broadcom.com:443/oipublic/aoanalytics/alarms/alarms_all/_search?q=product%3A%22Application%20Performance% 20Management%22%20AND%20(severity%3Acritical)AND%20(status%3ANEW%20OR%20status%3AUPDATED)&from=0&size=1000 

 

2. Filter APM Anomaly alarms (Exclude using NOT) 

- Plain text format:

product:"Application Performance Management" AND (alarmType:(NOT Anomaly))AND (status:NEW OR status:UPDATED)

- Encoded:

product%3A%22Application%20Performance% 20Management%22%20AND%20(alarmType%3A(NOT%20Anomaly))AND%20(status%3ANEW%20OR%20status%3AUPDATED)

- Complete URL to test from Postman client 

https://apmgw.dxi-na1.saas.broadcom.com:443/oipublic/aoanalytics/alarms/alarms_all/_search?q=product%3A%22Application%20Performance% 20Management%22%20AND%20(alarmType%3A(NOT%20Anomaly))AND%20(status%3ANEW%20OR%20status%3AUPDATED) &from=0&size=1000 

 

3. Filter Alarms based on Management Module 

- Plain text format:

product:"Application Performance Management" AND (management_module:TestDBMM)AND (status:NEW OR status:UPDATED)

- Encoded:

product%3A%22Application%20Performance% 20Management%22%20AND%20(management_module%3ATestDBMM)AND%20(status%3ANEW%20OR%20status%3AUPDATED)

Complete URL to test from Postman client 

https://apmgw.dxi-na1.saas.broadcom.com:443/oipublic/aoanalytics/alarms/alarms_all/_search?q=product%3A%22Application%20Performance% 20Management%22%20AND%20(management_module%3ATestDBMM)AND%20(status%3ANEW%20OR%20status%3AUPDATED) &from=0&size=1000 

Please note, here "TestDBMM" is the Management Module name to filter 

 

4. Other Attribute Examples  

alarm_name "(alarm_name:(frontend* OR backend*))AND "

Encoded value => (alarm_name%3A(frontend*%20OR%20backend*))AND%20


agent_process -> "(agent_process:ClusterDeployment)AND "

Encoded value => (agent_process%253AClusterDeployment)AND%20


component_name - > "(component_name: kube-system)AND "

Encoded value => (component_name%3A%20kube-system)AND%20 


Please make sure append empty space (%20) at the end 

Additional Information

https://knowledge.broadcom.com/external/article/190815/dx-aiops-troubleshooting-common-issues.html