SonarQube monitoring integration

Our SonarQube integration monitors the performance of your SonarQube application, helping you diagnose and optimize the code. Our SonarQube integration makes use of our infrastructure agent, PosgreSQL agent, NRI-Prometheus, and NRI-JMX and gives you a pre-built dashboard with your most important SonarQube metrics.

After setting up our SonarQube integration, we give you a dashboard for your SonarQube metrics.

Install the infrastructure agent

You can install the infrastructure agent two different ways:

Our guided install is a CLI tool that inspects your system and installs the infrastructure agent alongside the application monitoring agent that best works for your system. To learn more about how our guided install works, check out our Guided install overview.
If you'd rather install our infrastructure agent manually, you can follow a tutorial for manual installation for Linux, Windows, or macOS.

Install the PostgreSQL

Check out our PostgreSQL agent requirements in our documentation before installing the agent.
Open PostgreSQL Quickstart page PostgreSQL quickstart installation.
Click Install now to start the PostgreSQL quickstart installation.

Integrate SonarQube with New Relic

Below are the two ways which has to be followed to integrate SonarQube with New Relic.

nri-prometheus configuration
nri-jmx configuration

Create a file named nri-prometheus-config.yml using this path: /etc/newrelic-infra/integrations.d/nri-prometheus-config.yml
Use the below template to update the created file named nri-prometheus-config.yml.

callout.note

Avoid using the @ symbol in your sonarqube password.

Update these fields:
- cluster_name: YOUR_DESIRED_CLUSTER_NAME
  For Example: sonarqube_metrics_exporter
