Grafana

Grafanaダッシュボード、アラート、アノテーションを操作する

Grafanaは、モニタリング、可観測性、視覚化のための主要なオープンソースプラットフォームです。さまざまなソースからのデータのクエリ、視覚化、アラート、分析を可能にし、インフラストラクチャとアプリケーションのモニタリングに不可欠なツールとなっています。

Grafanaでは以下のことができます:

  • データの視覚化:メトリクス、ログ、トレースをリアルタイムで表示するためのダッシュボードを構築・カスタマイズ
  • 健全性とステータスの監視:Grafanaインスタンスと接続されたデータソースの健全性をチェック
  • アラートとアノテーションの管理:アラートルールの設定、通知の管理、重要なイベントでダッシュボードにアノテーションを付ける
  • コンテンツの整理:より良いアクセス管理のためにダッシュボードとデータソースをフォルダに整理

Simでは、Grafana統合によりエージェントがAPI経由でGrafanaインスタンスと直接やり取りできるようになり、以下のようなアクションが可能になります:

  • Grafanaサーバー、データベース、データソースの健全性ステータスの確認
  • ダッシュボード、アラートルール、アノテーション、データソース、フォルダの取得、一覧表示、管理
  • Grafanaデータとアラートをワークフロー自動化に統合することによるインフラストラクチャのモニタリングの自動化

これらの機能により、Simエージェントはシステムを監視し、アラートに積極的に対応し、自動化されたワークフローの一部として、サービスの信頼性と可視性を確保するのに役立ちます。

使用方法

Grafanaをワークフローに統合します。ダッシュボード、アラート、アノテーション、データソース、フォルダを管理し、健全性ステータスを監視します。

ツール

grafana_get_dashboard

UIDでダッシュボードを取得する

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンスの組織ID
dashboardUidstringはい取得するダッシュボードのUID

出力

パラメータ説明
dashboardjson完全なダッシュボードJSONオブジェクト
metajsonダッシュボードのメタデータ(バージョン、権限など)

grafana_list_dashboards

すべてのダッシュボードを検索およびリスト表示する

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンス用の組織ID
querystringいいえタイトルでダッシュボードをフィルタリングする検索クエリ
tagstringいいえタグでフィルタリング(複数のタグはカンマ区切り)
folderIdsstringいいえフォルダIDでフィルタリング(カンマ区切り)
starredbooleanいいえスター付きダッシュボードのみを返す
limitnumberいいえ返すダッシュボードの最大数

出力

パラメータ説明
dashboardsarrayダッシュボード検索結果のリスト

grafana_create_dashboard

新しいダッシュボードを作成する

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンス用の組織ID
titlestringはい新しいダッシュボードのタイトル
folderUidstringいいえダッシュボードを作成するフォルダのUID
tagsstringいいえカンマ区切りのタグリスト
timezonestringいいえダッシュボードのタイムゾーン(例:browser、utc)
refreshstringいいえ自動更新間隔(例:5s、1m、5m)
panelsstringいいえパネル設定のJSON配列
overwritebooleanいいえ同じタイトルの既存ダッシュボードを上書きする
messagestringいいえダッシュボードバージョンのコミットメッセージ

出力

パラメータ説明
idnumber作成されたダッシュボードの数値ID
uidstring作成されたダッシュボードのUID
urlstringダッシュボードへのURLパス
statusstring操作のステータス(success)
versionnumberダッシュボードのバージョン番号
slugstringダッシュボードのURL用スラッグ

grafana_update_dashboard

既存のダッシュボードを更新します。現在のダッシュボードを取得し、変更内容をマージします。

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスのURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンス用の組織ID
dashboardUidstringはい更新するダッシュボードのUID
titlestringいいえダッシュボードの新しいタイトル
folderUidstringいいえダッシュボードを移動する新しいフォルダのUID
tagsstringいいえ新しいタグのカンマ区切りリスト
timezonestringいいえダッシュボードのタイムゾーン(例:browser、utc)
refreshstringいいえ自動更新間隔(例:5s、1m、5m)
panelsstringいいえパネル設定のJSON配列
overwritebooleanいいえバージョンの競合があっても上書きする
messagestringいいえこのバージョンのコミットメッセージ

