Jenkins 🔗

The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the jenkins monitor type to collect metrics from Jenkins instances by hitting the following endpoints:

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

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

注釈

The Jenkins integration requires Jenkins version 1.580.3 or higher and the Jenkins Metrics plugin.

メリット 🔗

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

メトリクスを表示します。独自のカスタム・ダッシュボードを作成することができ、ほとんどのモニターは組み込みのダッシュボードも提供しています。ダッシュボードについては、Splunk Observability Cloudでダッシュボードを表示するを参照してください。
Infrastructure Monitoring に表示される環境内の物理サーバー、仮想マシン、AWS インスタンス、およびその他のリソースのデータ駆動型の視覚化を表示します。ナビゲーターについては、Splunk Infrastructure Monitoring でナビゲーターを使用するを参照してください。
Metric Finder にアクセスして、モニターから送信されたメトリクスを検索します。詳細については、メトリクス・ファインダーとメタデータ・カタログを検索するを参照してください。

インストール 🔗

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

Splunk Distribution of OpenTelemetry Collector をホストまたはコンテナプラットフォームにデプロイします：
- Kubernetesにインストールする
- Linuxにインストールする
設定のセクションで説明するように、モニターを設定します。
Splunk Distribution of OpenTelemetry Collector を再起動します。

設定 🔗

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

Smart Agent レシーバーを設定ファイルに含めます。
レシーバーセクションおよびパイプラインセクションの両方で、Collector 構成にモニタータイプを追加します。

Collector でSmart Agent モニターを使用するの方法を参照してください。
Smart Agent レシーバーの設定方法を参照してください。
一般的な設定オプションのリストについては、モニターの共通設定を参照してください。
Collectorの詳細は、はじめに：Collectorを理解して使用するを参照してください。

例 🔗

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

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

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

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

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

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

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

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

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

すべての拡張メトリクスを含むサンプル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` に設定されている場合、個々の強化されたメトリクスを有効にするために使用されます。
`username`	いいえ	`string`	Jenkinsへのセキュリティアクセス権を持つユーザー
`apiToken`	いいえ	`string`	ユーザーのAPIトークン
`useHTTPS`	いいえ	`bool`	HTTPS を有効にするかどうか。(デフォルト： `false` )
`sslKeyFile`	いいえ	`string`	keyfile へのパス
`sslCertificate`	いいえ	`string`	証明書へのパス
`sslCACerts`	いいえ	`string`	caファイルへのパス
`skipVerify`	いいえ	`bool`	SSL証明書の検証をスキップする (デフォルト： `false` )

メトリクス 🔗

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

備考 🔗

To learn more about the available in Splunk Observability Cloud see メトリクスタイプ
In host-based subscription plans, default metrics are those metrics included in host-based subscriptions in Splunk Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See メトリクスカテゴリ for more information.
MTSベースのサブスクリプションプランでは、すべてのメトリクスがカスタムです。
メトリクスを追加するには、その他のメトリクスの追加で extraMetrics の設定方法を参照してください。

トラブルシューティング 🔗

Splunk Observability Cloudをご利用のお客様で、Splunk Observability Cloudでデータを確認できない場合は、以下の方法でサポートを受けることができます。

Splunk Observability Cloudをご利用のお客様

Submit a case in the Splunk Support Portal .
Contact Splunk Support .

見込み客および無料トライアルユーザー様

Splunk Answers のコミュニティサポートで質問し、回答を得る
Splunk #observability ユーザーグループの Slack チャンネルに参加して、世界中の顧客、パートナー、Splunk 社員とのコミュニケーションを図る。参加するには、Get Started with Splunk Community マニュアルのチャットグループを参照してください。

This page was last updated on 2024年10月07日.

Related Topics