34. レポートマニュアル

本書は X-MON のレポート生成設定・レポート生成のリファレンスです。

そのため、基本的なOSやGUIの一般的な操作、用語などについては知識をご理解の上でお読みください。

また、X-MONの操作画面はお使いのOSやブラウザによって異なる場合がございます。

34.1. レポートについて

レポートはサービスのログや障害履歴を、指定したレポート期間や対象のサービスに基づいて出力できる機能です。

生成されるレポートは、エクセルファイル(.xlsx形式)として出力します。

レポート画面には「管理者メニュー」 - 「レポート」からアクセスします。

34.1.1. レポート期間の種類

レポートには、指定した期間のみを生成するレポートと、定期的に生成するレポートの2種類があります。

定期レポートは、月次・週次・日次の3つの期間から選択可能です。

34.1.2. レポートで提供されるシートの情報

レポートには、以下の情報が含まれた各種シートが含まれます。

34.1.2.1. レポート情報

レポートの概要を確認できます。

レポート名、発行日時、対象サービスなどを記載します。

34.1.2.2. 稼働率(ホスト)

対象サービスが登録されているホストの稼働率を記載します。

34.1.2.3. 稼働率(サービス)

対象サービスの稼働率を記載します。

34.1.2.4. サービスレポート

対象サービスごとに作成されるシートです。各種ログが記載され、以下の内容が含まれます。

ログの種類	内容
障害対応履歴	サービスで発生した障害、認知済みやダウンタイム情報を記載します。 レポート生成設定で出力の有無を指定できます。
監視設定変更履歴	サービス設定の変更履歴を記載します。
コメント履歴	サービス詳細画面から追加されたコメントを記載します。
イベントログ	サービスのイベントログを記載します。 レポート生成設定で出力の有無を指定できます。

また、グラフ描画が設定されているサービスの場合は、グラフ画像を添付します。

34.1.2.5. メトリックデータ

グラフ描画が行われる対象サービスについて、メトリックデータシートに監視結果を記載します。

メトリックデータの出力は、レポート生成設定で指定できます。

34.2. レポート作成の基本

ここでは、レポートおよび定期レポート設定の作成手順と入力項目について説明します。

レポートの基本入力項目の「基本設定」と「レポートの対象」について説明します。

レポートの出力をカスタマイズする場合は「レポートのカスタマイズ」を確認してください。

34.2.1. レポートの生成設定画面

新規のレポート生成設定画面には、「レポート生成設定」の「新規作成」からアクセスします。

34.2.2. 基本設定

基本設定では、レポート名称やレポート期間を指定します。

項目名	内容
レポート名	レポート生成時のレポート名を指定します。 半角と全角の両方を使用できます。
レポート生成周期	レポートの生成周期を月次・週次・日次・カスタムから選択できます。 レポートの生成のみの場合は「指定した期間のみのレポート生成」、定期生成の場合は「定期レポートの設定」を参照してください。
稼働率の算出からダウンタイム期間を除外する	稼働率シートに記載される情報に、ダウンタイム期間を除外するかどうかを指定します。

34.2.3. レポート対象の選択

レポート対象の選択では、レポートに含めるサービスを指定します。

対象は複数選択可能で、選択できる項目は以下の通りです。

項目	内容
ホストグループ	ホストグループに含まれるホストに登録されているサービスを対象とします。
ホスト	ホストに登録されているサービスを対象とします。
サービスグループ	サービスグループに含まれるサービスを対象とします。
サービス	サービス単体を対象とします。

34.2.4. レポートの生成・設定保存

「基本設定」と「レポート対象の選択」が完了したら、レポート生成設定に必要な情報がそろっているので、生成・保存を行います。

「基本設定」でレポート生成周期を「カスタム」に選択した場合は「レポートの作成」をクリックし、レポートを作成します。「月次・週次・日次」を選択した場合は「設定の保存」をクリックして、定期レポート設定を保存します。

34.3. 指定した期間のみのレポート生成

特定の期間に対応するレポートを出力するための設定を説明します。

指定した期間のみのレポート生成では、障害対応履歴と監視設定変更履歴にコメントを追加できます。 コメントを追加する場合は「レポートのカスタマイズ」を確認してください。

