-
Notifications
You must be signed in to change notification settings - Fork 249
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5106 from EnterpriseDB/release/2023-12-20
Release/2023-12-20
- Loading branch information
Showing
21 changed files
with
1,971 additions
and
1,991 deletions.
There are no files selected for viewing
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
3 changes: 3 additions & 0 deletions
3
...itoring_and_logging/monitoring_using_pemx/images/monitoring_and_logging_tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
95 changes: 95 additions & 0 deletions
95
...release/using_cluster/05_monitoring_and_logging/monitoring_using_pemx/index.mdx
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
--- | ||
title: "Monitoring using PEMx" | ||
--- | ||
|
||
PEMx is an integrated monitoring and alerting solution in BigAnimal. It's designed to monitor the performance of the Postgres clusters. PEMx actively monitors various metrics of the Postgres clusters and triggers an alert as the defined thresholds are exceeded. This solution smoothly integrates into the BigAnimal ecosystem, using the vast amount of metric data that's gathered from Postgres clusters and their underlying infrastructure across all the regions. | ||
|
||
PEMx renders insightful charts that empower you to actively monitor each metric's behavior. PEMx provides a streamlined path for you to take prompt and informed actions based on the generated alerts. This cohesive monitoring and alert system ensures comprehensive oversight and prompt responses in the BigAnimal environment. | ||
|
||
When you log in, PEMx monitoring widgets are displayed on the overview page on the project summary page. These widgets are available only for the deployed Postgres clusters and aren't available for the clusters in the provisioning process. They provide high-level, key information on: | ||
- Memory | ||
- CPU | ||
- Storage usage percentages | ||
- Transactions per second | ||
- Database size | ||
|
||
To see more in-depth metrics specific to the Postgres cluster, select any widget on the overview page. Selecting the widget opens the **Monitoring and Logging** tab of the cluster page. | ||
|
||
![Monitoring and logging tab](images/monitoring_and_logging_tab.png) | ||
|
||
To view the **Monitoring and Logging** tab from the BigAnimal portal: | ||
|
||
1. In the left navigation of BigAnimal portal, go to **Clusters**. | ||
2. Select any ready cluster. | ||
3. On the cluster detail page, select the **Monitoring and Logging** tab. | ||
|
||
The **Monitoring and Logging** tab displays the detailed PEMx monitoring metrics specific to that cluster in the form of charts: | ||
|
||
- [Single-value charts](#single-value-charts) | ||
- [Historical charts](#historical-charts) | ||
|
||
## Single-value charts | ||
|
||
These charts display a specific single value based on the last value in the selected time interval. For example, if you choose **Last N**, the chart displays the current value. For the specific time interval, it displays the value at the end of that time interval. These charts display key metrics in text, gauges, or pie and donut form. They provide a concise snapshot of information such as: | ||
- **Memory** (gauge chart) — The percentage of memory used by the Postgres cluster in the hosting node. | ||
- **CPU** (gauge chart) — The percentage of CPU used by the Postgres cluster in the hosting node. | ||
- **Storage** (gauge chart) — The percentage of the storage volume used by the Postgres cluster in the hosting node. | ||
- **Storage** (donut chart) — The units of the storage volume used and available for the Postgres cluster. | ||
- **Active connections** (text value) — The current number of connections between the client applications and the Postgres cluster. | ||
- **Disk throughput** (text value) — The amount of data transferred to and from the disk per second for the Postgres cluster. | ||
- **Transactions per second** (text value) — The total number of transactions executing in a second for the Postgres cluster. | ||
- **Database size** (text value) — The amount of storage volume used by the Postgres cluster. | ||
|
||
## Historical charts | ||
|
||
By default, these charts displays the historical data of the last 15 minutes. To view the historical data of a particular time range, customize the time range using a time-range picker. These charts display key metrics in single-line and bar or multi-line and bar form. They provide a concise snapshot of the information such as: | ||
- **Memory** (line chart) — The historical trend of memory usage percentage over a time period. | ||
- **CPU** (bar chart) — The historical trend of CPU usage percentage over a time period. | ||
- ** Network activity** (bar chart) — The historical data transfer to and from the network card per second, over a time period. | ||
- **Disk IOPS** (multi-line chart) — The historical trends in the number of reads, writes, and total operations on the disk per second, over a time period. | ||
- **Transaction per second** (multi-line chart) — The historical trends in the number of transactions per second, over a time period. | ||
|
||
|
||
## Features for both types of charts | ||
|
||
All these charts have tools and features that help you to get more information about the metrics or the chart. The [time-range picker](#time-range-picker) helps with viewing the data on these charts for a specific time-range interval. The [information tootip](#information-tooltip) helps you to view the information for a particular chart. The [charts error state](#charts-error-state) helps you to find the error and provides the option to edit the configurations and fix the error. | ||
|
||
### Time-range picker | ||
|
||
To view the data of a particular time range configure the time range, on the **Monitoring and Logging** tab, use: | ||
- The **Last X** list | ||
- The date-time picker | ||
|
||
The **Last X** list provides several time-range options. Each option in the list is enabled only after the specifiec time duration has elapsed since the Postgres cluster was created. The default time range is 15 minutes, and the maximum is **Last 30 days**. | ||
|
||
!!! Note | ||
When you select the time range from the **Last X** list, the data on the **Monitoring and Logging** tab refreshes every 30 seconds. | ||
!!! | ||
|
||
### Information tooltip | ||
|
||
Each chart has an information tooltip that provides a detailed description of the chart. To view the information, hover over the tooltip icon on the right side of the chart name. | ||
|
||
### Charts error state | ||
|
||
A red warning icon is displayed next to the tooltip if there's any error for that chart. If any of the metric exceeds its threshold, an error indicator appears. Selecting the red icon displays a window with a description of the error and an **Edit Cluster** button. Select **Edit Cluster** to go to the Edit Cluster page. Make the configuration changes based on the specific metric that brings the cluster to a healthy state. | ||
|
||
The table shows a list of errors and the corresponding solutions. | ||
|
||
| Error | Solution | | ||
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------ | | ||
| **High CPU** | On the Edit Cluster page, select the preferred category, instance series, and the instance size to increase the CPU. | | ||
| **High Memory** | On the Edit Cluster page, select the preferred category, instance series, and the instance size to increase the memory size. | | ||
| **High Storage** | On the Edit Cluster page, go to the cluster settings and increase the volume size to increase the storage. | | ||
|
||
## Features for historical charts | ||
|
||
You can [zoom](#zooming-charts) the historical charts and also [download](#download-csv) the data of the historical charts. | ||
|
||
### Zooming charts | ||
|
||
To zoom in an area on the historical chart, drag and select that specific area. To reset, select **Reset zoom** from the ellipsis menu at the top-right corner of the chart. | ||
|
||
### Download CSV | ||
|
||
To download the metrics data used to produce the chart in CSV format, from the ellipsis menu in the top-right corner of the chart, select **Download CSV**. The download includes only the data currently visible on the chart. To download the different data, configure the time-range picker before selecting **Download CSV**. |
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
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
8bd8cd4
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉 Published on https://edb-docs.netlify.app as production
🚀 Deployed on https://65842d23e2582cea3be19cbd--edb-docs.netlify.app
8bd8cd4
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉 Published on https://edb-docs-staging.netlify.app as production
🚀 Deployed on https://65842d52215c8ce8366c9d27--edb-docs-staging.netlify.app