OpenSearch integrates with CloudMonitor to monitor key application metrics such as storage capacity, compute resources, and query QPS. You can track application usage and configure alert rules for specific metrics.
Metrics
|
Parameter |
Description |
|
DocSizebyApp |
The total storage capacity in use. |
|
DocSizeRatiobyApp |
The percentage of storage capacity used relative to the document quota. |
|
DocCountbyApp |
The total number of documents. |
|
QPSbyApp |
The number of queries per second. |
|
LossQPSbyApp |
The number of throttled queries per second. |
|
LatencybyApp |
The time taken for a single query. |
|
ComputeResourcebyApp |
The number of compute units used per second for queries. |
|
ComputeResourceRatiobyApp |
The percentage of compute units used per second for queries, relative to the quota. |
|
ComputeCostbyApp |
The compute units consumed per query. |
|
DailyPeakComputeResourcebyApp |
The daily peak of compute units used for queries. |
|
App Batch Import Throughput |
The number of bytes read from the data source per second during a full import. |
|
App Batch Read TPS |
The number of documents read from the data source per second during a full import. |
|
App Batch Write TPS |
The number of documents written to the engine per second during a full import, after data processing (such as join or plug-in processing). |
|
App Real-time Input Throughput |
The number of bytes read from a data source or API per second. |
|
App Real-time Trigger Latency |
The current update latency for secondary table data. |
|
App Real-time Write Latency |
The current update latency for primary table data. |
|
App Real-time Read TPS |
The number of documents read from a data source or API per second. |
|
App Real-time Write TPS |
The number of documents written to the engine per second during real-time synchronization, after data processing (such as join or plug-in processing). |
|
App Secondary Table Trigger TPS |
The number of primary table documents updated per second, triggered by changes in the secondary table. For example, if one record in a secondary table is updated per second and the primary-to-secondary table ratio is 3:1, up to three primary table documents might be updated. |
|
App Real-time Push Throttling QPS |
The number of application push requests throttled per second. |
View CloudMonitor metrics
-
Log on to the OpenSearch console. In the upper-left corner, select OpenSearch High-performance Search Edition. On the instance management page, click details.
-
In the upper-right corner, click CloudMonitor to view the current usage of your application.
-
The CloudMonitor page:
Enable Initiative Alert
By default, Initiative Alert is pre-configured with four metrics: DocSizeRatiobyApp, ComputeResourceRatiobyApp, LossQPSbyApp, and App Real-time Write Latency. To enable this feature:
-
Log on to the OpenSearch console. In the upper-left corner, select OpenSearch High-performance Search Edition to go to the instance management page. Click Initiative Alert. (Alternatively, you can log on directly to the CloudMonitor console and skip to Step 3.)
-
If the status for Initiative Alert is Disabled, click the Enable Now button. (If the status is Enabled, no action is required.)
-
On the CloudMonitor page, click Alerts and then Initiative Alert. Find OpenSearch in the list and turn on the switch. (Click the expand icon to view and configure individual alert items.)
Create custom rules
-
To create a custom alert rule and configure an alert contact, see alert rule and alert contact.
-
If you have unresolved CloudMonitor issues, submit a ticket for assistance.