LogicModuleアラートメッセージで使用可能なトークン

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

日時 アラートメッセージの定義 または、アラート データを外部システム (チケット発行システムやチャット システムなど) と統合する場合、トークンを使用して、メッセージまたは統合配信を現在の状態にカスタマイズできます。 これらのトークンは生成時に置き換えられるため、アラートまたは統合の配信に動的な情報を含めることができます。

次の記事では、現在サポートされているトークンと使用可能な置換をリストしています。

注: 日付や時刻を参照するすべてのトークンは、グローバル LogicMonitor アカウント用に構成されたタイム ゾーンに基づいています ([設定] > [アカウント情報] > [ポータル設定])。 これらは、アラート受信者のユーザー アカウントで構成されたタイム ゾーンに基づいていません。

トークンタイプ

  • コレクターのダウンおよびフェイルオーバー トークン - 構成されている場合、コレクターのダウンおよびバックアップ コレクターへのフェイルオーバーを通知するアラート メッセージで使用できます。
  • DataSource トークン - DataSource によって定義されたデータポイントから発信されるアラート メッセージで使用できます。
  • 根本原因分析トークン - 発生するアラート メッセージで使用できます。 根本原因分析.
  • Web サイト トークン - 監視対象の Web サイトから発信されるアラート メッセージで使用できます。
  • JobMonitor トークン - JobMonitor 定義から生成されるアラート メッセージで使用できます。
  • クラスタ アラート トークン - クラスタ アラート (つまり、リソース グループ内の複数のリソースにわたるデータポイントのステータスに基づいてトリガーされるアラート) から発生するアラート メッセージで使用できます。
  • EventSource トークン - EventSource 定義から発生するアラート メッセージで使用できます。 次のタイプの EventSource では、追加のトークンを使用できます。
    • Windowsイベントログトークン
    • IPMIイベントトークン
    • SNMPトラップトークン
    • Syslogイベントトークン
  • LM 統合トークン — アラート データをメッセージ ツールや ITSM ソリューションなどの外部システムと統合するときに使用できます。

利用可能なトークン

次の表に、LogicModuleまたは関数ごとに整理された使用可能なアラートメッセージトークンを示します。

Next以下のために利用可能説明
## ##コレクターダウントークンとフェイルオーバートークン(ホストデバイスではなく)コレクター自体に割り当てられているカスタムプロパティの値を返します。 プロパティ名にスペースやダッシュを含めることはできません。
## ##データソーストークン 関連するデバイスまたはインスタンスのプロパティ(カスタムまたはシステムプロパティのいずれか)の値に置き換えられます。 トークンとして使用するには、プロパティ名を二重ハッシュマークで囲みます。 プロパティ名にスペースやダッシュを含めることはできません。
## ADMIN ##LM 統合トークンアラートがエスカレーションされたユーザー。
## AGENT_DESCRIPTION ##コレクターダウントークンとフェイルオーバートークンダウンしたコレクターの名前(説明)。
## AGENT_DESCRIPTION ##データソーストークン

EventSourceトークン

JobMonitorトークン
アラートに関連付けられているデバイスが割り当てられているコレクターの名前(説明)
## AGENTID ##コレクターのダウンとフェイルオーバーダウンしたコレクターのID。
## AGENTID ##データソーストークン

EventSourceトークン

JobMonitorトークン
アラートに関連付けられているデバイスが割り当てられているコレクターのID
## ALERTDEPENDENCYROLE ##データソーストークン

根本原因分析トークン
根本原因インシデントにおけるアラートの役割。
## ALERTDETAILURL ##クラスターアラートトークン

コレクターダウントークンとフェイルオーバートークン

データソーストークン

EventSourceトークン

JobMonitorトークン

ウェブサイトトークン
[アラートの詳細]ページのURL。 このページから、アラートを確認、エスカレーション、またはSDTに入れることができます。 デフォルトでは、このURLは、電子メールまたはSMSを介して送信されるすべてのアラート通知の上部に含まれています。
## ALERTID ##クラスターアラートトークン

コレクターダウントークンとフェイルオーバートークン

データソーストークン

EventSourceトークン

JobMonitorトークン

