Monitoring alerts
Setting up SonarQube Server monitoring alerts.
Monitoring alerts help system administrators detect performance problems in a SonarQube Server instance. They surface signs of degraded behavior early, so administrators can investigate before users start reporting slow or failed analysis results. Their purpose is to show that the instance is experiencing a performance problem and that administrator attention is needed.
Requirements
You need Administer System permission to configure and receive monitoring alerts. See Managing permissions for more information.
You will have to configure email notifications in SonarQube Server to receive the alerts through email. See Setting up email notifications for more information.
Displaying alerts
Monitoring alerts are displayed to system administrators as follows:
As banners at the top of SonarQube Server. You can dismiss these banners.
As banners within the Administration > Systems page. You cannot dismiss these banners. They They disappear automatically when the issues are resolved or they no longer exists.
Through email notifications.
Managing alerts
Monitoring alerts for background task activities help administrators identify situations where analysis processing is delayed, the background task queue is growing, or background tasks are failing.
To configure monitoring alerts for background tasks go to Administration > Configuration > General settings > Monitoring.
Activation
Switch on or off Enable monitoring alerts toggle. The monitoring alerts are enabled by default.
When enabled, SonarQube evaluates each metric and notifies administrators when the alert is triggered (banner and email notifications) or cleared (email only).
When you disable monitoring alerts, all currently active alerts are deactivated silently and no further monitoring evaluations take place.
Background task queue
An alert is triggered when the background task queue size threshold is exceeded for a specific time duration defined by the duration threshold.
Background task queue size threshold: Set the number of tasks in the queue as the queue size threshold. The default value is 50.
Duration threshold (minutes): Set how long the queue size threshold must be continuously exceeded before an alert is sent or resolved. The default value is 60 minutes.
Background task waiting time
An alert is triggered when the background task waiting time threshold is exceeded for a duration defined by the duration threshold.
Background task waiting time threshold (minutes): Set the threshold for how long the oldest task in the queue can wait. The default value is 30 minutes.
Duration threshold (minutes): Set how long the waiting time threshold must be continuously exceeded before an alert is sent or resolved. The default value is 60 minutes.
Background tasks failures
An alert is triggered when the failure rate threshold is exceeded after a period of time defined by the observation window.
Failure rate threshold (percentage): Set a percentage of failed background tasks as the failure rate threshold, out of all completed tasks within the observation period. The default value is 50 percent.
Observation window (minutes): Set the duration of the observation time window used to compute the failure rate threshold. Tasks completed before this time window are excluded from the calculation. The default value is 60 minutes.
The monitoring system checks the above metrics every minute.
You might need to adjust the default values to fit your specific needs.
Troubleshooting
For troubleshooting background task related issues, see the Performance issues page.
Related pages
Last updated
Was this helpful?