指定した期間のみのレポート生成では、定期レポート設定で利用可能な「レポート生成時のメール通知」は使用できません。

34.3.1. レポート期間の指定方法

レポートを指定した期間で作成したい場合は「基本設定」の「レポート生成周期」をカスタムに変更します。

カスタムに変更することで、開始日時と終了日時の入力項目が表示されます。

開始日時と終了日時を指定することで作成したいレポートの期間を設定できます。

34.4. 定期レポートの設定

定期的にレポートを生成したい場合の設定について説明します。

定期レポートの設定では月次・週次・日次からレポートの生成ができます。

定期レポートでは、障害対応履歴や監視設定変更履歴にコメントを追加することはできません。

定期レポートは毎日深夜2時に生成処理を実行します。定期レポート設定のうち、定期生成が有効になっているものを元にレポートが作成されます。

34.4.1. 基本設定の共通項目

定期レポート設定では、以下の共通設定項目があります。

項目	内容
レポートの定期生成を有効にする	レポートが指定した期間で自動的に生成されるかを指定します。
前回の期間のレポートを作成する	設定を保存する際、前回の期間のレポートを生成するかを指定します。 チェックを入れた場合は、設定保存時に前回の期間のレポートを生成します。 チェックを外した場合は、設定保存時に前回の期間のレポートは作成されず、次回の定期生成タイミングで生成します。

「前回の期間のレポートを生成する」のチェックを外した場合、月初月末を指定した月次レポートであれば、次回の生成タイミングは翌月の1日となり、設定を保存したその月のレポートが生成されます。

34.4.2. 月次レポートの設定

月次レポートは、毎月指定した日付と時刻でレポートを生成します。

「基本設定」の「レポート生成周期」を「月次」に変更します。

月次に変更すると、選択欄が追加されます。選択項目と内容は以下の通りです。

選択項目	内容
月初から月末まで	毎月1日の00:00から月末の23:59までの期間を指定します。
日時を指定する	毎月の開始日時を指定します。

「日時を指定する」を選択すると、開始日時の入力欄が表示されるので、開始日時を入力してください。

開始日時が存在しない月の場合は、その月の月末が自動的に指定されます。また、終了日時が存在しない月の場合は、翌月の月末が自動的に指定されます。

開始日時が存在しない月の例：開始日時を31日の00:00に設定し、2月から集計期間が開始するレポート生成の場合

開始日時	終了日時
2月28日 00:00	3月30 23:59

終了日時が存在しない月の例：開始日時を31日の00:00に設定し、1月から集計期間が開始するレポート生成の場合

開始日時	終了日時
1月31日 00:00	2月28 23:59

34.4.3. 週次レポートの設定

週次レポートは、毎週指定した曜日と時刻でレポートを生成します。

「基本設定」の「レポート生成周期」を「週次」に変更します。

週次に変更すると、曜日と時刻の入力欄が表示されるので、開始したい曜日と時刻を入力してください。

34.4.4. 日次レポートの設定

日次レポートは、毎日指定した時刻でレポートを生成します。

「基本設定」の「レポート生成周期」を「日次」に変更します。

日次に変更すると、時刻の入力欄が表示されるので、開始したい時刻を入力してください。

34.4.5. レポート生成時のメール通知とレポート添付

定期レポートの設定では、レポート生成完了後にユーザーへメール通知ができます。

メール通知を行う場合は、ユーザ管理でユーザーのメールアドレスを設定する必要があります。

「通知設定」の「レポート生成完了通知」では、以下の設定が行えます。

項目	内容
レポートが生成出来たらメールで通知する	レポート生成完了後に指定したユーザーへメール通知するかを指定します。
レポートをメールに添付する	メール通知にレポートを添付するかを指定します。

「通知設定」の「通知先」では、メール通知の送信先を指定できます。選択可能な項目は以下の通りです。

設定項目	内容
ユーザグループ	ユーザグループに含まれているユーザーへメール通知を行います。
ユーザ	指定したユーザーへメール通知を行います。

34.5. レポートのカスタマイズ

レポートに出力されるサービスのグラフやログをカスタマイズできます。

カスタマイズは必須ではありませんが、必要に応じてグラフの描画やログの表示/非表示を変更できます。

