レポート

レポートにコンテキスト、つまり特定のホストやサービスのデータでレポートを埋めるためのオプションがいくつかあります。 その結果、意味のある情報を含むレポートを作成するには、さまざまな方法でレポートを呼び出す必要があります。 コンテキスト、つまりレポートに含めるホストやサービスを指定していない場合、正しい出力ではなく、赤で強調表示されたエラーメッセージのみが表示されます。

違いはコンテキストの指定場所です:

ここで、前述のスナップイン「Reporting 」についてもう一度考えてみましょう。 このスナップインを使用すると、事前選択や制限などを行うことなく、レンダリングされたレポートに直接移動します。したがって、ここでは、ビルトインのコンテキストを持つレポートのみ意味があります。 コンテキストが (フィルタリングされた) ビューによってのみ作成されるレポートは、スナップインの「Monitor 」メニューおよび「Hide this report in the monitor menu 」オプションから安全に除外することができます。

以下の機能を使用して、ご自身のレポートを編集することができます。

利用可能なさまざまなオプションについては、次のセクションで説明します。

既存のレポートのコピーではなく、まったく新しいレポートを作成する場合は、手順が少し複雑になります。 例として、サイト上のすべての問題のあるサービス、つまり、WARN 、CRIT 、またはUNKNOWN状態のすべてのサービスの簡単な概要を作成します。 この概要のタイトルは「critical_services」とします。

Reports > Add report から、Edit Reports ページで新しいレポートを作成します。

最初のステップでは、No restrictions to specific objects の選択画面でSelect specific object type のフィルターをそのままで、Continue をクリックして次の選択画面に進みます。

既存のレポートをコピーする場合と同様に、まず「Unique ID 」と「Title 」を指定してください。

Context / Search Filters セクションのService で、Service states を選択し、Add filter をクリックして、希望の状態を設定します。

Save & go to list （レポートを保存）をクリックすると、新しいレポートがレポート概要リストのCustomized （レポート）セクションに追加されます。

このレポートを期待に胸が膨らんで呼び出してみると、結果は期待外れです。 レポートページには、初期レイアウトと見出しはありますが、それ以外は空白です。 上司を感動させるような結果とは程遠いですね...。

では、レポートの内容のデザインを定義する必要があります。 をクリックすると、レポートに含める内容を定義するページが表示されます。 レポートエレメントの選択は 3 段階で行われ、その間に [Continue ] をクリックします。

まず、Add content をクリックします。 この例では、Step 1 でエレメントタイプAvailability table を選択します。Step 2 を「All services 」に、Step 3 を「No restrictions to specific objects 」に設定します。 次のページでは、その他のオプションはそのままにしておきます。 その代わりに、Save を直接クリックします。 レポートのプレビューを表示します。

左側に、critical_services のレポートのプレビューが表示されます。 右側には、レポートのエレメントがリストで表示されます。 これらのエレメントは、編集、コピー、削除、および順序の変更が可能です。

このシンプルな、ご自身で作成したレポートは、必要に応じて追加のエレメントで柔軟にカスタマイズし（以下を参照）、サイドバーなどからいつでも呼び出すことができます。

レポート作成のほぼすべてのステップで、必要に応じてコンテンツを調整することができます。

最初のステップでは、フィルターを設定して、レポートを特定のホストまたはデータソース（ ネットワークインターフェイス、BI アグリゲーション、センサーなど）に制限することができます。

次に、再び「Unique ID 」と「Title 」を入力します。 タイトルには、提供されているマクロ（= テキストモジュール）も使用できます。 次に、レポートをメニューに表示する「Icon 」を選択します。 連絡先グループに「Make this report available for other users 」オプションを設定すると、この例の場合、check-mk-notify 、関連するグループメンバーは、いつでも独自にレポートにアクセスして情報を取得することができます。

Context / Search Filters ボックスでは、通常どおり、特定のホストから個々のDockerコンテナ、Oracle監視の値まで、 幅広いフィルタリングオプションを利用できます。

この例では、ホストの選択は 1 つのフォルダに限定され、さらに指定されたホストの問題に限定されています。 この制限により、特に複雑な環境において、データの取得が高速化されます。

「Save & go to list 」をクリックすると、レポートの概要が表示されます。 次のステップでは、レポートの内容を定義します。

を使用して、レポートの内容に移動します。

Reports > Add content でレポートコンテンツの編集を開きます。 これを使用して、たとえば、テーブル、グラフ、目次、テキスト（マクロや HTTP 経由でも可）をレポートに追加します。 これらのコンテンツは順番に表示されるため、レポートの最終的な長さも決定されます。

Step 1 で、必要なエレメントを選択します。この例では、Multiple graphs を選択します。 これにより、他の設定に応じて、同じタイプのグラフが複数、上下に並べて表示されます。 たとえば、複数のホストの状態を直接比較してマッピングすることができます。

Continue を続行します。 この例では、グラフィックのデータソースとして、ステップ 2 でAll services 、つまりホストで実行されているすべてのサービスを選択します。

[Continue] を続行します。 ステップ 3 では、表示するデータの量を制限することができます。 このオプションは、現在の例では必要ありません。 再び、[Continue] で次の選択に切り替えます。

