diff options
| author | michaelbirnstiehl <michael.birnstiehl@sonarsource.com> | 2022-01-03 14:39:06 -0600 |
|---|---|---|
| committer | sonartech <sonartech@sonarsource.com> | 2022-01-05 20:02:50 +0000 |
| commit | 1270fd65a95fc50b8f59bbc15bb94e183fb09b12 (patch) | |
| tree | fa2f9a66f8f046102039a7f2243ccfb2e8c64e4d /server | |
| parent | 51dcdb9aab1d81e42c1d2d0bfbe6e4f2f2b7c8ca (diff) | |
| download | sonarqube-1270fd65a95fc50b8f59bbc15bb94e183fb09b12.tar.gz sonarqube-1270fd65a95fc50b8f59bbc15bb94e183fb09b12.zip | |
DOCS add Kubernetes note to monitoring page
Diffstat (limited to 'server')
| -rw-r--r-- | server/sonar-docs/src/pages/instance-administration/monitoring.md | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/server/sonar-docs/src/pages/instance-administration/monitoring.md b/server/sonar-docs/src/pages/instance-administration/monitoring.md index 1bcd48bd051..26af426c00e 100644 --- a/server/sonar-docs/src/pages/instance-administration/monitoring.md +++ b/server/sonar-docs/src/pages/instance-administration/monitoring.md @@ -134,4 +134,22 @@ admin adminpassword Note: on `jmxremote.password`, you should apply `chmod 600` or `400` for security reasons. ## Kubernetes Monitoring -You can monitor your SonarQube instance using SonarQube's native integration with Prometheus. For more information see the **Monitoring** section of the [Deploy SonarQube on Kubernetes](/setup/sonarqube-on-kubernetes/) page if you're using Community, Developer, or Enterprise Edition. See the [Deploy a SonarQube Cluster on Kubernetes](/setup/sonarqube-cluster-on-kubernetes/) if you're using Data Center Edition. +You can monitor your SonarQube instance using SonarQube's native integration with Prometheus. Through this integration, you can ensure your instance is running properly and know if you need to take action to prevent future issues. + +Prometheus monitors your SonarQube instance by collecting metrics from the `/api/monitoring/metrics` endpoint. Results are returned in OpenMetrics text format. See Prometheus' documentation on [Exposition Formats](https://prometheus.io/docs/instrumenting/exposition_formats/) for more information on the OpenMetrics text format. + +Monitoring through this endpoint requires authentication. You can access the endpoint following ways: + +- **`Authorization:Bearer xxxx` header:** You can use a bearer token during database upgrade and when SonarQube is fully operational. Define the bearer token in the `sonar.properties` file using the `sonar.web.systemPasscode property`. +- **`X-Sonar-Passcode: xxxxx` header:** You can use `X-Sonar-passcode` during database upgrade and when SonarQube is fully operational. Define `X-Sonar-passcode` in the `sonar.properties` file using the `sonar.web.systemPasscode property`. +- **username:password and JWT token:** When SonarQube is fully operational, system admins logged in with local or delegated authentication can access the endpoint. + +<!-- static --> + +For more information on deploying SonarQube on Kubernetes: + +- For Community, Developer, and Enterprise Edition, see [Deploy SonarQube on Kubernetes](/setup/sonarqube-on-kubernetes/). +- For Data Center Edition, see [Deploy a SonarQube Cluster on Kubernetes](/setup/sonarqube-cluster-on-kubernetes/). + +<!-- /static --> + |