sonar-log-schemas
Logpresso Sonarに登録されたログスキーマ一覧を照会します。ログスキーマは log、schema コマンドなどでフィールド名の変換と並べ替えの基準として使用されます。
コマンドプロパティ
| 項目 | 説明 |
|---|---|
| コマンドタイプ | ドライバークエリ |
| 必要な権限 | 管理者 |
| ライセンス使用量 | 集計あり |
| 並列実行 | 非対応 |
| 分散実行 | データノードで実行（mapper） |
構文
sonar-log-schemas [keywords=STR] [locale=STR]
オプション
keywords=STR- コード、名前、説明から検索するキーワード
locale=STR- 表示名を取得するロケール。
ko、en、ja、zhのいずれかを指定します。指定しない場合はセッションに設定されたロケールを使用します。
入力フィールド
なし（ドライバークエリのため、パイプラインの最初のコマンドとしてのみ使用します）
出力フィールド
| フィールド | タイプ | 説明 |
|---|---|---|
| code | 文字列 | スキーマコード |
| name | 文字列 | スキーマ名（locale オプション適用時は該当言語の表示名） |
| description | 文字列 | スキーマの説明 |
| app_code | 文字列 | アプリ識別子 |
| app_built_in | ブーリアン | アプリに含まれるログスキーマオブジェクトかどうか |
| created | 日付 | 生成時刻 |
| updated | 日付 | 最終更新時刻 |
エラーコード
パースエラー
| エラーコード | メッセージ | 説明 |
|---|---|---|
| 300146 | No permission to enumerate log schemas. | 管理者権限のないアカウントで実行した場合 |
ランタイムエラー
該当なし
説明
sonar-log-schemas コマンドは最大1,000件ずつページ単位で照会し、登録されたすべてのログスキーマを順次返します。keywords オプションを指定すると、コード、名前、説明全体を対象に検索します。
locale オプションを指定すると、name フィールドの値を該当言語の表示名に置き換えます。対応していないロケール値を指定すると無視されデフォルトの名前が返され、対応するロケールであってもその言語の翻訳がない場合はデフォルトの名前に置き換わります。locale オプションを指定しない場合は現在のセッションのロケール設定に従います。
使用例
-
全ログスキーマ一覧を照会
sonar-log-schemas -
キーワードで検索
sonar-log-schemas keywords="session" -
表示名を英語で照会
sonar-log-schemas locale="en" -
アプリに含まれるログスキーマのみを照会
sonar-log-schemas | search app_built_in == true | fields code, name, app_code
変更履歴
sonar-log-schemas コマンドはSonar 4.0.2609.0バージョンから利用可能です。Experimental アプリが提供していたコマンドをSonarコアに内蔵したものです。内蔵されていないバージョンでは、Experimental アプリをインストールして使用できます。