Jenkins

Jenkins モニターには、この Splunk Observability Cloud インテグレーションを使用してください。メリット、インストール、設定、メトリクスを参照してください

Splunk Distribution of OpenTelemetry Collectorは、Smart Agentレシーバー と jenkins モニタータイプを使用して、以下のエンドポイントを叩くことでJenkinsインスタンスからメトリクスを収集します：

  • ../api/json エンドポイントを使用したジョブ・メトリクス。

  • CodahaleまたはDropwizard JVMメトリクスを metrics/<MetricsKey>/.. エンドポイントで使用します。

このインテグレーションはKubernetesとLinuxでのみ利用可能です。

注: Jenkins インテグレーションには、Jenkins バージョン 1.580.3 以上と、Jenkins Metrics プラグインが必要です。

メリット

インテグレーションを設定すると、これらの機能にアクセスできるようになります：

インストール

このインテグレーションを導入するには、以下の手順に従ってください：

  1. Splunk Distribution of OpenTelemetry Collector をホストまたはコンテナプラットフォームにデプロイします：

  2. 設定のセクションで説明するように、モニターを設定します。

  3. Splunk Distribution of OpenTelemetry Collector を再起動します。

設定

Smart Agent モニターとCollector のインテグレーションを使用するには、以下の手順に従います：

  1. Smart Agent レシーバーを設定ファイルに含めます。

  2. レシーバーセクションおよびパイプラインセクションの両方で、Collector 構成にモニタータイプを追加します。

例

このインテグレーションを有効にするには、Collector構成に以下を追加します：

YAML 
receivers:
  smartagent/jenkins:
    type: collectd/jenkins
    ...  # Additional config

次に、設定ファイルの service.pipelines.metrics.receivers セクションにモニターを追加します：

YAML 
service:
  pipelines:
    metrics:
      receivers: [smartagent/jenkins]

サンプルYAMLコンフィギュレーション

以下のサンプルYAMLコンフィギュレーションを参照してください：

YAML 
receivers:
  smartagent/jenkins:
    type: collectd/jenkins
    host: 127.0.0.1
    port: 8080
    metricsKey: reallylongmetricskey

特定の強化されたメトリクスを含むサンプルYAML設定：

YAML 
receivers:
  smartagent/jenkins:
    type: collectd/jenkins
    host: 127.0.0.1
    port: 8080
    metricsKey: reallylongmetricskey
    includeMetrics:
    - "vm.daemon.count"
    - "vm.terminated.count"

すべての拡張メトリクスを含むサンプルYAML設定：

YAML 
receivers:
  smartagent/jenkins:
    type: collectd/jenkins
    host: 127.0.0.1
    port: 8080
    metricsKey: reallylongmetricskey
    enhancedMetrics: true

コンフィギュレーション設定

次の表に、このモニターの設定オプションを示します：

オプション

必須

タイプ

説明

pythonBinary

いいえ

string

 Python コードを実行するための Python バイナリへのパス。設定されていない場合は、

組み込みランタイムが使用されます。また、バイナリへの引数を含めることもできます。

host

〇

string

port

〇

integer

path

いいえ

string

metricsKey

〇

string

 メトリクスの収集に必要なキー。アクセスキーは、

Manage Jenkins > Configure System > Metrics > ADD. にあり、空の場合は、Generate を選択します。

enhancedMetrics

いいえ

bool

拡張メトリクスを有効にするかどうか（デフォルト：false）

includeMetrics

いいえ

list of strings

 ``enhancedMetrics`` が ``false`` に設定されている場合、

enhancedMetrics が false に設定されている

username

いいえ

string

Jenkinsへのセキュリティアクセス権を持つユーザー

apiToken

いいえ

string

ユーザーのAPIトークン

useHTTPS

いいえ

bool

HTTPS をアクティブ化するかどうか。（デフォルト：false）

sslKeyFile

いいえ

string

keyfile へのパス

sslCertificate

いいえ

string

証明書へのパス

sslCACerts

いいえ

string

caファイルへのパス

skipVerify

いいえ

bool

SSL証明書の検証をスキップする（デフォルト：false）

メトリクス

このインテグレーションでは、以下のメトリクスを使用できます：

https://raw.githubusercontent.com/signalfx/splunk-otel-collector/main/internal/signalfx-agent/pkg/monitors/collectd/jenkins/metadata.yaml

備考

  • Splunk Observability Cloud で利用可能なメトリクスタイプの詳細は、「メトリクスタイプ」を参照してください。

  • ホストベースのサブスクリプションプランでは、デフォルトのメトリクスは、ホスト、コンテナ、バンドルメトリクスなど、Splunk Observability Cloud のホストベースのサブスクリプションに含まれるメトリクスです。カスタムメトリクスはデフォルトでは提供されていないため、料金が発生する場合があります。詳細については、「メトリクスカテゴリ」を参照してください。

  • MTSベースのサブスクリプションプランでは、すべてのメトリクスがカスタムです。

  • メトリクスを追加するには、「その他のメトリクスの追加」で extraMetrics の設定方法を参照してください。

トラブルシューティング

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.

Available to Splunk Observability Cloud customers

Available to prospective customers and free trial users

  • Ask a question and get answers through community support at Splunk Answers.

  • Join the Splunk community #observability Slack channel to communicate with customers, partners, and Splunk employees worldwide.