SonarQube モニタリングの統合

SonarQube 統合は、SonarQube アプリケーションのパフォーマンスを監視し、コードの診断と最適化を支援します。SonarQube 統合では、インフラストラクチャエージェント、PosgreSQL エージェント、NRI-Prometheus、および NRI-JMX を利用し、最も重要な SonarQube メトリクスを含む事前構築されたダッシュボードを提供します。

SonarQube 統合をセットアップすると、SonarQube メトリクスのダッシュボードが提供されます。

インフラストラクチャエージェントをインストールします

インフラストラクチャエージェントは、次の 2 つの方法でインストールできます。

ガイド付きインストールは、システムを検査し、システムに最適なアプリケーション監視エージェントとともにインフラストラクチャエージェントをインストールする CLI ツールです。ガイド付きインストールの仕組みの詳細については、ガイド付きインストールの概要をご覧ください。
インフラストラクチャエージェントを手動でインストールする場合は、 Linux、 Windows、または macOSの手動インストールのチュートリアルに従うことができます。

PostgreSQLをインストールする

エージェントをインストールする前に、ドキュメントで PostgreSQL エージェントの要件を確認してください。
PostgreSQL クイックスタートページ PostgreSQL クイックスタートインストールを開きます。
Install now [今すぐインストール] をクリックして、PostgreSQL クイックスタートインストールを開始します。

SonarQube と New Relic を統合する

以下は、SonarQube を New Relic と統合するために従う必要がある 2 つの方法です。

nri-プロメテウスの構成
nri-jmx 構成

次のパスを使用して、 nri-prometheus-config.yml という名前のファイルを作成します。 /etc/newrelic-infra/integrations.d/nri-prometheus-config.yml
以下のテンプレートを使用して、作成された nri-prometheus-config.ymlという名前のファイルを更新します。

callout.note

sonarqube パスワードには @ 記号を使用しないでください。

これらのフィールドを更新します。
- クラスター名: YOUR_DESIRED_CLUSTER_NAME
  例えば： sonarqube_metrics_exporter
