インスタンスの状態を監視および分析しやすいように、AEM ではデフォルトのレポートが提供されており、個々の要件に合わせて設定できます。
レポートはすべてツールコンソールからアクセスできます。左側のウィンドウで「レポート」を選択し、右側のウィンドウで必要なレポートをダブルクリックして、表示用や設定用に開きます。
レポートの新しいインスタンスも、ツールコンソールから作成できます。左側のウィンドウで「レポート」を選択し、ツールバーから「新規」を選択します。「タイトル」と「名前」を定義し、必要なレポートタイプを選択して、「作成」をクリックします。新しいレポートインスタンスがリストに表示されます。これをダブルクリックして開き、サイドキックからコンポーネントをドラッグして最初の列を作成し、レポートの定義を開始します。
標準で用意されている AEM のレポートに加えて、独自の(まったく新しい)レポートを開発できます。
様々な書式のレポートを使用できます。次のレポートはすべて、以下の節の説明に従ってカスタマイズできる列を使用します。
以下のレポートにはそれぞれ、独自の書式とカスタマイズがあります。
したがって、列の設定に関する以下の手順は該当しません。詳しくは、個々のレポートの説明を参照してください。
標準レポートでもカスタマイズしたレポートでも、列の追加や再配置、削除が可能です。
サイドキックの「コンポーネント」タブ(レポートページで使用可能)に、列として選択可能なデータのすべてのカテゴリがリストされています。
データの選択を変更するには:
新しい列を追加するには、必要なコンポーネントをサイドキックからドラッグして、必要な場所にドロップします。
列を移動するには、ヘッダーをクリックし、マウスボタンを押したまま新しい場所までドラッグします。
列を削除するには、列のタイトルをクリックし、マウスボタンを押したまま上のレポートヘッダー領域までドラッグします(赤のマイナス記号は位置が有効でないことを示します)。マウスボタンを放すと、列を本当に削除するかどうかの確認を要求するコンポーネントを削除ダイアログが表示されます。
レポート内の列にはそれぞれドロップダウンメニューがあります。これは、列のタイトルセル上にマウスカーソルを移動すると表示されます。
タイトルセルの右端に矢印が表示されます(タイトルテキストのすぐ右側にある、現在の並べ替えメカニズムを示す矢印と混同しないでください)。
メニューで使用可能なオプションは、列の設定(プロジェクト開発時におこなったもの)によって異なり、無効なオプションはグレー表示されます。
データは、特定の列に従って、以下のいずれかの方法で並べ替えできます。
適切な列で、列のドロップダウンメニューから「この列でグループ化」を選択できます。これにより、対象の列内のそれぞれの値に従ってデータがグループ化されます。グループ化する列は複数選択できます。列内のデータが不適切な場合は、このオプションがグレーアウトされます。各エントリがまったく別個のものであり、一意である場合は、グループを形成できません。例えば、ユーザーレポートの「ユーザー ID」列などがこれに該当します。
少なくとも 1 つの列がグループ化されたら、現在のデータの円グラフがこのグループ化に基づいて生成されます。複数の列がグループ化される場合は、そのことがグラフにも示されます。
円グラフの上にカーソルを移動すると、該当するセグメントの集計値が表示されます。ここでは、数、最小、平均など、列に関して現在定義されている集計が使用されます。
該当する列では、列のドロップダウンメニューから、フィルター設定や集計も設定できます。
フィルター設定では、表示するエントリの条件を指定できます。使用可能な演算子は次のとおりです。
contains
equals
フィルターを設定するには:
フィルターをアクティベート解除するには:
集計方法(選択している列によって異なる)も選択できます。
このオプションは、ユーザーレポートで汎用列が使用されたことがある場合にのみ使用できます。
時間の経過に伴うデータの変化のチャートを、履歴データで確認できます。これは、一定間隔で作成されたスナップショットから得られます。
データは次のように処理されます。
レポートは次の手順で生成できます。
必要な列でグループ化を設定します。
設定を編集して、スナップショット作成の頻度(時間単位または日単位)を定義します。
終了… スナップショットのコレクションを開始する定義。
左上の赤/緑のスライダ・ボタンは、スナップショットが収集されるタイミングを示します。
結果のチャートが右下に表示されます。
データ収集が開始されたら、以下を選択できます。
期間
表示するレポートデータの開始日と終了日を選択できます。
間隔
月、週、日、時間を選択して、レポートの規模と集計を行うことができます。
例えば、2011年2月に日別スナップショットが使用可能な場合:
Day
に設定した場合、各スナップショットはグラフに1つの値として表示されます。Month
に設定した場合、2月のすべてのスナップショットは1つの値に集計されます(グラフには1つの「ドット」として表示されます)。要件を選択し、「設定」をクリックしてレポートに適用します。スナップショットがさらに作成された後に表示を更新するには、「設定」を再度クリックします。
スナップショットを収集中に、以下の処理が可能です。
完了を使用…を再度呼び出して、コレクションを再初期化します。
レポートの構造を 「フリーズ」する(レポートに割り当てられ、グループ化、並べ替え、フィルタリングなどが行われる列)開始がスナップショットを作成
編集ダイアログを開き、「データスナップショットなし」を選択して、必要な時間までコレクションを終了します。
[ 編集のみ]:スナップショットの取り込みのオン/オフを切り替えます。スナップショットの作成が再び有効になった場合は、最後に完了したレポートの状態が使用され、さらにスナップショットを作成できます。
スナップショットは/var/reports/...
に保存されます。パスの残りの部分は、レポートの終了時に作成された各レポートのパスとIDを反映しています。
今後必要ないと確信できる場合は、古いスナップショットを手動でパージできます。
事前設定済みのレポートは、パフォーマンスを集中的に消費するわけではありませんが、実稼働環境では毎日のスナップショットを使用することをお勧めします。 可能であれば、Webサイトにあまりアクティビティがない時間帯に毎日のスナップショットを実行します。これは、Day CQレポート設定のDaily snapshots (repconf.hourofday)
パラメーターを使用して定義できます。この設定方法の詳細は、OSGI設定を参照してください。
履歴データレポートは、設定可能な制限により、選択した期間の結果数に従って、外観が少々変わる場合もあります。
水平方向の線はそれぞれシリーズと呼ばれ(チャート凡例の各エントリに対応)、垂直方向のドットの列はそれぞれ集計されたスナップショットを表します。
チャートをより長期間にわたってクリーンに保つために、設定可能な制限があります。標準レポートの場合の制限は次のとおりです。
水平方向のシリーズ - デフォルトも、システムの最大値も 9
垂直方向の集計スナップショット - デフォルトは 35
(水平方向のシリーズ 1 つあたり)
該当する制限を超えた場合は、
カスタマイズされたレポートでは、すべてのシリーズの合計値も表示できます。これはシリーズ(水平方向の線および凡例のエントリ)として表示されます。
カスタマイズされたレポートの場合は、別の方法で制限を設定できます。
「編集」ボタンをクリックすると、レポートを編集ダイアログが開きます。
これは、履歴データのスナップショットを収集する期間を定義する場所の 1 つですが、その他様々な設定も定義できます。
タイトル
独自のタイトルを定義できます。
説明
独自の説明を定義できます。
ルートパス (特定のレポートに対してのみアクティブ)
レポートをリポジトリの(サブ)セクションに制限する場合に使用します。
レポート処理
データを自動的に更新
レポートデータは、レポート定義を更新するたびに更新されます。
データを手動で更新
このオプションは、大量のデータがある場合の自動更新操作による遅延を防ぐために使用できます。
これを選択した場合、レポート設定の一部が変更された場合にレポートデータを手動で更新する必要があります。 また、設定の一部を変更するとすぐに、レポート表が非表示になります。
このオプションを選択すると、「データを読み込み」ボタンが表示されます(レポートの「編集」の横)。 データを読み込む と、データが読み込まれ、表示されているレポートデータが更新されます。
スナップショット
スナップショットの作成頻度として、日単位、時間単位、まったく作成しない、のいずれかを定義できます。
「データを読み込み」ボタンは、「編集」で「データを手動で更新」を選択している場合にのみ表示されます。
「データを読み込み」をクリックすると、データが再読み込みされ、レポートの表示が更新されます。
データを手動で更新することを選択すると、
レポート設定を変更するとすぐに、レポートデータの表が非表示になります。
例えば、列の並べ替え方法を変更した場合、データは表示されません。
レポートデータを再度表示するには、「データを読み込み」をクリックしてデータを再読み込みする必要があります。
レポートを完了すると、
このダイアログで、生成されるレポートの独自のタイトルおよび説明を定義または更新できます。
コンポーネントのレポートは、Web サイトでのコンポーネントの使用方法に関する情報を提供します。
次の内容に関する情報の列があります。
これはつまり、以下のような情報を確認できるということです。
どのコンポーネントがどこで使用されるか。
例えば、テスト時に役立ちます。
特定のコンポーネントのインスタンスの分散方法。
これは、特定のページ(「ヘビーページ」など)でパフォーマンスの問題が発生している。
サイトの中で、変更が頻繁におこなわれる部分とそうでない部分を特定。
時間の経過に伴ってページコンテンツがどのように発展するかを確認。
コンポーネントはすべて組み込み型で、製品の標準であり、プロジェクト専用です。編集ダイアログを使用すると、ユーザーはレポートの開始点を定義するルートパスも設定できます。そのルートの下のすべてのコンポーネントがレポート用に考慮されます。
ディスク使用量レポートは、リポジトリ内に格納されているデータに関する情報を表示します。
レポートはリポジトリのルート(/)で始まります。特定のブランチをクリックすると、リポジトリ内をドリルダウンできます(現在のパスがレポートタイトルに反映されます)。
このレポートは、現在のリクエストログを分析します。
<cq-installation-dir>/crx-quickstart/logs/request.log
を使用すると、特定の期間内で最も高価なリクエストを特定できます。
レポートを生成するには、以下を指定できます。
期間(時間)
分析する時間数(過去)。
デフォルト: 24
max. 結果
出力行の最大数。
デフォルト: 50
最大リクエスト
分析する要求の最大数。
デフォルト:-1
(all)
電子メールアドレス
結果を電子メールアドレスに送信します。
オプション;デフォルト:空白
毎日(hh:mm)に実行
レポートを毎日自動的に実行する時間を指定します。
オプション;デフォルト:空白
ページアクティビティレポートは、ページおよびそこで実行されたアクションをリストします。
次の内容に関する情報の列があります。
これはつまり、以下を監視できるということです。
ページアクティビティレポートは、監査ログからすべての情報を取得します。デフォルトでは、ルートパスは/var/audit/com.day.cq.wcm.core.page
の監査ログに設定されます。
このレポートは、コンポーネント、評価、フォーラムなど、ユーザーが生成したコンテンツに関する情報を提供します。
次の内容に関する情報の列があります。
次のことが可能です。
このレポートは、アカウントやプロファイルを登録済みのすべてのユーザーに関する情報を提供します。これには組織内の作成者と外部訪問者の両方が含まれます。
次の内容に関する情報の列(適宜)があります。
次のことが可能です。
汎用列は、ユーザーレポート内で、通常はユーザープロファイルからカスタマイズされた情報にアクセスするために使用できます。例えば、「プロファイル定義へのフィールドの追加」で説明されている「好きな色」などです。
汎用列ダイアログは、次のいずれかの操作で開きます。
「定義」タブから、以下を定義できます。
タイトル
汎用列の独自のタイトル。
プロパティ
リポジトリに格納されるプロパティ名(通常はユーザーのプロファイル内)。
パス
通常、プロパティはprofile
から取得されます。
型
String
、Number
、Integer
、Date
からフィールドタイプを選択します。
デフォルト集計
これは、少なくとも1つの列がグループ化されたレポートで列のグループが解除された場合にデフォルトで使用される集計を定義します。 Count
、Minimum
、Average
、Maximum
、Sum
から必要な集計を選択します。
例えば、String
フィールドのカウントは、集計状態の列に個別のString
値の数が表示されることを意味します。
「拡張」タブでは、使用可能な集計およびフィルターも定義できます。
実行中と完了済みの両方のワークフローの個々のインスタンスに関する情報を提供することにより、簡潔な概要を提供します。
次の内容に関する情報の列があります。
これはつまり、次のことが可能ということです。
現在のインスタンスで実行されているワークフローに関する重要な統計を提供します。
特定の要件に合わせてレポートの設定を完了したら、レポートをアクティベートして、設定をパブリッシュ環境に転送できます。
パブリッシュ環境用に履歴データが必要な場合は、オーサー環境でレポートを完了してからページをアクティベートします。
該当するレポートは次の場所でアクセス可能になります。
/etc/reports
例えば、ユーザー生成コンテンツレポートは次の場所で見つかります。
http://localhost:4503/etc/reports/ugcreport.html
これは今後、パブリッシュ環境から収集されたデータに関するレポートとなります。
パブリッシュ環境ではレポートの設定はできないので、「編集」ボタンと「完了」ボタンは使用できません。ただし、スナップショットが収集されている場合は、履歴データレポート用に「期間」と「間隔」を選択できます。
これらのレポートへのアクセスはセキュリティ上の問題となる場合があります。したがって、/etc/reports
を外部訪問者が使用できないようにディスパッチャーを設定することをお勧めします。 詳しくは、セキュリティチェックリストを参照してください。
必要な権限はアクションによって異なります。
標準の AEM インストールでは、レポートごとに以下の権限がプリセットされています。
ユーザーレポート
user administrators
— 読み取りと書き込み
ページアクティビティレポート
contributors
— 読み取りと書き込み
コンポーネントのレポート
contributors
— 読み取りと書き込み
ユーザー生成コンテンツレポート
contributors
— 読み取りと書き込み
ワークフローインスタンスレポート
workflow-users
— 読み取りと書き込み
administrators
グループのメンバーは全員が、新しいレポートの作成に必要な権限を持っています。