Start Free
Latest | Server upgrade and maintenance | Data Center Edition | Monitoring

Monitoring your cluster

On this page

CPU and RAM usage on each node have to be monitored separately with an APM.

In addition, we provide a Web API api/system/health you can use to validate that all of the nodes in your cluster are operational.

  • GREEN: SonarQube Server is fully operational
  • YELLOW: SonarQube Server is usable, but it needs attention in order to be fully operational
  • RED: SonarQube Server is not operational

To call it from a monitoring system without having to give admin credentials, it is possible to setup a system passcode. You can configure this through the sonar.web.systemPasscode property in <sonarqubeHome>/conf/sonar.properties if you're using a traditional environment or through the corresponding environment variable if you're using a Docker environment.

Checking the cluster status in the UI

On the System Info page at Administration > System, you can check whether your cluster is running safely (green) or has some nodes with problems (orange or red).

Monitoring pending tasks

On the global Background Tasks page at Administration > Projects > Background Tasks, you can see the number of pending tasks as well as the maximum pending time for the tasks in the queue. This shows the pending time of the oldest background task waiting to be processed. You can use this to evaluate if it might be worth configuring additional Compute Engine workers (Enterprise Edition) or additional nodes (Data Center Edition) to improve SonarQube Server performance.


Was this page helpful?

© 2008-2025 SonarSource SA. All rights reserved.

Creative Commons License