34.5.1. グラフのカスタマイズ

サービスレポートシートに記載するグラフのカスタマイズが可能です。

カスタマイズしたグラフ設定は、すべての対象サービスに適用され、個別の指定はできません。

カスタマイズ可能な設定項目は以下の通りです。

設定項目	内容
しきい値を描画する	グラフにサービスのしきい値を描画するかを指定します。
算出値	グラフが長期間にわたる場合、描画のためにメトリックデータを分割し、その分割されたデータを基に算出値を計算して、グラフ描画用のデータとします。 計算時の算出値は平均・最大・最小から指定できます。
下限・上限	グラフのY軸の描画範囲を指定します。 どちらも空欄の場合はグラフごとに自動で描画範囲を設定します。

34.5.1.1. グラフのサンプル確認

カスタマイズしたグラフの表示サンプルを確認できます。

上の画像の赤枠から確認したいサービスを選択し、「サンプルを表示」をクリックすると、カスタマイズしたグラフ画像が表示されます。

また、「すべてのグラフを確認」をクリックすると、選択された対象内からグラフ描画が設定されているサービスのサンプルグラフが簡易的に表示できます。

34.6. ログ・コメント設定

ログ・コメント設定では、サービスレポートシートやメトリックデータに表示するログの出力設定を行います。

レポート生成周期がカスタムの場合、障害対応履歴や監視設定変更履歴にコメントを追加できます。

34.6.1. ログの出力設定

以下のチェックボックスでログの出力を切り替えます。

項目	内容
レポートにメトリックデータを出力する	グラフ描画が行われているサービスのメトリックデータの出力を指定します。
レポートに障害対応履歴を出力する	サービスレポートシートに障害対応履歴を出力するかを指定します。
レポートにイベントログを出力する	サービスレポートシートにイベントログを出力するかを指定します。

ログの出力設定はすべてのレポート対象に適用され、個別のサービスに対しては適用されません。

34.6.2. コメントの追加

コメントの追加は、レポート生成周期がカスタムの場合に設定可能です。

コメントの追加では、障害対応履歴または監視設定変更履歴にコメントを追加できます。

レポート対象で選択されたサービスが一覧表示され、コメントを追加したいサービスをクリックすると「コメントの追加」が表示されます。

ログの右側にあるコメント追加アイコンをクリックして、コメント入力欄を表示し、コメントを入力してください。

入力されたコメントは、「基本設定」の「開始日時」と「終了日時」を変更しない限り保持します。

34.7. レポート・定期レポート設定の管理

34.7.1. レポートの削除とダウンロード

生成されたレポートはレポート一覧に表示されます。

レポート一覧のアクション列から、レポートのダウンロードや削除が可能です。

定期レポート設定から生成されたレポートは、「レポートの保存上限」で設定した上限を超えた場合、古いレポートから順に削除されます。

定期レポート設定から生成されたレポート名をクリックすると、該当する定期レポート設定画面に移動できます。

定期生成が有効なレポートには、定期生成のアイコンが表示されます。

34.7.2. 定期レポート設定の削除・編集・定期生成の有効/無効

保存された定期レポート設定は、レポート生成設定一覧に表示されます。

各定期レポート設定から、設定の削除や編集が可能です。

「全てのレポート(O件)」をクリックすると、該当する定期レポート設定から生成されたレポートの一覧が表示されます。

各定期レポートの詳細は、中央下部のボタンをクリックするか、「詳細をすべて開く」をクリックすることで表示できます。

詳細表示から、定期生成の有効化・無効化ができます。

34.7.3. レポートの保存上限と最大メール添付ファイルサイズ

34.7.3.1. レポートの保存上限

定期レポート設定から生成されるレポートには、保存件数上限を設定できます。

この設定は各定期レポート設定に適用しますが、レポート生成周期を「カスタム」で作成したレポートには適用されません。

34.7.3.2. 最大メール添付ファイルサイズ

定期レポート作成時に送信される通知メールに添付するレポートのファイルサイズを指定できます。

レポートが指定したファイルサイズを超えた場合、通知メールには添付されません。

34.7.3.3. 設定方法

設定は、「管理者メニュー」から「その他設定」 - 「X-MON全体設定」で行います。