製品ドキュメント

Jenkinsモニタリング

最終更新日: 07 年 2023 月 XNUMX 日

LogicMonitorのJenkinsモニタリングパッケージは、ネイティブを活用します ジェンキンス API および MetricsAPIプラグイン ビルドのステータスとサーバーシステムの統計を監視して警告します。

互換性

2021年XNUMX月の時点で、LogicMonitorのJenkinsパッケージは以下と互換性があります。

  • JenkinsネイティブAPIのバージョン2.320
  • Metricsプラグインのバージョン4.0

セットアップ要件

  • コレクターバージョン30.000以降。
  • JenkinsサーバーにMetricsプラグインをインストールしました。 見る Jenkins MetricsAPIプラグイン 詳細については。

監視にリソースを追加する

Jenkinsサーバーをモニタリングに追加します。 監視にリソースを追加する方法の詳細については、を参照してください。 デバイスの追加.

資格情報を取得する

LogicMonitorは、Jenkinsリソースのデータにアクセスするための適切なクレデンシャルを提供する必要があります。 適切な権限を確保するために、LogicMonitorは、次の最小権限が割り当てられている専用APIユーザーアカウントのカスタム読み取り専用ロールを作成することをお勧めします。

セクション パーミッション
全体 読む
ジョブ 読む
詳細 読む
メトリック ビュー、ヘルスチェック

リソースにプロパティを割り当てる

次のカスタムプロパティは、LogicMonitor内のJenkinsリソースに設定する必要があります。 プロパティの設定の詳細については、を参照してください。 リソースとインスタンスのプロパティ.

プロパティ 値
ジェンキンス.ユーザー REST API のユーザー名。
jenkins.key RESTAPIキー。 パスよりも優先されます。 キーまたはパスを構成することを選択できます。 XNUMXつだけ必要です
jenkins.pass RESTAPIパスワード。 パスまたはキーの構成を選択できます。 必要なのはXNUMXつだけです。
jenkins.port （オプション）デフォルトは8080です。

LogicModulesをインポートする

LogicMonitorパブリックリポジトリから、このサポート記事の「パッケージ内のロジックモジュール」セクションにリストされているすべてのJenkinsLogicModuleをインポートします。 これらのLogicModuleがすでに存在する場合は、最新バージョンであることを確認してください。

LogicModulesがインポートされた後（以前のすべてのセットアップ要件が満たされていると仮定して）、データ収集が自動的に開始されます。

トラブルシューティング

このパッケージのモジュールは、データ収集スクリプトに埋め込まれたデバッグモードで設計されています。 問題が発生した場合は、変数debugを「true」に設定してデバッグモードをオンにし、コレクターデバッグ機能でスクリプトをテストするときに出力でより多くの情報を取得します。 Collector Debug Facilityでのスクリプトのテストの詳細については、を参照してください。 スクリプトのトラブルシューティング.

パッケージ内のLogicModules

Jenkins用のLogicMonitorのパッケージは、次のLogicModuleで構成されています。 完全にカバーするには、これらのLogicModuleがすべてLogicMonitorプラットフォームにインポートされていることを確認してください。

表示名 種類 商品説明
addCategory_Jenkins プロパティソース クレデンシャルが存在し、Jenkinsモニタリングで機能していることを確認します。
Jenkinsビルド統計 データソース スコア、期間、ステータスなど、ジョブ固有のビルドメトリックを監視します。
Jenkinsの概要メトリクス データソース サーバーの基本的なヘルスとステータス情報、およびより詳細な概要ビルドメトリックを含む、Jenkinsサーバーのメトリックを提供します。
ジェンキンスヘルス イベントソース ヘルスチェックが「healthy」に対してfalseを返したときにアラートを出します。 スクリプトキャッシュを使用して、イベントの重複を防止しようとします。
Jenkinsトラブルシューター データソース Jenkinsスイートのモジュールに適切な権限が存在することを確認します。 認証に必要な権限がないモジュールごとにインスタンスを作成します。

このパッケージのデータソースによって追跡されるさまざまなメトリックに静的データポイントのしきい値を設定する場合、LogicMonitorはJenkinsのベストプラクティスのKPI推奨事項に従います。 必要に応じて、環境固有のニーズを満たすために、これらの事前定義されたしきい値を調整することをお勧めします。 データポイントしきい値の調整の詳細については、を参照してください。 データポイントの静的しきい値の調整.

記事上で