ウェブサイトトークン
LMDXXXX、LMSXXXXなど。LogicMonitorアラートID。 このIDは、アラートセッションごとに一意ではありません。 これは、特定のリソース、Webサイト、LogicModule、インスタンス、およびデータポイントの組み合わせによってトリガーされるすべてのアラートに適用されます。 
##アラートステータス##データソーストークンアラートがアクティブ、クリア、確認、更新、またはテストのいずれであるかを報告します。
## ALERTTYPE ##LM 統合トークンアラートのタイプ:alert、eventAlert、batchJobAlert、hostClusterAlert、websiteAlert、agentDownAlert、agentFailoverAlert、agentFailBackAlert、alertThrottledAlert。
## AUTOFAILBACKENABLED ##コレクターダウントークンとフェイルオーバートークンダウンしたコレクターが、再び使用可能になったときに自動的に操作を再開するように構成されているかどうかを示します。
## BACKUPAGENT_DESCRIPTION ##コレクターダウントークンとフェイルオーバートークンダウンしたコレクターのフェイルオーバーコレクター(構成されている場合)の名前(説明)。
## BACKUPAGENT_DESCRIPTION ##データソーストークン

EventSourceトークン

JobMonitorトークン
リソースに関連付けられているプラ​​イマリコレクターのフェールオーバーコレクターの名前(構成されている場合)。
## BACKUPAGENTID ##コレクターダウントークンとフェイルオーバートークンダウンしたコレクターのフェイルオーバーコレクター(構成されている場合)のID。
## BACKUPAGENTID ##データソーストークン

EventSourceトークン

JobMonitorトークン
リソースに関連付けられているプラ​​イマリコレクターのフェールオーバーコレクターのID(構成されている場合)。
## BJDESCRIPTION ##JobMonitorトークンJobMonitorの説明。
##チェックポイント##ウェブサイトトークンアラートに関連付けられたチェックポイント。 複数の場所でのチェックに基づいてアラートがトリガーされた場合、この値は「全体」になります。
## CMDLINE ##JobMonitorトークンジョブのコマンドライン。

警告: コマンド ラインに機密情報が存在する場合、このトークンはその情報をアラート メッセージで公開する可能性があります。 機密情報がコマンド ラインに存在する場合、LogicMonitor はこのトークンの使用を推奨しません。
## COLLECTORGROUP ##コレクターダウントークンとフェイルオーバートークンアラートコレクターが属するコレクターグループの名前。
##データポイント##クラスターアラートトークン

データソーストークン
アラート中のデータポイントの名前。
##情報元##クラスターアラートトークン

