sonar-widgets
Logpresso Sonarに登録されたすべてのウィジェット一覧を照会します。各ウィジェットのGUID、名前、レンダリングタイプ、更新間隔、所有者、共有先などの属性も返します。
コマンドプロパティ
| 項目 | 説明 |
|---|---|
| コマンドタイプ | ドライバークエリ |
| 必要な権限 | 管理者 |
| ライセンス使用量 | 集計あり |
| 並列実行 | 非対応 |
| 分散実行 | 非対応 |
構文
sonar-widgets
オプション
オプションなし
出力フィールド
| フィールド | タイプ | 説明 |
|---|---|---|
| guid | 文字列 | ウィジェットGUID |
| name | 文字列 | ウィジェット名 |
| description | 文字列 | ウィジェットの説明 |
| render_type | 文字列 | ウィジェットのレンダリングタイプ |
| interval | 32ビット整数 | ウィジェットの更新間隔 |
| owner_guid | 文字列 | ウィジェット所有者GUID。現在の実装では値が出力されません |
| owner_name | 文字列 | ウィジェット所有者名 |
| shared_users | 配列 | 共有されたユーザー一覧。各項目は guid、name、type、read_only、created フィールドを持つオブジェクトで、created は日付値ではなく yyyy-MM-dd HH:mm:ssZ 形式の文字列です |
| shared_groups | 配列 | 共有されたユーザーグループ一覧。各項目は guid、name、type、read_only、created フィールドを持つオブジェクトで、created は日付値ではなく yyyy-MM-dd HH:mm:ssZ 形式の文字列です |
| created | 日付 | 生成日 |
| updated | 日付 | 最終更新日 |
エラーコード
パースエラー
| エラーコード | メッセージ | 説明 |
|---|---|---|
| 300171 | No permission to list widgets | 管理者権限のないアカウントで実行した場合 |
ランタイムエラー
該当なし
説明
sonar-widgets コマンドはフィルターなしで同じ会社（テナント）に属するすべてのウィジェットを照会対象とします。照会クエリがタブをジョインしないため、ダッシュボードに配置されているかどうかに関係なくすべてのウィジェットが対象となり、管理者権限で実行するため所有者や共有の有無にも関係なく返されます。特定のウィジェットだけを確認するには後ろに search や fields コマンドを連結してフィルタリングする必要があります。
照会したウィジェットを複製するには、sonar-clone-widgets コマンドを使用してください。
使用例
-
全ウィジェット一覧を照会
sonar-widgetsシステムに登録されたすべてのウィジェットの属性を返します。
-
レンダリングタイプ別のウィジェット数を集計
sonar-widgets | stats count by render_typeウィジェットをレンダリングタイプ別にグループ化して件数を集計します。
-
特定の所有者が作成したウィジェットのみを照会
sonar-widgets | search owner_name == "管理者"所有者表示名が
管理者であるウィジェットのみをフィルタリングします。owner_nameはログイン名ではなくアカウントの表示名（氏名）のため、ログイン名と異なる値を使用するアカウントでは表示名を基準に指定する必要があります。
変更履歴
sonar-widgets コマンドはSonar 4.0.2609.0バージョンから利用可能です。Experimental アプリが提供していたコマンドをSonarコアに内蔵したものです。内蔵されていないバージョンでは、Experimental アプリをインストールして使用できます。