- 印刷する
- PDF
管理
- 印刷する
- PDF
Classic/VPC環境で利用できます。
管理ではコンソールのプロジェクトとグループメニューと連携しているプロジェクトとグループの管理方法、通知設定方法、保存した検索(クエリ)の管理方法を説明します。
プロジェクト管理
コンソールのプロジェクトメニューと連携しているプロジェクト情報を確認するか、ログフィールドを管理できます。
プロジェクト画面
Web Appの 管理 > プロジェクト メニューの基本的な説明は、次の通りです。
領域 | 説明 |
---|---|
① チーム名の検索ボックス | チーム名でプロジェクト検索 |
② プラットフォーム | プラットフォームを選択または選択解除してプロジェクトをフィルタリング |
③ 長期未使用表示 | 長期未使用プロジェクトの表示を選択または選択解除し、プロジェクトをフィルタリング |
④ 表示方式 | ウィジェットまたは表で表示 |
⑤ ソート方式 | ソート方式を選択 |
⑥ 検索ボックス | プロジェクト名または txtTokenを基準にプロジェクトを検索 |
⑦ プロジェクトリスト | 表示方式に応じてウィジェットまたは表でプロジェクトを表示
|
プロジェクト詳細情報確認
Web Appの 管理 > プロジェクト メニューで、プロジェクトの詳細情報を確認する方法は次の通りです。
- Web Appにアクセスします(Web Appにアクセスを参照)。
- 管理 > プロジェクト メニューをクリックします。
- リスト(ウィジェットまたは表)で確認するプロジェクト名をクリックします。
- 検索とフィルタリング機能を活用してプロジェクトを検索できます。
- プロジェクトの詳細情報を確認します。
- 右上の [検索] ボタンをクリックすると、当該プロジェクトのログ検索を行えます(ログ検索を参照)。
- 基本情報 : コンソールで作成した当該プロジェクトの情報表示
- 1日のログ使用量 : コンソールで設定した 1日の最大収集 Log容量 を基準に現在の状態をチャートで表示
- 過去30日間のリクエスト状態 : コンソールで設定した Log保存期間 を基準に検索数と検索範囲をチャートで表示
- ログサンプリング : コンソールで設定した Logサンプリング を基準に現在の状態を表示
- ログアラーム : 現在準備中
- 過去30日間の使用量 : コンソールで設定した Log保存期間 を基準にログ使用量をチャートで表示
- スキーマ : ログ転送と検索に使用するスキーマを確認するか、新規追加・管理(スキーマ追加と管理を参照)
スキーマ追加と管理
Web Appの 管理 > プロジェクト メニューで、プロジェクトのスキーマを追加、変更、削除する方法は次の通りです。
- Web Appにアクセスします(Web Appにアクセスを参照)。
- 管理 > プロジェクト メニューをクリックします。
- リスト(ウィジェットまたは表)でプロジェクト名をクリックします。
- 検索とフィルタリング機能を活用してプロジェクトを検索できます。
- プロジェクトの詳細情報画面の スキーマ 領域で、 [スキーマ追加] ボタンをクリックします。
- フィールド追加のポップアップでフィールド情報を入力と選択した後、 [保存] ボタンをクリックします。
- field name : 作成するフィールドの名前を入力
- data type : データタイプを選択
- data format : データタイプで date を選択した時に表示
- フィールドを作成してリストに表示します。
- 必要に応じて、追加したフィールドを変更または削除します。
- プロジェクトの基本フィールドは、変更・削除できません。
- 追加したフィールドを編集するには、をクリックした後、フィールドを変更して [保存] ボタンをクリックします。
- 追加したフィールドを削除するには、をクリックした後、 [確認] ボタンをクリックします。
- スキーマリストの検索ボックスで、フィールド名でフィールドを検索できます。
- 収集したログで新しいフィールドを発見する場合、スキーマにそのフィールドを追加します。追加されたフィールドは基本として
String
タイプを持ちます。データ演算が必要な場合、スキーマに追加されたフィールドを演算に適したタイプに変更する必要があります。 - 20時45分前にフィールドタイプを変更する場合、変更日の翌日に収集されるデータから変更されたタイプが適用されます。その後、フィールドタイプを変更する場合、変更日の2日後に収集されるデータから適用されます。
- スキーマは1日単位で適用されるので、適用前に収集されたデータはタイプが変更されません。
グループ管理
コンソールのグループメニューと連携しているグループ情報を確認できます。
- ほとんどの NELO機能をプロジェクトの基準として提供しますが、 Kibana の ダッシュボード 機能は、グループ単位を使用します。
- 基本グループを設定する方法は、システム設定ご参照ください。
グループ画面
Web Appの 管理 > グループ メニューの基本的な説明は、次の通りです。
領域 | 説明 |
---|---|
① 表示方式 | ウィジェットまたは表で表示 |
② ソート方式 | ソート方式を選択 |
③ 検索ボックス | グループ名を基準にプロジェクトを検索 |
④ グループリスト | 表示方式に応じてウィジェットまたは表でグループを表示
|
グループ詳細情報確認
Web Appの 管理 > グループ メニューで、グループの詳細情報を確認する方法は次の通りです。
- Web Appにアクセスします(Web Appにアクセスを参照)。
- 管理 > グループ メニューをクリックします。
- リスト(ウィジェットまたは表)で確認するグループ名をクリックします。
- 検索とフィルタリング機能を活用してグループを検索できます。
- グループの詳細情報を確認します。
アラーム管理
アラーム機能で特定のLuceneクエリを満たすログの数が一定基準値以上に検出される場合、ユーザーが設定した方法でアラームを転送するように設定できます。
アラーム画面
Web Appの 管理 > アラーム メニューの基本的な説明は、次の通りです。
領域 | 説明 |
---|---|
① 検索 | アラーム検索条件の設定
|
② 緊急性 | 緊急性レベルを基準にアラームをフィルタリング |
③ 最後の状態変化 | 時間範囲を直接入力してアラームをフィルタリング
|
④ プロジェクト | プロジェクトを検索、選択してアラームをフィルタリング |
⑤ 表示方式 | ウィジェットまたは表で表示 |
⑥ アラーム追加 | 新規アラーム追加 |
⑦ ソート方式 | ソート方式を選択 |
⑧ 検索ボックス | アラーム名を基準にアラームを検索 |
⑨ アラームリスト | 表示方式に応じてウィジェットまたは表で表示 |
アラーム詳細情報確認
Web Appの 管理 > アラーム メニューで、アラームの詳細情報を確認する方法は次の通りです。
- Web Appにアクセスします(Web Appにアクセスを参照)。
- 管理 > アラーム メニューをクリックします。
- リスト(ウィジェットまたは表)で確認するアラーム名をクリックし、詳細情報を確認します。
- 検索とフィルタリング機能を活用してプロジェクトを検索できます。
- アラームの詳細情報は、アラーム追加をご参照ください。
- 基本情報 : アラームの作成時に設定したアラームの情報表示
- 条件 : アラームの作成時に設定した当該アラームの条件と説明を表示
- Detail Setting : アラームの作成時に設定した詳細設定オプション
- セッション : セッションデータと状態の表示
- ヒストリー : 当該アラームのジョブ履歴を表示
アラーム追加
Web Appの 管理 > アラーム メニューで、アラームを追加する方法は次の通りです。
- Web Appにアクセスします(Web Appにアクセスを参照)。
- 管理 > アラーム メニューをクリックします。
- [アラーム追加] ボタンをクリックします。
- アラーム追加のポップアップで、アラーム追加情報を入力します。
- 基本情報
- 名前 : 作成するアラーム名を入力
- 緊急性 : 緊急性のレベルを選択
- プロジェクト : アラーム対象プロジェクを選択
- クエリ : アラームを実行するクエリを入力
- 条件
- しきい値 : Window で設定した Range と Every の条件で異常が検知されるしきい値(ログ数)を入力
- >= : 入力したログ数以上の場合に選択
- <= : 入力したログ数以下の場合に選択
- 時間と曜日によってしきい値を変更するには 時間と曜日によってしきい値を変更したいですか?を選択して有効にした後、追加表示された Variable threshold 項目を設定してください。
- Window : Range と Every の条件を入力
- 最終アラーム設定 : 設定した しきい値 と Windo の説明を表示
- しきい値 : Window で設定した Range と Every の条件で異常が検知されるしきい値(ログ数)を入力
- 詳細設定 ( 詳細設定をもっと見る のクリック時)
- グループ化するフィールド : グループ化するフィールドを入力
- グループ化は >= 条件のみサポートします。
- コールバック : コールバック条件を設定
- [+] ボタンをクリックし、コールバック追加のポップアップで設定します。
- Status : コールバック適用の有無を選択
- URL : イベント発生時に呼び出すコールバック URLを入力
- Headers : イベント発生時にコールバック URLで渡すヘッダ名と値の情報を入力
- テンプレート : イベント発生時にコールバック URLで転送するメッセージを JSONタイプで入力(ただし、イベント情報を転送するには ELSA2.0でサポートする変数を使用する必要がある(テンプレート変数一覧表を参照))
- 説明 : 詳細設定の説明を入力
- グループ化するフィールド : グループ化するフィールドを入力
- 基本情報
- [保存] ボタンをクリックします。
- アラームを作成してリストに表示します。
テンプレート変数一覧表
コールバック機能で使用するテンプレート変数は、次の通りです。
一覧表で形式が N/Aと表示された変数は文字列ですが、特定のフォーマットに従うと保証されないので、機械的に解釈するよりはユーザーに見せるための用途でのみ使用する必要があります。また、形式が N/Aである変数の文字列の企画は予告なしに変更されることがあります。
アラームの明細(Specification)関連変数
- 以下は一覧表に羅列された変数値は、ユーザーがアラームルールを更新しない限り一定です。ただし、時間表機能が有効になっている場合
threshold
系列変数は曜日と時刻によって他の値に置き換えられます。 {{summary.template}}
変数はコールバックアラームの JSONテンプレートのみ使用でき、要約分の作成のためのテンプレート処理の場合は無視されます。
変数 | 形式 | 説明 |
---|---|---|
{{id}} | integer | アラームの ID(NELOでこのアラームを指す識別子) |
{{url}} | string(URL) | アラーム詳細ページ URL |
{{name}} | string | アラームの名前 |
{{level}} | integer | アラームの緊急性レベル(urgent level) |
{{description}} | string | アラームに対してユーザーが書いた説明(説明がない場合、空の文字列) |
{{description.html_escaped}} | string | HTMLタグがエスケープされた {{description}} |
{{query}} | string | アラームのLuceneクエリ |
{{url.search}} | string(URL) | {{project.id}} と {{query}} に対して最新ログを確認できる URL |
{{project.id}} | integer | アラームに関するプロジェクトの ID(NELOでプロジェクトを指す識別子) |
{{project.key}} | アラームに関するプロジェクトのプロジェクトキー(projectKey) | |
{{project.name}} | string | アラームに関するプロジェクトの名前 |
{{project.url}} | string(URL) | アラームに関するプロジェクトの詳細ページ URL |
{{range.seconds}} | integer | 検索範囲(単位: 秒) |
{{interval.seconds}} | integer | 検索周期(単位: 秒) |
{{group_by}} | string | グループ化の条件がある場合はグループ化に利用するフィールド名、グループ化の条件がない場合は空の文字列 |
{{threshold.value}} | integer | しきい値(時間表機能によってアラームが無効になった場合-1) |
{{threhsold.operator}} | string(off、le、geの中から1つ) | しきい値の比較条件が「以上」の場合 ge , 「以下」の場合 le .ただし、時間表機能によってアラームが無効になった場合 off |
{{threshold.pretty}} | N/A | {{threshold.operator}} と {{threshold.value}} に関する説明文 |
{{threshold.pretty.range}} | N/A | {{threshold.operator}} 、 {{threshold.value}} 、 {{window.range}} に関する説明文 |
{{summary.template}} | string | ユーザーが要約分のテンプレートを定義した場合、当該テンプレート(そうでない場合は空の文字列) |
アラームの状態(Status)関連変数
{{summary}}
変数はコールバックアラームの JSONテンプレートのみ使用でき、要約分の作成のためのテンプレート処理の場合は無視されます。
変数 | 形式 | 説明 |
---|---|---|
{{status}} | string(firingまたは resolved) | アラームの現在の状態 |
{{status.previous}} | string(firingまたは resolved) | アラームの直前の状態 |
{{status.emoji}} | N/A | アラームの現在の状態と至急性に適した絵文字(emoji)文字列 |
{{status.color}} | string(#で始まる RGBカラーコード) | アラームの現在の状態に適合する色コード |
{{status.since}} | integer(Unixepoch時間、単位: 秒) | アラームが現在の状態をいつ取得したのか知らせる整数) |
{{status.since.pretty}} | N/A | {{status.since}} に対してユーザーが把握しやすい文字列(テンプレートを処理する時を基準にした相対時刻) |
{{summary}} | string | ユーザーが要約分のテンプレートを定義し、- {{status}} が firing の場合は当該テンプレートで作成した要約分、そうでない場合は NELOシステムに組み込まれたルールで作成した要約分 |
{{session.duration}} | integer(単位: 秒) | このアラームに関するセッションの現在の長さ(firing の場合は現在有効化(active)されたセッション、 resolved の場合は無効なセッション) |
{{session.duration.pretty}} | N/A | {{session.duration}} に対して人の分かりやすい説明 |
最新イベントのログ検索結果に関する変数
変数 | 形式 | 説明 |
---|---|---|
{{window.start}} | integer(Unixepoch時間、単位: 秒) | 検索範囲の開始時刻 |
{{window.end}} | integer(Unixepoch時間、単位: 秒) | 検索範囲の末尾の時刻 |
{{window.url}} | string(URL) | 検索画面に移動する URL |
{{window.logs}} | integer | 検索画面内で検出されたログ数 |
{{last_log}} | string(JSON) | 検索画面内にある一番最新ログ(JSON形式) |
{{fields.user}} など fields. で始まる変数 | string | {{last_log}} 内にある特手のフィールド値 |
その他変数
変数 | 形式 | 説明 |
---|---|---|
{{reigon.pretty}} | N/A | NELOインスタンスを表す文字列 |
{{region.host}} | string(domainname) | NELOインスタンスのアドレス |
{{region.url}} | string (URL) | NELOインスタンスの URL |
{{{{ | string | {{ に常に置換 |
}}}} | string | }} に常に置換 |
アラーム変更
Web Appの 管理 > アラーム メニューで、アラームを変更する方法は次の通りです。
- Web Appにアクセスします(Web Appにアクセスを参照)。
- 管理 > アラーム メニューをクリックします。
- リスト(ウィジェットまたは表)で確認するアラーム名をクリックします。
- 検索とフィルタリング機能を活用してプロジェクトを検索できます。
- [編集] ボタンをクリックします。
- 基本情報、条件、詳細設定オプションを変更します。
- 詳細は アラーム追加をご参照ください。
- [保存] ボタンをクリックします。
アラーム削除
Web Appの 管理 > アラーム メニューで、アラームを削除する方法は次の通りです。
アラーム削除時にアラームに保存したすべての内容を削除し、復旧できません。
- Web Appにアクセスします(Web Appにアクセスを参照)。
- 管理 > アラーム メニューをクリックします。
- リスト(ウィジェットまたは表)で確認するアラーム名をクリックします。
- 検索とフィルタリング機能を活用してプロジェクトを検索できます。
- [削除] ボタンをクリックします。
- 削除確認のポップアップで、 [確認] ボタンをクリックします。
- アラームを削除し、リストから消えます。
保存した検索管理
Web Appの 管理 > 保存した検索 メニューで、保存したクエリの確認、追加、変更、削除などを管理できます。
保存した検索画面
Web Appの 管理 > 保存した検索 メニューの基本的な説明は、次の通りです。
領域 | 説明 |
---|---|
① 削除 | リストで選択した検索削除 |
② 検索追加 | 新規検索追加 |
③ 検索ボックス | 件名を基準に件名を検索 |
④ リスト | 保存した検索項目をリストで表示 |
検索追加
Web Appの 管理 > 保存した検索 メニューで、検索を追加する方法は次の通りです。
- Web Appにアクセスします(Web Appにアクセスを参照)。
- 管理 > 保存した検索 メニューをクリックします。
- [検索追加] ボタンをクリックします。
- 検索追加のポップアップで、検索追加情報を入力します。
- データソース : プロジェクトまたはグループ名を検索して選択
- 最近検索したプロジェクトまたはグループがある場合、フィールドをクリックするとそのプロジェクトとグループが自動で表示されます。
- 件名 : 追加する検索件名を入力
- クエリ : 検索するクエリの構文を入力
- 説明 : 検索に関する説明を入力
- データソース : プロジェクトまたはグループ名を検索して選択
- [保存] ボタンをクリックします。
- 検索を作成してリストに表示します。
Web Appの 検索 メニューでログを検索すると、使用したクエリも検索として保存できます。詳細は、検索画面をご参照ください。
検索変更
Web Appの 管理 > 保存した検索 メニューで、保存した検索を変更する方法は次の通りです。
- Web Appにアクセスします(Web Appにアクセスを参照)。
- 管理 > 保存した検索 メニューをクリックします。
- リストで変更する検索の をクリックします。
- 検索情報を変更します。
- 詳細は 検索追加をご参照ください。
- [保存] ボタンをクリックします。
検索削除
Web Appの 管理 > 保存した検索 メニューで、保存した検索を削除する方法は次の通りです。
検索の削除時に検索に保存したすべての内容を削除し、復旧できません。
- Web Appにアクセスします(Web Appにアクセスを参照)。
- 管理 > 保存した検索 メニューをクリックします。
- リストで削除する検索を選択した後、 [削除] ボタンをクリックします。
- また、各検索項目の をクリックします。
- 削除確認のポップアップで、 [確認] ボタンをクリックします。
- 検索を削除し、リストから消えます。
検索実行
Web Appの 管理 > 保存した検索 メニューで、保存した検索でログを検索する方法は次の通りです。
- Web Appにアクセスします(Web Appにアクセスを参照)。
- 管理 > 保存した検索 メニューをクリックします。
- リストでログを検索する検索の をクリックします。
- ログ検索画面に移動します。ログ検索の詳細は、検索をご参照ください。
Kibana > ダッシュボード メニューで保存したクエリは検索 メニューで使用できず、Kibana > ダッシュボード またはKibana > 可視化 メニューで新しいウィジェットの追加時にデータソースとして活用します。詳細は、ダッシュボードをご参照ください。