サンプルレポートでは、[Graph layout] の [Properties ] ボックスで、各グラフに、グラフのタイトル、ホスト名、およびサービス内容で構成されるタイトルを付けることを指定します。 さらに、[Graph time range] で、表示する時間範囲を 4 時間に設定します。 [ ] ボックスで、レポートを特定のホストまたはサービスの特性に制限します。

Context / Search Filters ボックスで、レポートを指定したホストまたはサービスの特性に制限します。 ここでは、この例ではService のCPU utilization を選択します。

Save をクリックすると、最初のレポートエレメントが完成します。

この演習の 2 番目のグラフを作成するには、[Reports > Add content ] から再度開始し、[Step 1 ] で [Metrics graph of a single service] を選択します。 [Continue ] で [Step 2 ] に切り替え、検索フィルターをホスト名とサービス内容に制限します。

Save をクリックすると、2 番目のレポートエレメントも準備完了になります。

3 つ目に作成するエレメントは、現在のアラートの概要です。 手順は同じです。

「Save 」をクリックすると、このレポートエレメントも完成します。

表示を明確にするため、見出しを追加します:

Reports > Add content を開いて、レポートの内容を編集します。Step 1 で、エレメントタイプとしてHeading を選択します。Continue で、Step 2 に切り替えます。 必要に応じて、見出しの階層レベルを指定します。The text に見出しを入力します。

Save をクリックして概要に戻ります。 ただし、新しい見出しはリスト内のグラフィックの下に配置されます。 そのため、コンテンツ項目のリストで、アイコンを使用して見出しをリスト内の目的の位置にドラッグします。

ヒント：プレビューでは、実際のデータの代わりに赤い線やエラーメッセージが表示される場合があります。これは、エディタのレポートにコンテキストが欠落しているためです。 ここでは、たとえば、適切なビューからレポートを呼び出すことでのみ表示されるホストの指定が欠落しています。 使用可能なプレビューを表示したい場合は、その間に、Context / Search Filters 領域のレポート設定で特定のホストをフィルタリングしてください。 これにより、レポートの設計がはるかに容易になります。

レポートの外観を構成するための、水平線、画像、ページフレーム、1 行のテキストなどの補完的なデザインエレメントが用意されています。 これらの構成要素は、レポートのすべてのページまたは特定のページに表示することができます。

このレポートの例では、レポートの周囲にフレームを挿入します。 ここでも、定義は [次へ] をクリックして、1 つずつ順番に行います。 まず、[Reports > Add page element] から始めます。

フレームはすべてのページに表示する必要があるため、次のステップでは変更は不要です：

新しいページフレームが、左側のプレビューと右側の静的ページエレメントテーブルの両方の概要に表示されます。

ヒント:Checkmk で利用可能なマクロ(= テキストモジュール) を使用して、ページ番号とレポート名を含む別のフッターを作成することもできます。 これを行うには、ページエレメント「One line of text 」を選択し、2 番目のステップで、ページの下部の位置と、必要なマクロを含むテキストを指定します。

レポートは、会社のロゴを追加するなど、外観の品質を向上させることで、より魅力的なものになります。

Reports > Edit properties でレポート設定を開きます。

2 番目のボックスに、Report Properties があります。 ここで、フォント、ページフォーマット、日時設定、レポートのレイアウト、ダウンロード用のファイル名などの値を設定します。

会社のロゴを「~/local/share/check_mk/reporting/images/ 」ディレクトリにコピーし、「logo_mk.png 」ファイルとして保存します。 これ以降、このロゴはすべてのレポートに表示されます。

注：現在、既存のレポートテンプレートをニーズに合わせてカスタマイズしています。 あるいは、会社の仕様（CI/CD など）に合わせて、まったく新しいレポートテンプレートを作成することもできます。

Scheduled reports > Add schedule を使用して新しいスケジュールを開き、レポートを選択して、Continue をクリックします。

General Options ボックスで、タイトル、作成時間、レポート期間などの基本設定を指定します。

[Context / Search Filters ] には、選択したレポートに応じて、通常のフィルタオプションが表示されます。 スケジュールを保存して、スケジュールされたレポートのリストに戻ります。

リストには、レポートが最後に生成/送信された日時、エラーの有無、 次回生成/送信される日時、およびその他の情報 (ここでは少し省略して表示) も表示されます。

リストのエントリは、エントリの先頭にある 5 つのアイコンを使用して管理します。

注：送信済みのレポートはサイトには保存されません。

レポートを送信する代わりに、ローカルに保存することもできます。 これを行うには、[Action - Store locally] を選択します。

次に、ファイル名と、必要に応じてレポートのタイトルを指定します。 レポートのヒストリーを作成できるように、Checkmk では、レポートを新しく作成するたびに以前のレポートを上書きする代わりに、さまざまなマクロ（= テキストモジュール）を用意しています。

ローカルに保存されたすべてのレポートの概要は、[Edit Reports ] ウィンドウの [Reports > Stored reports ] メニュー項目からアクセスできます。

コンテンツエレメントは、レポートの編集中に [Reports > Add content ] を選択するとリスト表示されます。

ページエレメントは、レポートの編集中に [Reports > Add page element ] を選択するとリスト表示されます。