- urls: [“http://user_name:password@YOUR_HOST_IP:9000/api/monitoring/metrics”]
- Insecure_skip_verify: true

Your nri-prometheus-config.yml file should look like this:

---
integrations:
  - name: nri-prometheus
    config:
      # When standalone is set to false nri-prometheus requires an infrastructure agent to work and send data. Defaults to true 
      standalone: false

      # When running with infrastructure agent emitters will have to include infra-sdk 
      emitters: infra-sdk

      # The name of your cluster. It's important to match other New Relic products to relate the data.
      cluster_name: "YOUR_DESIRED_CLUSTER_NAME"

      targets:
        - description: Sonarqube metrics list
          urls: ["http://user_name:password@YOUR_HOST_IP:9000/api/monitoring/metrics"]

      #     tls_config:
      #     ca_file_path: "/etc/etcd/etcd-client-ca.crt"
      #     cert_file_path: "/etc/etcd/etcd-client.crt"
      #      key_file_path: "/etc/etcd/etcd-client.key"

      # Whether the integration should run in verbose mode or not. Defaults to false
      verbose: false

      # Whether the integration should run in audit mode or not. Defaults to false.
      # Audit mode logs the uncompressed data sent to New Relic. Use this to log all data sent.
      # It does not include verbose mode. This can lead to a high log volume, use with care
      audit: false

      # The HTTP client timeout when fetching data from endpoints. Defaults to 30s.
      # scrape_timeout: "30s"

      # Length in time to distribute the scraping from the endpoints
      scrape_duration: "5s"

      # Number of worker threads used for scraping targets.
      # For large clusters with many (&gt;400) endpoints, slowly increase until scrape
      # time falls between the desired `scrape_duration`.
      # Increasing this value too much will result in huge memory consumption if too
      # many metrics are being scraped.
      # Default: 4
      # worker_threads: 4

      # Whether the integration should skip TLS verification or not. Defaults to false
      insecure_skip_verify: true
    timeout: 10s

Configure NRI-JMX

Our SonarQube dashboard takes data scraped from your JMX integration and translates it into dashboards. By storing all your data in New Relic, you've a one stop shop to get a full overview of your system's health.

If you haven't already, you'll need to install our JMX monitoring integration. You'll need to make some additional configurations once it's installed.

Example: sudo apt-get install nri-jmx

Go to sonar.properties file located in the below path:

bash

$cd /opt/sonarqube/conf

Add the below snippet in the sonar.properties file to configure the jmx sonarqube web.

# SonarQube Web Server JMX configuration.
  sonar.web.javaOpts=-Dcom.sun.management.jmxremote \
                   -Dcom.sun.management.jmxremote.port=9010 \
                   -Dcom.sun.management.jmxremote.authenticate=false \
                   -Dcom.sun.management.jmxremote.ssl=false

Add the below snippet in the sonar.properties file to configure the jmx sonarqube compute engine.

# SonarQube Compute Engine JMX configuration.
  sonar.ce.javaOpts=-Dcom.sun.management.jmxremote \
                  -Dcom.sun.management.jmxremote.port=9011 \
                  -Dcom.sun.management.jmxremote.authenticate=false \
                  -Dcom.sun.management.jmxremote.ssl=false

This step organizes your metrics to be human readable once they're in New Relic. Update the jvm-sonarqube-web-metrics.yml and jvm-sonarqube-compute-engine-metrics.yml files with any metrics that jconsole should capture. In the procedure below is the snippet of the jvm-metrics.yml file.

Before you start, here are some things to know about using the snippet:

For the code snippet below, you'll update it with your desired metrics.
Update YOUR_BROKER_NAME, YOUR_TOPIC_NAME, and YOUR_QUEUE_NAME with your actual values. You can use the jconsole tool to get these values.
All the metrics captured are stored on the events determined by the event_type field.

To update the jvm-metrics files:

Go to the below file path.

bash

$cd /etc/newrelic-infra/integrations.d/

Create the jvm-sonarqube-web-metrics.yml and jvm-sonarqube-compute-engine-metrics.yml files.
Add the below snippet to our jvm-sonarqube-web-metrics.yml file:

collect:
  - domain: SonarQube
    event_type: JVMSampleSonarQubeWebMetrics
    beans:
      - query: name=AsyncExecution
        attributes:
          - QueueSize
          - WorkerCount
          - LargestWorkerCount
      - query: name=Database
        attributes:
          - MigrationStatus
          - PoolActiveConnections
          - PoolMaxActiveConnections
          - PoolIdleConnections
          - PoolMaxIdleConnections
          - PoolMinIdleConnections
          - PoolInitialSize
          - PoolMaxWaitMillis
          - PoolRemoveAbandoned
          - PoolRemoveAbandonedTimeoutSeconds
      - query: name=SonarQube
        attributes:
          - Version
          - ServerId
          - LogLevel

Add the below snippet to our jvm-sonarqube-compute-engine-metrics.yml file:

collect:
  - domain: SonarQube
    event_type: JVMSampleSonarQubeComputeEngineMetrics
    beans:
      - query: name=ComputeEngineDatabaseConnection
        attributes:
          - PoolInitialSize
          - PoolActiveConnections
          - PoolMaxActiveConnections
          - PoolIdleConnections
          - PoolMaxIdleConnections
          - PoolMinIdleConnections
          - PoolMaxWaitMillis
          - PoolRemoveAbandoned
          - PoolRemoveAbandonedTimeoutSeconds
      - query: name=ComputeEngineTasks
        attributes:
          - PendingCount
          - LongestTimePending
          - InProgressCount
          - ErrorCount
          - SuccessCount
          - ProcessingTime
          - WorkerMaxCount
          - WorkerCount
          - WorkerUuids
          - EnabledWorkerUuids

The below YAML snippet connects your SonarQube metrics via CONNECTION_URL to jconsole, a Java tool that makes those metrics readable. If you're following along with the JMX integration install, this step corresponds with the configuration step.

To update:

Go to the file path below:

bash

$cd /etc/newrelic-infra/integrations.d/

Create the jmx-sonarqube-web-config.yml and jmx-sonarqube-compute-engine-config.yml files.
Add the following snippet to your jmx-sonarqube-web-config.yml file for the SonarQube Web server.

integrations:
  - name: nri-jmx
    env:
      COLLECTION_FILES: /etc/newrelic-infra/integrations.d/jmx-sonarqube-web-config.yml
      JMX_HOST: <YOUR_HOST>
      JMX_PASS: admin
      JMX_PORT: 9010
      JMX_USER: admin
      CONNECTION_URL: service:jmx:rmi://<YOUR_IP>:9010/jndi/rmi://<YOUR_IP>:9010/jmxrmi
      REMOTE_MONITORING: "true"
    interval: 15s
    labels:
      env: staging

Add the following snippet to your jmx-sonarqube-compute-engine-config.yml file for the SonarQube Compute Engine.

integrations:
  - name: nri-jmx
    env:
      COLLECTION_FILES: /etc/newrelic-infra/integrations.d/jmx-sonarqube-compute-engine-config.yml
      JMX_HOST: <YOUR_HOST>
      JMX_PASS: admin
      JMX_PORT: 9011
      JMX_USER: admin
      CONNECTION_URL: service:jmx:rmi://<YOUR_IP>:9011/jndi/rmi://<YOUR_IP>:9011/jmxrmi
      REMOTE_MONITORING: "true"
    interval: 15s
    labels:
      env: staging

Forward SonarQube logs to New Relic

You can use our log forwarding to forward SonarQube logs to New Relic.

On Linux machines, your log file named logging.yml should be present in this path:

bash

$cd /etc/newrelic-infra/logging.d/

After creating the log file, add the following script to the logging.yml file:

logs:
  - name: sonar_logs
    file: /opt/sonarqube/logs/sonar.log
    attributes: 
      logtype: sonar_logs
  - name: ce_logs
    file: /opt/sonarqube/logs/ce.log
    attributes:
      logtype: sonar_ce_logs
  - name: es_logs
    file: /opt/sonarqube/logs/es.log
    attributes: 
      logtype: sonar_es_logs
  - name: web_logs
    file: /opt/sonarqube/logs/web.log
    attributes:
      logtype: sonar_web_logs

Restart the New Relic infrastructure agent

Restart your infrastructure agent.

bash

$sudo systemctl restart newrelic-infra.service

In a couple of minutes, your application will send metrics to one.newrelic.com.

Find your data

You can choose our pre-built dashboard template named SonarQube to monitor your SonarQube application metrics. Follow these steps to use our pre-built dashboard template:

From one.newrelic.com, go to the + Add data page.
Click on Dashboards.
In the search bar, type sonarqube.
The SonarQube dashboard should appear. Click on it to install it.

Your SonarQube dashboard is considered a custom dashboard and can be found in the Dashboards UI. For docs on using and editing dashboards, see our dashboard docs.

Here is a NRQL query to check your SonarQube web status:

SELECT latest(sonarqube_web_uptime_minutes) 
AS 'SonarQube Web Uptime (minutes)' 
FROM Metric

Run the following NRQL query using EVENT_NAME to view the JVM metrics:

SELECT latest(PoolIdleConnections) FROM JVMSampleSonarQubeWebMetrics

What's next?

To learn more about building NRQL queries and generating dashboards, check out these docs:

Introduction to the query builder to create basic and advanced queries.
Introduction to dashboards to customize your dashboard and carry out different actions.
Manage your dashboard to adjust your dashboards display mode, or to add more content to your dashboard.

Install the infrastructure agent

Install the PostgreSQL

Integrate SonarQube with New Relic

Configure NRI-Prometheus

callout.note

Configure NRI-JMX

SonarQube JMX configuration

SonarQube JMX verification

Configure jvm metric files

Configure nri-jmx files

Forward SonarQube logs to New Relic

Restart the New Relic infrastructure agent

Find your data

What's next?

SonarQube monitoring integration

Install the infrastructure agent .css-21sua1{background:none;border:none;width:0;padding:0;}

Install the PostgreSQL

Integrate SonarQube with New Relic

Configure NRI-JMX

SonarQube JMX configuration

SonarQube JMX verification

Configure jvm metric files

Configure nri-jmx files

Forward SonarQube logs to New Relic

Restart the New Relic infrastructure agent

Find your data

What's next?

Install the infrastructure agent