出力

パラメータ説明
idnumber更新されたダッシュボードの数値ID
uidstring更新されたダッシュボードのUID
urlstringダッシュボードへのURLパス
statusstring操作のステータス(success)
versionnumberダッシュボードの新しいバージョン番号
slugstringダッシュボードのURL用スラッグ

grafana_delete_dashboard

UIDでダッシュボードを削除する

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンス用の組織ID
dashboardUidstringはい削除するダッシュボードのUID

出力

パラメータ説明
titlestring削除されたダッシュボードのタイトル
messagestring確認メッセージ
idnumber削除されたダッシュボードのID

grafana_list_alert_rules

Grafanaインスタンス内のすべてのアラートルールを一覧表示する

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンス用の組織ID

出力

パラメータ説明
rulesarrayアラートルールのリスト

grafana_get_alert_rule

UIDによって特定のアラートルールを取得する

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンス用の組織ID
alertRuleUidstringはい取得するアラートルールのUID

出力

パラメータ説明
uidstringアラートルールUID
titlestringアラートルールタイトル
conditionstringアラート条件
datajsonアラートルールクエリデータ
folderUIDstring親フォルダUID
ruleGroupstringルールグループ名
noDataStatestringデータが返されない場合の状態
execErrStatestring実行エラー時の状態
annotationsjsonアラート注釈
labelsjsonアラートラベル

grafana_create_alert_rule

新しいアラートルールを作成する

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンス用の組織ID
titlestringはいアラートルールのタイトル
folderUidstringはいアラートを作成するフォルダのUID
ruleGroupstringはいルールグループの名前
conditionstringはいアラート条件として使用するクエリまたは式のrefId
datastringはいクエリ/式データオブジェクトのJSON配列
forDurationstringいいえ発火前の待機時間(例:5m、1h)
noDataStatestringいいえデータが返されない場合の状態(NoData、Alerting、OK)
execErrStatestringいいえ実行エラー時の状態(Alerting、OK)
annotationsstringいいえ注釈のJSONオブジェクト
labelsstringいいえラベルのJSONオブジェクト

出力

パラメータ説明
uidstring作成されたアラートルールのUID
titlestringアラートルールのタイトル
folderUIDstring親フォルダのUID
ruleGroupstringルールグループ名

grafana_update_alert_rule

既存のアラートルールを更新します。現在のルールを取得し、変更内容をマージします。

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスのURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンスの組織ID
alertRuleUidstringはい更新するアラートルールのUID
titlestringいいえアラートルールの新しいタイトル
folderUidstringいいえアラートを移動する新しいフォルダのUID
ruleGroupstringいいえ新しいルールグループ名
conditionstringいいえ新しい条件のrefId
datastringいいえクエリ/式データオブジェクトの新しいJSON配列
forDurationstringいいえアラートを発生させるまでの待機時間(例:5m、1h)
noDataStatestringいいえデータが返されない場合の状態(NoData、Alerting、OK)
execErrStatestringいいえ実行エラー時の状態(Alerting、OK)
annotationsstringいいえアノテーションのJSONオブジェクト
labelsstringいいえラベルのJSONオブジェクト

出力

パラメータ説明
uidstring更新されたアラートルールのUID
titlestringアラートルールのタイトル
folderUIDstring親フォルダのUID
ruleGroupstringルールグループ名

grafana_delete_alert_rule

UIDによるアラートルールの削除

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンスの組織ID
alertRuleUidstringはい削除するアラートルールのUID

出力

パラメータ説明
messagestring確認メッセージ

grafana_list_contact_points

すべてのアラート通知コンタクトポイントの一覧表示

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンスの組織ID

出力

パラメータ説明
contactPointsarrayコンタクトポイントのリスト

grafana_create_annotation

