OpenMetricsデータソースウィザード
最終更新日: 09 年 2024 月 XNUMX 日LogicMonitorは、これらのメトリックが公開されているエンドポイントをポーリングするためのOpenMetrics(Prometheus Exposition Format)データソースの作成と設定を簡素化しました。 スクリプト化されたデータソーステンプレートは引き続き使用できますが、コレクターはOpenMetricsデータ形式をサポートするようになったため、データを解析するためにスクリプトを使用する必要がなくなりました。 新しいデータソースを作成するための推奨される方法は、ウィザードを使用することです。
ウィザードは、LogicMonitorポータルのExchangeページにあります。 Exchangeページに移動し、メニュータブからOpenMetricsを選択します。 [OpenMetrics]タブには、アカウントで作成されたすべてのデータソースが表示されます。
前提条件
- EA Collector 30.100以降がインストールされ、OpenMetricsエンドポイントからリソースを監視しています。
- OpenMetricsホストが監視に追加されました。 監視にリソースを追加する方法の詳細については、を参照してください。 デバイスの追加.
互換性
OpenMetrics形式は、それが基づいているPrometheus Exposition形式と100%互換性があり、Cloud Native ComputingFoundationによって公式標準として採用されています。
セットアップ要件
セットアップウィザードを使用すると、OpenMetricsエンドポイントからメトリックをロードし、収集するデータポイントに処理するメトリックを選択できます。 このとき、ホストリソースを監視し、エンドポイントURLの新しいプロパティをリソースに追加する必要があります。
ホストリソースにプロパティを設定する
LogicMonitor内のOpenMetricsホストで次のカスタムプロパティを設定します。 プロパティの設定の詳細については、を参照してください。 リソースとインスタンスのプロパティ.
プロパティ | 説明 |
openmetrics.url | (必須)エンドポイントが基本認証またはHTTPSを使用しない場合、これは開始に必要な唯一のプロパティです。 例: http://hostname:port/metrics |
openmetrics.host | (openmetrics.urlを使用しない場合は必須)openmetrics.urlのパラメーター化された値を使用するには、以下にリストされているデフォルトをオーバーライドする場合、ホスト、ポート、およびメトリックを指定する必要があります。 |
openmetrics.headers | (オプション)ヘッダー値を次の形式で指定します。 HeaderName:HeaderValue\n . |
openmetrics.pass | (オプション)認証用のパスワード。 |
openmetrics.path | (オプション)デフォルトのパス「/ metrics」をオーバーライドするように入力します。 |
openmetrics.port | (オプション)デフォルトのポート「9273」を上書きするように設定します。 |
オープンメトリクス.リダイレクト | (オプション)デフォルトではFalseに設定されています。 |
オープンメトリクス.ssl | (オプション)デフォルトではFalseに設定されています。これはHTTPを意味します。 |
openmetrics.timeout | (オプション)デフォルトでは2000に設定されています。 |
openmetrics.user | (オプション)認証用のユーザー名。 |
データソースを追加
データソースを作成または編集したことがある場合、これらのフィールドは、識別情報を含む他のデータソースの[一般情報]セクションと同じです。
名前
DataSourceの一意の名前。 このフィールドは必須であり、OpenMetricsデータソースリストおよび 設定| LogicModules | データソース 表示および編集するためのリスト。
ベストプラクティスとして、この名前はわかりやすいものにする必要があります。 たとえば、最初にプラットフォームまたはアプリケーション名を指定してから、プラットフォームの特定のコンポーネントを指定できます。
として表示
[デバイス]ページに表示されるデータソースの名前。 この名前は一意である必要はありません。たとえば、「CPU」として表示され、さまざまな種類のデバイスに適用される複数のデータソースが存在する場合があります。
ベストプラクティスとして、表示名は完全なデータソース名よりも短くする必要があります。 たとえば、「Windowsサービス」の代わりに「サービス」を使用したり、「CitrixNetscalerVIP」の代わりに「VIP」を使用したりします。
ご注意: データソースの名前と表示名には、LogicMonitorのデータポイント式構文用に予約されているため、演算子と比較関数を含めることはできません。 複雑なデータポイントを参照してください。
説明
このデータソースに関連付けられる説明情報。 データソース名がデータソースが収集しているものを説明するのに十分でない場合、説明フィールドは、名前と説明を見た人がデータソースの機能を理解できるように十分な情報を提供する必要があります。
テクニカルノート
このフィールドには、データソースに関連するテクニカルノートを含めることができます。
グループ
データソースが追加されるデータソースグループ。 このフィールドが空の場合、データソースはデータソースグループに追加されません。 既存のデータソースグループと一致しないテキストを入力すると、テキストが作成されます。
たとえば、すべてのDellハードウェア監視データソースにはグループDellが割り当てられます。 これにより、これらのデータソースが展開可能な単一のデータソースグループエントリにまとめられます。
に適用されます
AppliestToスクリプトを使用して、このデータソースに関連付けるリソースを定義します。 見る AppliesToスクリプティングの概要.
データソースの一般情報を定義したら、次のステップはメトリックのロードです。 このウィザードで必要な設定の量を減らすために、一部のフィールドはデフォルトで共通の値に設定されており、データソースの編集時に更新できます。
負荷メトリック
リストからリソースを選択します。 リソースには、データソースが収集するメトリックに対して定義されたエンドポイントが必要です。 このリストに表示するには、リソースに次のプロパティのいずれかが定義されている必要があります(を参照してください)。 セットアップ要件):
プロパティ | 説明 |
openmetrics.url | 指定されたリソースのコレクターがメトリックを公開してアクセスできる完全なURL。 |
openmetrics.host | OpenMetricsエンドポイントが公開されているリソースのホスト名またはIPアドレス。 注: このプロパティーは、プロパティーが指定されていない場合、ポート (9273) およびパス (/metrics) のデフォルト値を使用します。 |
選択したリソースのメトリックがテーブルに読み込まれたら、OpenMetricsデータソースのデータポイントを定義するメトリックのセットを選択します。
- メトリックラベルと正確な値または正規表現値を選択して、ActiveDiscoveryのインスタンスフィルターを提供できます。 たとえば、メトリックは複数の環境で使用でき、ラベル(test、dev、prodなど)でタグ付けされている場合があります。 このフィルターは、「本番」環境など、いずれかの環境からインスタンスを検出するためにのみ使用できます。
- *を使用して一致するキーワードを区切ることにより、分割ワイルドカード検索を使用してメトリックを選択できます。 たとえば、query *ママ*分位数を検索すると、それらのキーワード間のテキストに関係なく、「クエリ」、「スライス」、および「分位数」を含むメトリックが返されます。
- この メトリック名フィルター エンドポイントから返されるメトリックの数を制限できます。 入力ボックスに入力されたテストで始まるメトリックのみが返されます。 このフィルターは、多数のメトリックを公開するエンドポイントに役立つ場合があり、それらのメトリックのロードに時間がかかる可能性があります。
ご注意: マルチインスタンスデータソース(複数のCPU、ディスク、インターフェイス、プロセスなどを含むリソースなど)を定義する場合、それらのインスタンスを定義するラベルは、選択したすべてのメトリックに存在する必要があります。 インスタンス定義の一貫性を確保するために、[データポイントの追加]ステップでエラーチェックが提供されます。
データソースのメトリックを選択したら、をクリックします 次へ 「インスタンスの追加」へ。
インスタンスの追加
前の手順で選択したメトリックにラベルが定義されていない場合は、この手順をスキップして「データポイントの追加」に進むことができます。
インスタンスラベル
メトリックのさまざまなインスタンス名を定義する、選択したすべてのメトリックに存在するラベルを選択します。 これは、CPU、ディスク、インターフェイス、プロセス、またはジョブのラベルである可能性があります。 このラベルの各値は、メトリックを収集するための新しい個別のインスタンスを表します。
テストインスタンスの設定
インスタンスラベルを定義している場合は、 テストインスタンス設定 ボタンをクリックして、選択したラベルによって決定されたインスタンス値を表示します。 これは、データソースを表示するときの[自動検出のテスト]オプションに似ています。
自動検出を有効にする
(推奨)OpenMetricsデータの動的な性質により、新しいインスタンスはいつでも追加できます。 この機能を有効にすると、新しいインスタンスが検出され、LogicMonitoryに自動的に追加されます。
インスタンスグループラベル
残りのラベルをインスタンスグループとして選択します。 Test、QA、およびProdプロセスからメトリックを収集している場合は、インスタンスを「環境」ラベルでグループ化して、リソースツリーで表示したときに、環境ごとに整理されるようにすることができます。
DataPointsを追加します
ご注意: XNUMXつのデータソースに多数のDataPointを追加すると、データがリソースツリーに正しく表示されず、コレクターのCPU使用率が高くなるなどのパフォーマンスの問題が発生する可能性があります。 LogicMonitorは、さまざまなタイプの多数のDataPointを単一のデータソースにダンプするのではなく、目的または機能に基づいてデータソースを作成することをお勧めします。 たとえば、CPU、ガベージコレクション、エラー/成功カウント、およびレイテンシー用に個別のデータソースを作成する必要があります。
選択したインスタンスラベルに基づいて、他にラベルがない場合は、メトリック名とインスタンスラベルが一致するメトリックがXNUMXつのメトリックに折りたたまれます。 これらのDataPoint定義が正しい場合は、をクリックできます 終了.
DataPoint定義のいずれかを編集するには、編集鉛筆をクリックします。 あなたはできる:
- DataPointの名前と説明を変更します。
- メトリックを単一のDataPointに集約します。
- ラベル値に基づいてメトリックを除外し、関心のある値のみをキャプチャします。
指標を除外するには、一致するラベル、演算子、値を選択します。 次に、集計タイプを選択します:合計または平均。
演算子 | 説明 |
等しいです | Equals演算子を使用して、ラベルの特定の値をフィルタリングできます。 たとえば、「環境」ラベルがある場合、「prod」を選択して、Prod環境からのみデータを収集し、テストおよびQAでは収集できません。 |
正規表現 | RegEx演算子の場合、正規表現とワイルドカードを使用して、複数のメトリックを照合し、それらのメトリックの値を集計できます。 *を入力して任意の値をフィルタリングするか、^ fooを入力してfooで始まるすべての値をフィルタリングできます。 たとえば、失敗の理由を表すラベルがあり、DataPointに失敗の総数をキャプチャさせたい場合、フィルターには次のものを含めることができます:label = reason、operator = equals、value = *、aggregation method = sum 。 |
DataPointの編集が完了したら、変更を保存して、[ 終了
ご注意: Status 終了 ボタンが無効になっている場合は、DataPointが正しく定義されていない可能性があります。 DataPointリストをチェックして、すべてのステータスが緑色であることを確認します。 赤いステータスにカーソルを合わせると、エラーの詳細が表示されます。 一般的なエラーは、メトリックに選択したインスタンスラベルが含まれていないことです。 この場合、戻って正しいインスタンスラベルを選択するか、データポイントを削除して続行します。
終了
[完了]画面から、別のデータソースを作成するか、OpenMetricsページに戻るかを選択できます。 新しいデータソースを作成すると、プロセスが再開されます。