- URL: [“http://user_name:password@YOUR_HOST_IP:9000/api/monitoring/metrics”]
- Insecure_skip_verify: true

nri-prometheus-config.ymlファイルは次のようになります。

---
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

NRI-JMX の構成

SonarQube ダッシュボードは、JMX 統合から収集されたデータを取得し、ダッシュボードに変換します。すべてのデータを New Relic に保存することで、システムの健全性の完全な概要をワンストップで把握できるようになります。

まだインストールしていない場合は、 JMX 監視統合をインストールする必要があります。インストールしたら、いくつかの追加構成を行う必要があります。

例： sudo apt-get install nri-jmx

以下のパスにある sonar.properties ファイルに移動します。

bash

$cd /opt/sonarqube/conf

以下のスニペットを sonar.properties ファイルに追加して、 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

以下のスニペットを sonar.properties ファイルに追加して、 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

コマンドを使用して jconsole を開きます jconsole
リモート接続をクリックし、以下の接続 URL を使用して SonarQube ドメインに接続します。

例：

service:jmx:rmi://[YOUR_HOST]:9010/jndi/rmi://[YOUR_HOST]:9010/jmxrmi service:jmx:rmi://[YOUR_HOST]:9011/jndi/rmi://[YOUR_HOST]:9011/jmxrmi

jconsole ツールの [MBeans] タブに移動すると、SonarQube JVM メトリクスを確認できます。

このステップでは、メトリクスを New Relic に配置すると人間が判読できるように整理します。jconsole がキャプチャする必要があるメトリクスを使用して、 jvm-sonarqube-web-metrics.yml ファイルと jvm-sonarqube-compute-engine-metrics.yml ファイルを更新します。以下の手順には、jvm-metrics.yml ファイルのスニペットが含まれています。

始める前に、スニペットの使用について知っておくべきことがいくつかあります。

以下のコードスニペットでは、必要なメトリクスで更新します。
YOUR_BROKER_NAME 、 YOUR_TOPIC_NAME 、および YOUR_QUEUE_NAME を実際の値で更新します。jconsole ツールを使用してこれらの値を取得できます。
キャプチャされたすべてのメトリクスは、event_type フィールドによって決定されるイベントに保存されます。

jvm-metrics ファイルを更新するには:

以下のファイルパスに移動します。

bash

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

jvm-sonarqube-web-metrics.yml ファイルと jvm-sonarqube-compute-engine-metrics.yml ファイルを作成します。
以下のスニペットを jvm-sonarqube-web-metrics.yml ファイルに追加します。

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

以下のスニペットを jvm-sonarqube-compute-engine-metrics.yml ファイルに追加します。

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

以下の YAML スニペットは、SonarQube メトリクスを CONNECTION_URL 経由で、それらのメトリクスを読み取り可能にする Java ツールである jconsole に接続します。JMX 統合のインストールを進めている場合、このステップは構成ステップに対応します。

更新するには:

以下のファイルパスに移動します。

bash

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

jmx-sonarqube-web-config.yml ファイルと jmx-sonarqube-compute-engine-config.yml ファイルを作成します。
SonarQube Web サーバーの jmx-sonarqube-web-config.yml ファイルに次のスニペットを追加します。

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

SonarQube Compute Engine の jmx-sonarqube-compute-engine-config.yml ファイルに次のスニペットを追加します。

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

SonarQube ログを New Relic に転送する

ログ転送を使用して、SonarQube ログを New Relic に転送できます。

Linux マシンでは、 logging.yml という名前のログファイルが次のパスに存在する必要があります。

bash

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

ログファイルを作成した後、次のスクリプトを logging.yml ファイルに追加します。

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

New Relic インフラストラクチャエージェントを再起動します

インフラストラクチャエージェントを再起動します。

bash

$sudo systemctl restart newrelic-infra.service

数分以内に、アプリケーションはメトリクスを one.newrelic.comに送信します。

データを検索する

SonarQube という名前の事前に構築されたダッシュボードテンプレートを選択して、SonarQube アプリケーションのメトリクスを監視できます。事前に構築されたダッシュボードテンプレートを使用するには、次の手順に従います。

one.newrelic.comから、 + Add data [+ データの追加] ページに移動します。
[ダッシュボード]をクリックします。
検索バーにsonarqubeと入力します。
SonarQube ダッシュボードが表示されます。それをクリックしてインストールします。

SonarQube ダッシュボードはカスタムダッシュボードとみなされ、 Dashboards ダッシュボード UI に表示されます。ダッシュボードの使用と編集に関するドキュメントについては、ダッシュボードのドキュメントを参照してください。

SonarQube Web ステータスを確認するための NRQL クエリは次のとおりです。

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

EVENT_NAME を使用して次の NRQL クエリを実行して、JVM メトリクスを表示します。

SELECT latest(PoolIdleConnections) FROM JVMSampleSonarQubeWebMetrics

次は何ですか？

NRQL クエリの作成とダッシュボードの生成の詳細については、次のドキュメントをご覧ください。

基本的なクエリと高度なクエリを作成するためのクエリビルダーの概要。
ダッシュボードをカスタマイズしてさまざまなアクションを実行するためのダッシュボードの概要。
ダッシュボードを管理して、ダッシュボードの表示モードを調整したり、ダッシュボードにコンテンツを追加したりします。

この機械翻訳は参考用に提供されます。

インフラストラクチャエージェントをインストールします

PostgreSQLをインストールする

SonarQube と New Relic を統合する

NRI-Prometheus の構成

callout.note

NRI-JMX の構成

SonarQube JMX 構成

SonarQube JMX の検証

jvm メトリックファイルを構成する

nri-jmx ファイルを構成する

SonarQube ログを New Relic に転送する

New Relic インフラストラクチャエージェントを再起動します

データを検索する

次は何ですか？

この機械翻訳は参考用に提供されます。

SonarQube モニタリングの統合

インフラストラクチャエージェントをインストールします

PostgreSQLをインストールする

SonarQube と New Relic を統合する

NRI-JMX の構成

SonarQube JMX 構成

SonarQube JMX の検証

jvm メトリック ファイルを構成する

nri-jmx ファイルを構成する

SonarQube ログを New Relic に転送する

New Relic インフラストラクチャ エージェントを再起動します

データを検索する

次は何ですか？

jvm メトリックファイルを構成する

New Relic インフラストラクチャエージェントを再起動します