データソーストークン
DataSourceの表示名(DataSource名に解決される## DSNAME ##と混同しないでください)。 マルチインスタンスデータソースの場合、このトークンは完全修飾インスタンス名に解決されます( - )。
##情報元##EventSourceトークンアラートをトリガーしたEventSource。
##情報元##JobMonitorトークンJobMonitor名。
##日付##EventSource(IPMIイベント)トークン IPMIイベントログによって報告されたイベントの日付。
##日付##クラスターアラートトークン

データソーストークン

EventSourceトークン
アラートが送信された日付。
##日付##JobMonitorトークンジョブの実行日。
## DEPENDENCYMESSAGE ##データソーストークン

根本原因分析トークン
根本原因分析を受けたアラートに付随するすべての根本原因の詳細を表します。
## DEPENDENTALERTCOUNT ##データソーストークン

根本原因分析トークン
現在のアラートに依存するアラートの数。
## DEPENDENTRESOURCECOUNT ##データソーストークン

根本原因分析トークン
現在のアラートに依存するリソースの数。
##詳細##ウェブサイトトークンアラートに関連する詳細。 個々の場所でのアラート通知の場合、これには失敗したステップのURLとそのステップのHTTP応答が含まれます。 全体的なアラートの場合、これには失敗したチェックの数が含まれます。
## DEVICEURL ##データソーストークン

EventSourceトークン

JobMonitorトークン
デバイスに関連付けられているURLリンク。 使用できない場合は、「null」が返されます。
## DIRECTCAUSE ##データソーストークン

根本原因分析トークン
現在のアラートの直接の原因であると判断されたリソース。
## DPDESCRIPTION ##データソーストークンデータソース定義からのアラート内のデータポイントの説明(例:ボリュームで使用されたパーセンテージ)。 使用できない場合は、「null」が返されます。
## DSDESCRIPTION ##データソーストークンアラート内のデータソースの説明(たとえば、論理ボリュームのスペース使用量を監視します)。 使用できない場合は、「null」が返されます。
## DSDESCRIPTION ##JobMonitorトークンJobMonitorの説明
## DSIDESCRIPTION ##データソーストークンActive Discoveryによって定義された、または[リソース]ページの[インスタンス]タブで手動で設定された、アラート内のインスタンスの説明。 使用できない場合は、「null」が返されます。
## DSNAME ##クラスターアラートトークン

データソーストークン
データソース名。
## DTALERTDESCRIPTION ##データソーストークン日時 動的しきい値 アラートをトリガーすると、このトークンは超過した動的しきい値構成の詳細を返します(たとえば、過去100回のポーリングのデータポイントmemory_usage_percentageの値の5%が上限または下限から2.00倍ずれて、警告アラートをトリガーします)。 このトークンは、## THRESHOLD ##トークンの値の一部として自動的に参照されます。
##デュレーション##クラスターアラートトークン

データソーストークン

EventSourceトークン
アラートが存在していた期間。
##終わり##クラスターアラートトークン

データソーストークン

EventSourceトークン

JobMonitorトークン

ウェブサイトトークン
アラートクリアメッセージのクリア日時を表示します。
## ENTERPRISEOID ##EventSource(SNMPトラップ)トークントラップを送信したコレクターのID(v1トラップのみ)。
## EVENTCODE ##EventSource(Windowsイベントログ)トークンWindowsイベントID。
## EVENTSOURCE ##EventSourceトークンアラートをトリガーしたEventSource。
## EXITCODE ##JobMonitorトークンジョブの終了コード。
## EXTERNALTICKETID ##LM 統合トークン外部システムによって作成および返されるチケット識別子。
## EXTERNALTICKETID ##クラスターアラートトークン

データソーストークン

EventSourceトークン

JobMonitorトークン

ウェブサイトトークン
統合チケットIDとそれぞれに関連する統合名のリスト。
##施設##EventSource(Syslogイベント)トークンイベントのsyslog機能。
##終了##JobMonitorトークンジョブが終了した時間。
##一般コード##EventSource(SNMPトラップ)トークントラップ内のSNMP一般コード(v1トラップのみ)。
##グループ##クラスターアラートトークン

データソーストークン

EvenSourceトークン

JobMonitorトークン
このホストまたはリソースがメンバーになっているグループを表示します。
##ホスト##データソーストークン

EventSourceトークン

JobMonitorトークン
アラート内のリソースに置き換えられます。
##ホストの説明##データソーストークン

EventSourceトークン

JobMonitorトークン
アラート内のリソースのテキスト説明。 使用できない場合は、「null」が返されます。
##ホスト名##データソーストークン

EventSourceトークン

JobMonitorトークン
アラート内のリソースの表示名。
##インスタンス##データソーストークンDataSourceインスタンスの名前(例:「C:\」)。
## INSTANCEGROUP ##データソーストークン

JobMonitorトークン
アラートインスタンスが属するグループの名前。
##内部ID ##LM 統合トークン一意のアラートID(DSXXXXXXXX)を返します。 このIDは、同じアラートセッション内で重大度の変更が発生した場合でも、アラートの重大度が変更されると更新されます。 このトークンは、サードパーティのイベント管理システムに誤って再送信された重複アラートペイロードを識別して抑制するのに役立つ場合があります(通常、送信タイムアウトまたは失敗の結果として)。
##内部ID ##クラスターアラートトークン

データソーストークン

EventSourceトークン

JobMonitorトークン

ウェブサイトトークン
一意のアラートID(DSXXXXXXXX)を返します。 このIDは、同じアラートセッション内で重大度の変更が発生した場合でも、アラートの重大度が変更されると更新されます。
##レベル##クラスターアラートトークン

データソーストークン

EventSourceトークン

JobMonitorトークン

ウェブサイトトークン
アラートの重大度。
## LIMITEDMESSAGE ##データソーストークン

EventSourceトークン

JobMonitorトークン
データソース – データなし | 無限大 | 値 (double/int)

EventSource & JobMonitor – 生成されたメッセージの最初の 10 語。
##ログファイル##EventSource(Windowsイベントログ)トークンWindowsイベントログファイル(システム、アプリケーション、セキュリティなど)
##メッセージ##LM 統合トークンアラートメッセージのレンダリングされたテキスト。 このトークンは、関連するすべての確認済み情報(アラートを確認したユーザー、確認応答など)も渡します。
##メッセージ##EventSource(IPMIイベント)トークンIPMIイベントログメッセージ。
##メッセージ##EventSource(Syslogイベント)トークンSyslogメッセージ。
##メッセージ##EventSource(Windowsイベントログ)トークンイベントログメッセージ。
##発生原因##データソーストークン

根本原因分析トークン
現在のアラートの元の原因であると判断されたリソース。
## ROUTINGSTATE ##データソーストークン

根本原因分析トークン
現在のアラートの通知ルーティングのステータス。
##ソース名##EventSource(Windowsイベントログ)トークンWindowsソースサブシステム(例:Microsoft-Windows-DistributedCOM)
## SPECIFICCODE ##EventSource(SNMPトラップ)トークントラップ内の特定のコード(v1トラップのみ)。
##開始##クラスターアラートトークン

コレクターダウントークンとフェイルオーバートークン

データソーストークン

EventSourceトークン

JobMonitorトークン

ウェブサイトトークン
アラート状態が開始した時刻。
## STARTEPOCH ##データソーストークン

EventSourceトークン

JobMonitorトークン
このアラートが開始された時刻(UNIXエポック時間)。 一意のアラート識別子を作成するのに便利です。
## STDERR ##JobMonitorトークンジョブによって返される標準エラー。
## STDOUT ##JobMonitorトークン標準出力がジョブから返されました。
## SYSUPTIME ##EventSource(SNMPトラップ)トークントラップを送信するSNMPコレクターの稼働時間。
##しきい値##データソーストークンアラートをトリガーしたアラートしきい値。 ## THRESHOLD ##トークンの値には、## DTALERTDESCRIPTION ##トークンの値が組み込まれており、該当する場合、静的しきい値と動的しきい値の両方にしきい値の詳細が確実に提供されます。
##タイムスタンプ##EventSource(IPMIイベント)トークンエポック形式のシステムイベントログ内のイベントの時刻。
##トラポイド##EventSource(SNMPトラップ)トークンv2cトラップのトラップ識別。
##タイプ##EventSource(Windowsイベントログ)トークンWindowsによって報告されたイベントレベル(エラー、情報など)。
## URL ##ウェブサイトトークンWebチェックがテストしているデフォルトのルートURL( デフォルトのルートURL Webチェック定義にあるフィールド。
##ユーザー##EventSource(Windowsイベントログ)トークンWindowsによって報告された、イベントに関連付けられたユーザー(存在する場合)。
## USERDATA ##JobMonitorトークンバッチジョブによって報告されたその他のユーザーデータ。
##値##クラスターアラートトークン

データソーストークン
アラートが生成されたときのデータポイントの値。
##値##EventSourceトークンイベントメッセージ全体(完全なWindowsイベントログイベント、完全なIPMIイベントログ、またはSNMPトラップの内容)
##値##ウェブサイトトークン全体的なアラートの場合、これは失敗したチェックの数を参照します。 個々の場所でのアラートの場合、これはステップが失敗した理由を参照します(たとえば、HTTP応答と一致しない、正しいコンテンツが含まれていないなど)。
##ウェブサイト##ウェブサイトトークンアラート内のWebサイトの名前。
##ウェブサイトの説明##ウェブサイトトークンWebサイトに関連付けられている説明。
##ウェブサイトグループ##ウェブサイトトークンWebサイトが属するグループ。
## WEBSITEREQUEST ##ウェブサイトトークンアラートが生成されたときに送信された完全なリクエスト。 これは、全体的なステータスではなく、個々のチェックポイントに対してアラートが構成されている場合に機能します。
##ウェブサイトの対応##ウェブサイトトークンアラートが生成されたときに受信した完全な応答。 これは、全体的なステータスではなく、個々のチェックポイントに対してアラートが構成されている場合に機能します。
##ワイルドバリュー##データソーストークンインスタンス値。
記事上で