diff --git a/docs/get-started/advisors-details.md b/docs/get-started/advisors-details.md index b8fe94a4af..427fa8cfc2 100644 --- a/docs/get-started/advisors-details.md +++ b/docs/get-started/advisors-details.md @@ -11,39 +11,38 @@ You can also access this list through the [**Advisor checks for PMM**](https://p ### Configuration Advisors -| Advisor Name | Description | Subscription | Database Technology| +| Advisor Name | Description | Available for | Database Technology| | :--------- | :---------- | :--- |:--- | -| **Version Configuration** | Notifies of newly released database versions to streamline database maintenance and ensure the most up-to-date performance. |All Users | MySQL, MongoDB, PostgreSQL| -| **Generic Configuration** | Provides basic recommendations for improving your database configuration. | All Users |MySQL, MongoDB, PostgreSQL| -| **Resources Configuration** | Watches your database and gives you recommendations for efficient management of resources like binaries architecture, CPU number versus DB Configuration, etc. | All Users | MySQL, MongoDB| -| **Connection Configuration** |Provides recommendations on configuring database connection parameters for improving database performance. | Customers only |MySQL, MongoDB, PostgreSQL| -| **Replication Configuration** | Provides recommendations for scalable replication in database clusters. | Customers only | MySQL, MongoDB| -| **InnoDB Configuration** | Advises on configuring InnoDB optimization for high performance. | Customers only | MySQL| -| **Vacuum Configuration** | Provides recommendations on optimizing Vacuum operations. | Customers only | PostgreSQL| +| **Version Configuration** | Notifies of newly released database versions to streamline database maintenance and ensure the most up-to-date performance. | • Percona customers
• Community | MySQL, MongoDB, PostgreSQL| +| **Generic Configuration** | Provides basic recommendations for improving your database configuration. | • Percona customers
• Community |MySQL, MongoDB, PostgreSQL| +| **Resources Configuration** | Watches your database and gives you recommendations for efficient management of resources like binaries architecture, CPU number versus DB Configuration, etc. | • Percona customers
• Community | MySQL, MongoDB| +| **Connection Configuration** |Provides recommendations on configuring database connection parameters for improving database performance. | • Percona customers
• Community |MySQL, MongoDB, PostgreSQL| +| **Replication Configuration** | Provides recommendations for scalable replication in database clusters. | • Percona customers
• Community | MySQL, MongoDB| +| **InnoDB Configuration** | Advises on configuring InnoDB optimization for high performance. | Percona customers | MySQL| +| **Vacuum Configuration** | Provides recommendations on optimizing Vacuum operations. | Percona customers | PostgreSQL| ### Performance Advisors | Advisor Name | Description | Subscription | Database Technology| | :--------- | :---------- | :--- |:--- | -| **Generic Performance** | Provides basic database configuration recommendations for high-performance query execution. | All Users | MongoDB, PostgreSQL| -| **Vacuum Performance** | Helps improve the efficiency and execution speed of database Vacuum commands. | Customers only | PostgreSQL| -| **Replication Performance** |Checks efficient replication usage of your database. | Customers only | MongoDB, PostgreSQL| - +| **Generic Performance** | Provides basic database configuration recommendations for high-performance query execution. | • Percona customers
• Community | MongoDB, PostgreSQL| +| **Vacuum Performance** | Helps improve the efficiency and execution speed of database Vacuum commands. | Percona customers | PostgreSQL| +| **Replication Performance** |Checks efficient replication usage of your database. | • Percona customers
• Community | MongoDB, PostgreSQL| ### Security Advisors | Advisor Name | Description | Subscription | Database Technology| | :--------- | :---------- | :--- |:--- | -| **CVE Security** | Informs you of any database versions affected by CVE. |All Users | MongoDB, PostgreSQL | -| **Configuration Security** | Checks your database configuration to ensure that security best practices are correctly implemented. | All Users |MySQL, MongoDB, PostgreSQL| -| **Authentication Security** | Ensures that all database authentication parameters are configured securely. | Customers only |MySQL, MongoDB, PostgreSQL| -| **Replication Security** | Helps safeguard data replication by assessing security risks and providing recommendations for improving protection. | Customers only |MySQL| -| **Connection Security** | Helps identify security issues on network connections and provides recommendations for enhancing security. | Customers only |MySQL, MongoDB| +| **CVE Security** | Informs you of any database versions affected by CVE. | • Percona customers
• Community | MongoDB, PostgreSQL | +| **Configuration Security** | Checks your database configuration to ensure that security best practices are correctly implemented. | • Percona customers
• Community |MySQL, MongoDB, PostgreSQL| +| **Authentication Security** | Ensures that all database authentication parameters are configured securely. | • Percona customers
• Community |MySQL, MongoDB, PostgreSQL| +| **Replication Security** | Helps safeguard data replication by assessing security risks and providing recommendations for improving protection. | • Percona customers
• Community |MySQL| +| **Connection Security** | Helps identify security issues on network connections and provides recommendations for enhancing security. | Percona customers |MySQL, MongoDB| ### Query Advisors | Advisor Name | Description | Subscription | Database Technology| | :--------- | :---------- | :--- |:--- | -| **Index Query** | Provides query and index optimization strategies for peak database performance. | Customers only | MySQL, MongoDB, PostgreSQL | -| **Schema Design Query** | Helps create efficient database schemas by analyzing queries and offering suggestions for optimization. | All Users |MySQL| +| **Index Query** | Provides query and index optimization strategies for peak database performance. | • Percona customers
• Community | MySQL, MongoDB, PostgreSQL | +| **Schema Design Query** | Helps create efficient database schemas by analyzing queries and offering suggestions for optimization. | • Percona customers
• Community |MySQL| ## List of checks Every Advisor consists of one or more Advisor checks. diff --git a/docs/get-started/alert-templates.md b/docs/get-started/alert-templates.md index cc04b45c61..044e99ad58 100644 --- a/docs/get-started/alert-templates.md +++ b/docs/get-started/alert-templates.md @@ -18,44 +18,43 @@ To check the alert templates for your PMM instance, go to PMM > **Alerting > Ale The table below lists all the alert templates available in Percona Monitoring and Management (PMM). -This list includes both built-in templates (accessible to all PMM users), and customer-only templates. +This list includes both built-in templates (accessible to all PMM users), and Percona customers templates. -To access the customer-only templates, you must be a Percona customer and [connect PMM to Percona Platform](../how-to/integrate-platform.md) using a Percona Account. +To access the Percona customers templates, you must be a Percona customer and [connect PMM to Percona Platform](../how-to/integrate-platform.md) using a Percona Account. - -| Template name | Description | Availability | Database technology | +| Template name | Description | Available for | Database technology | | :------------ | :---------- | :----------- | :------------------ | -| **Node high CPU load** | Monitors node CPU usage and alerts when it surpasses 80% (default threshold). Provides details about specific nodes experiencing high CPU load, indicating potential performance issues or scaling needs. | All users | MySQL, MongoDB, PostgreSQL | -| **Memory available less than a threshold** | Tracks available memory on nodes and alerts when free memory drops below 20% (default threshold). Helps prevent system instability due to memory constraints. | All users | MySQL, MongoDB, PostgreSQL | -| **Node high swap filling up** | Monitors node swap usage and alerts when it exceeds 80% (default threshold). Indicates potential memory pressure and performance degradation, allowing for timely intervention. | All users | MySQL, MongoDB, PostgreSQL | -| **PMM agent down** | Monitors PMM Agent status and alerts when an agent becomes unreachable, indicating potential host or agent issues. | All users | MySQL, MongoDB, PostgreSQL, ProxySQL | -| **Backup failed [Technical Preview]** | Monitors backup processes and alerts on failures, providing details about the failed backup artifact and service. Helps maintain data safety and recovery readiness. This template is currently in Technical Preview status and should be used for testing purposes only as it is subject to change. | All users | MySQL, MongoDB, PostgreSQL, ProxySQL | -| **MongoDB down** | Detects when a MongoDB instance becomes unavailable, enabling rapid response to maintain database accessibility. | All users | MongoDB | -| **Memory used by MongoDB connections** | Tracks MongoDB connection memory usage and alerts when it exceeds configurable thresholds. Helps identify and address potential performance issues caused by high memory consumption. | All users | MongoDB | -| **Memory used by MongoDB** | Monitors overall MongoDB memory usage and alerts when it exceeds 80% of total system memory. Provides details about specific MongoDB services and nodes experiencing high memory consumption, aiding in resource optimization. | All users | MongoDB | -| **MongoDB restarted** | Detects recent MongoDB restarts, alerting if an instance has been restarted within the last 5 minutes (default threshold). Facilitates investigation of unexpected downtime and potential issues. | All users | MongoDB | -| **MongoDB DBPath disk space utilization** | Monitors disk space usage in MongoDB's data directory and alerts when it exceeds set thresholds. Helps prevent storage-related issues and ensures adequate space for database operations. | Customer-only | MongoDB | -| **MongoDB host SSL certificate expiry** | Tracks SSL certificate expiration dates for MongoDB hosts and alerts when certificates are approaching expiry. Enables timely certificate renewal to maintain secure connections. | Customer-only | MongoDB | -| **MongoDB oplog window** | Monitors the oplog window size and alerts when it falls below the recommended threshold (typically 24-48 hours). Ensures sufficient time for secondary nodes to replicate data and maintain cluster consistency. | Customer-only | MongoDB | -| **MongoDB read tickets** | Tracks read ticket availability in the WiredTiger storage engine and alerts when it falls below set thresholds. Helps optimize read performance and identify potential bottlenecks. | Customer-only | MongoDB | -| **MongoDB replication lag is high** | Monitors replication lag and alerts when it exceeds acceptable thresholds. Crucial for maintaining data consistency across replicas and identifying synchronization issues. | Customer-only | MongoDB | -| **MongoDB ReplicaSet has no primary** | Detects when a replica set loses its primary node and alerts users. Indicates that the cluster is in read-only mode, potentially affecting write operations and overall database functionality. | Customer-only | MongoDB | -| **MongoDB member is in unusual state** | Identifies and alerts when replica set members enter unusual states such as Recovering, Startup, or Rollback. Helps maintain cluster health and performance by enabling quick intervention. | Customer-only | MongoDB | -| **MongoDB write tickets** | Monitors write ticket availability in the WiredTiger storage engine and alerts when it falls below set thresholds. Aids in optimizing write performance and identifying potential bottlenecks. | Customer-only | MongoDB | -| **MySQL down** | Monitors MySQL instance availability and alerts when any MySQL service becomes unreachable. Enables quick response to maintain database services. | All users | MySQL | -| **MySQL replication running IO** | Tracks MySQL replication I/O thread status and alerts if it stops running on a replica. Crucial for ensuring data is being received from the primary server. | All users | MySQL | -| **MySQL replication running SQL** | Monitors MySQL replication SQL thread status and alerts if it stops running on a replica. Essential for verifying that received data is being applied correctly to maintain data consistency. | All users | MySQL | -| **MySQL restarted** | Detects recent MySQL restarts, alerting if an instance has been restarted within the last 5 minutes (default threshold). Aids in investigating unexpected downtime and potential issues. | All users | MySQL | -| **MySQL connections in use** | Tracks MySQL connection usage and alerts when the percentage of active connections exceeds 80% of the maximum allowed (default threshold). Helps prevent performance degradation due to connection overload. | All users | MySQL | -| **PostgreSQL down** | Detects when PostgreSQL instances become unavailable, enabling quick response to maintain database services. Provides details about affected services and nodes. | All users | PostgreSQL | -| **PostgreSQL restarted** | Identifies recent PostgreSQL restarts, alerting if an instance has been restarted within the last 5 minutes (default threshold). Aids in investigating unexpected downtime and potential issues. | All users | PostgreSQL | -| **PostgreSQL connections in use** | Monitors PostgreSQL connection usage and alerts when the percentage of active connections exceeds 80% of the maximum allowed (default threshold). Helps prevent performance degradation due to excessive connections. | All users | PostgreSQL | -| **PostgreSQL index bloat is high** | Detects excessive index bloat and alerts users. Helps identify performance degradation due to bloated indexes, enabling timely maintenance to improve query performance. | Customer-only | PostgreSQL | -| **PostgreSQL high number of dead tuples** | Monitors the accumulation of dead tuples in relations and alerts when they exceed set thresholds. Indicates potential issues with vacuum settings and helps optimize storage and query performance. | Customer-only | PostgreSQL | -| **PostgreSQL has a high number of statement timeouts** | Tracks and alerts on frequent query cancellations due to statement timeouts. Helps identify various issues such as high load, poorly written queries, or inadequate resource allocation. | Customer-only | PostgreSQL | -| **PostgreSQL table bloat is high** | Detects excessive table bloat and alerts users. Indicates a need to adjust vacuum settings for specific relations or globally, helping to maintain optimal query performance and storage efficiency. | Customer-only | PostgreSQL | -| **PostgreSQL high rate of transaction rollbacks** | Monitors the ratio of transaction rollbacks to commits and alerts on high rates. Helps identify potential application or database issues leading to frequent transaction failures. | Customer-only | PostgreSQL | -| **PostgreSQL tables not auto analyzed** | Identifies tables that are not being auto-analyzed and alerts users. Crucial for maintaining accurate statistics and generating proper query execution plans. | Customer-only | PostgreSQL | -| **PostgreSQL tables not auto vacuumed** | Detects tables that are not being auto-vacuumed and alerts users. Essential for managing bloat, optimizing storage, and maintaining overall database health. | Customer-only | PostgreSQL | -| **PostgreSQL unused replication slot** | Identifies and alerts on unused replication slots. Helps prevent excessive WAL retention and potential disk space issues, especially when replicas are offline. | Customer-only | PostgreSQL | -| **ProxySQL server status** | Tracks ProxySQL server status and alerts when a server's status becomes OFFLINE_SOFT (3) or OFFLINE_HARD (4). Provides details about the server's endpoint, hostgroup, and associated ProxySQL service. Crucial for maintaining high availability and preventing service disruptions. | All users | ProxySQL | \ No newline at end of file +| **Node high CPU load** | Monitors node CPU usage and alerts when it surpasses 80% (default threshold). Provides details about specific nodes experiencing high CPU load, indicating potential performance issues or scaling needs. | • Percona customers
• Community | MySQL, MongoDB, PostgreSQL | +| **Memory available less than a threshold** | Tracks available memory on nodes and alerts when free memory drops below 20% (default threshold). Helps prevent system instability due to memory constraints. | • Percona customers
• Community | MySQL, MongoDB, PostgreSQL | +| **Node high swap filling up** | Monitors node swap usage and alerts when it exceeds 80% (default threshold). Indicates potential memory pressure and performance degradation, allowing for timely intervention. | • Percona customers
• Community | MySQL, MongoDB, PostgreSQL | +| **PMM agent down** | Monitors PMM Agent status and alerts when an agent becomes unreachable, indicating potential host or agent issues. | • Percona customers
• Community | MySQL, MongoDB, PostgreSQL, ProxySQL | +| **Backup failed [Technical Preview]** | Monitors backup processes and alerts on failures, providing details about the failed backup artifact and service. Helps maintain data safety and recovery readiness. This template is currently in Technical Preview status and should be used for testing purposes only as it is subject to change. | • Percona customers
• Community | MySQL, MongoDB, PostgreSQL, ProxySQL | +| **MongoDB down** | Detects when a MongoDB instance becomes unavailable, enabling rapid response to maintain database accessibility. | • Percona customers
• Community | MongoDB | +| **Memory used by MongoDB connections** | Tracks MongoDB connection memory usage and alerts when it exceeds configurable thresholds. Helps identify and address potential performance issues caused by high memory consumption. | • Percona customers
• Community | MongoDB | +| **Memory used by MongoDB** | Monitors overall MongoDB memory usage and alerts when it exceeds 80% of total system memory. Provides details about specific MongoDB services and nodes experiencing high memory consumption, aiding in resource optimization. | • Percona customers
• Community | MongoDB | +| **MongoDB restarted** | Detects recent MongoDB restarts, alerting if an instance has been restarted within the last 5 minutes (default threshold). Facilitates investigation of unexpected downtime and potential issues. | • Percona customers
• Community | MongoDB | +| **MongoDB DBPath disk space utilization** | Monitors disk space usage in MongoDB's data directory and alerts when it exceeds set thresholds. Helps prevent storage-related issues and ensures adequate space for database operations. | Percona customers | MongoDB | +| **MongoDB host SSL certificate expiry** | Tracks SSL certificate expiration dates for MongoDB hosts and alerts when certificates are approaching expiry. Enables timely certificate renewal to maintain secure connections. | Percona customers | MongoDB | +| **MongoDB oplog window** | Monitors the oplog window size and alerts when it falls below the recommended threshold (typically 24-48 hours). Ensures sufficient time for secondary nodes to replicate data and maintain cluster consistency. | Percona customers | MongoDB | +| **MongoDB read tickets** | Tracks read ticket availability in the WiredTiger storage engine and alerts when it falls below set thresholds. Helps optimize read performance and identify potential bottlenecks. | Percona customers | MongoDB | +| **MongoDB replication lag is high** | Monitors replication lag and alerts when it exceeds acceptable thresholds. Crucial for maintaining data consistency across replicas and identifying synchronization issues. | Percona customers | MongoDB | +| **MongoDB ReplicaSet has no primary** | Detects when a replica set loses its primary node and alerts users. Indicates that the cluster is in read-only mode, potentially affecting write operations and overall database functionality. | Percona customers | MongoDB | +| **MongoDB member is in unusual state** | Identifies and alerts when replica set members enter unusual states such as Recovering, Startup, or Rollback. Helps maintain cluster health and performance by enabling quick intervention. | Percona customers | MongoDB | +| **MongoDB write tickets** | Monitors write ticket availability in the WiredTiger storage engine and alerts when it falls below set thresholds. Aids in optimizing write performance and identifying potential bottlenecks. | Percona customers | MongoDB | +| **MySQL down** | Monitors MySQL instance availability and alerts when any MySQL service becomes unreachable. Enables quick response to maintain database services. | • Percona customers
• Community | MySQL | +| **MySQL replication running IO** | Tracks MySQL replication I/O thread status and alerts if it stops running on a replica. Crucial for ensuring data is being received from the primary server. | • Percona customers
• Community | MySQL | +| **MySQL replication running SQL** | Monitors MySQL replication SQL thread status and alerts if it stops running on a replica. Essential for verifying that received data is being applied correctly to maintain data consistency. | • Percona customers
• Community | MySQL | +| **MySQL restarted** | Detects recent MySQL restarts, alerting if an instance has been restarted within the last 5 minutes (default threshold). Aids in investigating unexpected downtime and potential issues. | • Percona customers
• Community | MySQL | +| **MySQL connections in use** | Tracks MySQL connection usage and alerts when the percentage of active connections exceeds 80% of the maximum allowed (default threshold). Helps prevent performance degradation due to connection overload. | • Percona customers
• Community | MySQL | +| **PostgreSQL down** | Detects when PostgreSQL instances become unavailable, enabling quick response to maintain database services. Provides details about affected services and nodes. | • Percona customers
• Community | PostgreSQL | +| **PostgreSQL restarted** | Identifies recent PostgreSQL restarts, alerting if an instance has been restarted within the last 5 minutes (default threshold). Aids in investigating unexpected downtime and potential issues. | • Percona customers
• Community | PostgreSQL | +| **PostgreSQL connections in use** | Monitors PostgreSQL connection usage and alerts when the percentage of active connections exceeds 80% of the maximum allowed (default threshold). Helps prevent performance degradation due to excessive connections. | • Percona customers
• Community | PostgreSQL | +| **PostgreSQL index bloat is high** | Detects excessive index bloat and alerts users. Helps identify performance degradation due to bloated indexes, enabling timely maintenance to improve query performance. | Percona customers | PostgreSQL | +| **PostgreSQL high number of dead tuples** | Monitors the accumulation of dead tuples in relations and alerts when they exceed set thresholds. Indicates potential issues with vacuum settings and helps optimize storage and query performance. | Percona customers | PostgreSQL | +| **PostgreSQL has a high number of statement timeouts** | Tracks and alerts on frequent query cancellations due to statement timeouts. Helps identify various issues such as high load, poorly written queries, or inadequate resource allocation. | Percona customers | PostgreSQL | +| **PostgreSQL table bloat is high** | Detects excessive table bloat and alerts users. Indicates a need to adjust vacuum settings for specific relations or globally, helping to maintain optimal query performance and storage efficiency. | Percona customers | PostgreSQL | +| **PostgreSQL high rate of transaction rollbacks** | Monitors the ratio of transaction rollbacks to commits and alerts on high rates. Helps identify potential application or database issues leading to frequent transaction failures. | Percona customers | PostgreSQL | +| **PostgreSQL tables not auto analyzed** | Identifies tables that are not being auto-analyzed and alerts users. Crucial for maintaining accurate statistics and generating proper query execution plans. | Percona customers | PostgreSQL | +| **PostgreSQL tables not auto vacuumed** | Detects tables that are not being auto-vacuumed and alerts users. Essential for managing bloat, optimizing storage, and maintaining overall database health. | Percona customers | PostgreSQL | +| **PostgreSQL unused replication slot** | Identifies and alerts on unused replication slots. Helps prevent excessive WAL retention and potential disk space issues, especially when replicas are offline. | Percona customers | PostgreSQL | +| **ProxySQL server status** | Tracks ProxySQL server status and alerts when a server's status becomes OFFLINE_SOFT (3) or OFFLINE_HARD (4). Provides details about the server's endpoint, hostgroup, and associated ProxySQL service. Crucial for maintaining high availability and preventing service disruptions. | • Percona customers
• Community | ProxySQL | \ No newline at end of file