ダッシュボード上または全体的なアノテーションとしてアノテーションを作成する

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンス用の組織ID
textstringはいアノテーションのテキスト内容
tagsstringいいえカンマ区切りのタグリスト
dashboardUidstringはいアノテーションを追加するダッシュボードのUID
panelIdnumberいいえアノテーションを追加するパネルのID
timenumberいいえエポックミリ秒での開始時間(デフォルトは現在時刻)
timeEndnumberいいえエポックミリ秒での終了時間(範囲アノテーション用)

出力

パラメータ説明
idnumber作成されたアノテーションのID
messagestring確認メッセージ

grafana_list_annotations

時間範囲、ダッシュボード、またはタグでアノテーションを検索する

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンス用の組織ID
fromnumberいいえエポックミリ秒での開始時間
tonumberいいえエポックミリ秒での終了時間
dashboardUidstringはいアノテーションを取得するダッシュボードのUID
panelIdnumberいいえパネルIDでフィルタリング
tagsstringいいえフィルタリングするタグのカンマ区切りリスト
typestringいいえタイプでフィルタリング(alertまたはannotation)
limitnumberいいえ返すアノテーションの最大数

出力

パラメータ説明
annotationsarrayアノテーションのリスト

grafana_update_annotation

既存のアノテーションを更新する

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンス用の組織ID
annotationIdnumberはい更新するアノテーションのID
textstringはいアノテーションの新しいテキスト内容
tagsstringいいえ新しいタグのカンマ区切りリスト
timenumberいいえエポックミリ秒での新しい開始時間
timeEndnumberいいえエポックミリ秒での新しい終了時間

出力

パラメータ説明
idnumber更新されたアノテーションのID
messagestring確認メッセージ

grafana_delete_annotation

IDでアノテーションを削除する

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンス用の組織ID
annotationIdnumberはい削除するアノテーションのID

出力

パラメータ説明
messagestring確認メッセージ

grafana_list_data_sources

Grafanaで設定されているすべてのデータソースを一覧表示する

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンス用の組織ID

出力

パラメータ説明
dataSourcesarrayデータソースのリスト

grafana_get_data_source

IDまたはUIDでデータソースを取得する

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンス用の組織ID
dataSourceIdstringはい取得するデータソースのIDまたはUID

出力

パラメータ説明
idnumberデータソースID
uidstringデータソースUID
namestringデータソース名
typestringデータソースタイプ
urlstringデータソース接続URL
databasestringデータベース名(該当する場合)
isDefaultbooleanこれがデフォルトのデータソースかどうか
jsonDatajson追加のデータソース設定

grafana_list_folders

Grafanaのすべてのフォルダを一覧表示

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンス用の組織ID
limitnumberいいえ返すフォルダの最大数
pagenumberいいえページネーション用のページ番号

出力

パラメータ説明
foldersarrayフォルダのリスト

grafana_create_folder

Grafanaに新しいフォルダを作成

入力

パラメータ必須説明
apiKeystringはいGrafanaサービスアカウントトークン
baseUrlstringはいGrafanaインスタンスURL(例:https://your-grafana.com)
organizationIdstringいいえマルチ組織Grafanaインスタンス用の組織ID
titlestringはい新しいフォルダのタイトル
uidstringいいえフォルダのオプションUID(提供されない場合は自動生成)

出力

パラメータ説明
idnumber作成されたフォルダの数値ID
uidstring作成されたフォルダのUID
titlestring作成されたフォルダのタイトル
urlstringフォルダへのURLパス
hasAclbooleanフォルダがカスタムACL権限を持っているかどうか
canSaveboolean現在のユーザーがフォルダを保存できるかどうか
canEditboolean現在のユーザーがフォルダを編集できるかどうか
canAdminboolean現在のユーザーがフォルダに対して管理者権限を持っているかどうか
canDeleteboolean現在のユーザーがフォルダを削除できるかどうか
createdBystringフォルダを作成したユーザーのユーザー名
createdstringフォルダが作成されたときのタイムスタンプ
updatedBystringフォルダを最後に更新したユーザーのユーザー名
updatedstringフォルダが最後に更新されたときのタイムスタンプ
versionnumberフォルダのバージョン番号

On this page

Start building today
Trusted by over 70,000 builders.
Build Agentic workflows visually on a drag-and-drop canvas or with natural language.
Get started