AEM インスタンスの監視および保守

AEM インスタンスがデプロイされた後は、操作、パフォーマンス、統合性を監視および保守するために、一定の作業が必要になります。

ここで重要なのは、潜在的な問題を認識するために、通常の状態におけるシステムの外観や動作を知っておく必要があるということです。最善の方法は、システムを一定期間にわたって監視し、情報を収集することです。

チェック項目 検討事項 注釈/アクション
バックアップ計画 インスタンスのバックアップ方法を参照してください。
障害回復計画 各社の障害回復ガイドライン。
問題を報告するためのエラー追跡システムが利用可能であること 例えば、bugzillajira、その他多数のうちいずれか。
ファイルシステムが監視されていること ディスクの空き容量が不十分な場合、CRX リポジトリは「フリーズ」します。容量が利用可能になると再開します。 空き容量が少なくなると、「*ERROR* LowDiskSpaceBlocker」メッセージがログファイルに表示されます。
ログファイルが監視されていること
システム監視がバックグラウンドで(一貫して)実行されていること CPU、メモリ、ディスクおよびネットワークの使用状況を含みます。例えば、iostat、vmstat、perfmon を使用します。 ログに記録されたデータを可視化して、パフォーマンス問題の追跡に使用できます。生のデータにもアクセスできます。
AEM パフォーマンスが監視されていること トラフィックレベルを監視する要求カウンターを含みます。 重大な、または長期にわたるパフォーマンスの損失が見られる場合は、詳細な調査をする必要があります。
レプリケーションエージェントを監視していること。
ワークフローインスタンスを定期的にパージすること リポジトリのサイズとワークフローのパフォーマンス。 ワークフローインスタンスの定期的なパージを参照してください。

バックアップ

以下のバックアップを取っておくことをお勧めします。

  • ソフトウェアインストール - 設定を大幅に変更した前後
  • リポジトリ内に保持されているコンテンツ - 定期的に

企業で決められているバックアップポリシーがある場合は、それに従う必要があります。何をいつバックアップするかについては、次の点も考慮してください。

  • システムおよびデータの重要度。
  • ソフトウェアまたはデータの変更の頻度。
  • データのボリューム。バックアップの実施に必要な時間と同様に、容量も問題になる場合があります。
  • ユーザーがオンライン中にバックアップを実施できるかどうか。可能な場合は、パフォーマンスへの影響。
  • ユーザーの地理的分布。つまり、バックアップに最適な(影響が最小限に抑えられる)時間帯。
  • 障害回復ポリシー。バックアップデータの格納場所(オフサイト、特定のメディア、など)に関するガイドラインがあるかどうか。

一般的には、完全バックアップを一定の間隔(例:1 日ごと、週ごと、月ごと)でおこない、その合間に増分バックアップをおこないます(例:1 時間ごと、1 日ごと、週ごと)。

注意

実稼動インスタンスのバックアップを実装するときは、バックアップを正常に復元できることを確認するために、テストをおこなう必要があります。

そうしないと、最悪の場合、バックアップが無駄になる可能性があります。

メモ

バックアップのパフォーマンスについて詳しくは、バックアップのパフォーマンスを参照してください。

ソフトウェアインストールのバックアップ

インストール後または設定を大幅に変更した後に、ソフトウェアインストールのバックアップを取ります。

これをおこなうには、リポジトリ全体をバックアップする必要があります。その後、以下の手順を実行します。

  1. AEM を停止します。
  2. ファイルシステムから <cq-installation-dir> 全体をバックアップします。
注意

サードパーティ製のアプリケーションサーバーを使用している場合は、追加のフォルダーが別の場所に存在し、そのフォルダーのバックアップも必要になることがあります。アプリケーションサーバーのインストールについて詳しくは、アプリケーションサーバーと共に AEM をインストールする方法を参照してください。

注意

ファイルデータストアの増分バックアップがサポートされています。その他のコンポーネント(Lucene インデックスなど)の増分バックアップを使用する場合は、削除済みのファイルがバックアップでも削除済みとマークされることを確認してください。

メモ

ディスクミラーリングも、バックアップメカニズムとして使用できます。

リポジトリのバックアップ

CRX ドキュメントのバックアップと復元に、CRX リポジトリのバックアップに関連するすべての問題が掲載されています。

オンラインの「ホット」バックアップの作成について詳しくは、オンラインバックアップの作成を参照してください。

バージョンのパージ

バージョンのパージ​ツールは、リポジトリ内のノードまたはノードの階層のバージョンをパージします。このツールの主な目的は、古いバージョンのノードを削除して、リポジトリのサイズを削減することです。

ここでは、AEM のバージョン管理機能に関連するメンテナンス操作について説明します。バージョンのパージ​ツールは、リポジトリ内のノードまたはノードの階層のバージョンをパージします。このツールの主な目的は、古いバージョンのノードを削除して、リポジトリのサイズを削減することです。

概要

この バージョンをパージ このツールは、週次メンテナンスタスクとして使用できます。 を初めて使用する場合は、その前に追加して設定する必要があります。 その後は、リクエストに応じて、または週単位で実行できます。

Web サイトのバージョンのパージ

Web サイトのバージョンをパージするには、次の手順を実行します。

  1. 次に移動: ツール コンソール​を選択します。 操作, メンテナンス​を、 週別メンテナンスウィンドウ.

  2. 選択 +追加 をクリックします。

    バージョンのパージを追加

  3. 選択 バージョンのパージ 」を選択します。 新規タスクの追加 ダイアログ。 次に、 保存.

    バージョンのパージを追加

  4. この バージョンのパージ タスクが追加されます。 カードアクションを使用して、次のことを実行できます。

    • 選択 — 上部のツールバーに追加のアクションが表示されます
    • 実行 — 設定したパージを直ちに実行します。
    • 設定 — 週別パージタスクを設定します

    バージョンのパージアクション

  5. を選択します。 設定 Web コンソールを開くアクション Day CQ WCM バージョンのパージタスク​を使用して、次の項目を設定できます。

    バージョンのパージ設定

    • パスをパージ
      パージするコンテンツの開始パスを設定します。例:
      /content/wknd

      注意

      Web サイトごとに複数のパスを定義することを強くお勧めします。

      子が多すぎるパスを定義すると、パージの実行に必要な時間が大幅に長くなる場合があります。

    • バージョンを再帰的にパージ

      • パスで定義されたノードのみをパージする場合は、選択を解除します。
      • パスとその子孫で定義されたノードをパージする場合に選択します。
    • バージョンの最大数
      保持するバージョンの最大数(各ノードの)を設定します。 この設定を使用しない場合は、空のままにします。

    • バージョンの最小数
      保持するバージョンの最小数(各ノードの)を設定します。 この設定を使用しない場合は、空のままにします。

    • 最大バージョン期間
      保持するバージョンの最大期間を日数で設定します(各ノードに対して)。 この設定を使用しない場合は、空のままにします。
      次に、 保存.

  6. に移動または戻る 週別メンテナンスウィンドウ ウィンドウと選択 実行 をクリックして、プロセスを直ちに起動します。

注意

クラシック UI ダイアログを使用して、 ドライラン 設定の内容:

  • http://localhost:4502/etc/versioning/purge.html

パージされたノードを元に戻すには、リポジトリを復元するしかありません。設定は自己管理する必要があるので、パージの前に必ずドライランを実行することをお勧めします。

ドライラン — コンソールの分析

クラシック UI には、 ドライラン オプション:

  • http://localhost:4502/etc/versioning/purge.html

処理されたすべてのノードがリストされます。 この処理の間、ノードのステータスは次のいずれかになります。

  • ignore (not versionnable):ノードはバージョン管理をサポートしないので、処理中は無視されます。

  • ignore (no version):ノードにバージョンが含まれていないので、処理中は無視されます。

  • retained:ノードはパージされません。

  • purged:ノードはパージされます。

さらに、コンソールでは、バージョンに関して次のような有益な情報が提供されます。

  • V 1.0:バージョン番号。

  • V 1.0.1*:星は、バージョンが現在の(基本)バージョンであり、パージできないことを示します。

  • Thu Mar 15 2012 08:37:32 GMT+0100:バージョンの日付。

例を以下に示します。

  • Shirts のバージョンは、バージョンの期間が 2 日間を超えているので、パージされます。
  • Tonga Fashions! のバージョンは、バージョンの数が 5 を超えているので、パージされます。

global_version_screenshot

監査記録とログファイルの使用

Adobe Experience Manager(AEM)に関連する監査記録とログファイルは、様々な場所にあります。以下では、どこに何があるかについて、概要を説明します。

ログの使用

AEM WCM では詳細なログを記録します。クイックスタートを展開して起動すると、次の場所にログが見つかります。

  • <cq-installation-dir>/crx-quickstart/logs/

  • <cq-installation-dir>/crx-quickstart/repository/

ログファイルのローテーション

ログファイルのローテーションとは、定期的に新しいファイルを作成することによってファイルサイズの拡大を制限するプロセスのことです。AEM では、error.log というログファイルが、以下のルールに従って 1 日 1 回ローテーションされます。

  • error.log ファイルは、{original_filename} .yyyy-MM-dd というパターンに従って名前が変更されます。例えば、2010年7月11日時点であれば、現在のログファイルの名前は error.log-2010-07-10 に変更され、新しい error.og が作成されます。

  • 以前のログファイルは削除されないので、古いログファイルを定期的にクリーンアップして、ディスクの使用量を制限する必要があります。

メモ

AEM をアップグレードする場合は、AEM でこれ以上使用されない既存のログファイルがディスク上に残ることに注意してください。これらは削除しても問題ありません。新しいログエントリはすべて、新しいログファイルに書き込まれます。

ログファイルの検索

様々なログファイルが、AEM をインストールしたファイルサーバー上に保持されます。

  • <cq-installation-dir>/crx-quickstart/logs

    • access.log
      AEM WCM およびリポジトリに対するアクセス要求はすべてここに登録されます。

    • audit.log
      モデレートアクションはここに登録されます。

    • error.log
      エラーメッセージ(様々な深刻度レベル)はここに登録されます。

    • ImageServer-<PortId>-yyyy>-<mm>-<dd>.log
      このログは、Dynamic Media が有効になっている場合にのみ使用されます。内部の ImageServer プロセスの動作を分析するための統計情報と分析情報を提供します。

    • request.log
      各アクセス要求が、応答と共にここに登録されます。

    • s7access-<yyyy>-<mm>-<dd>.log
      このログは、Dynamic Media が有効になっている場合にのみ使用されます。s7access ログには、/is/image および /is/content 経由で Dynamic Media に対して実行された各リクエストが記録されます。

    • stderr.log
      起動時に生成される様々な深刻度レベルのエラーメッセージを保持します。デフォルトでは、ログレベルの設定は次のようになっています。
      WarningWARN

    • stdout.log
      起動時のイベントを示すログメッセージを保持します。

    • upgrade.log
      すべてのアップグレード操作のログを提供します。アップグレード操作が実行されるのは、
      com.day.compat.codeupgrade および com.adobe.cq.upgradesexecutor の各パッケージです。

  • <cq-installation-dir>/crx-quickstart/repository

    • revision.log
      リビジョンジャーナル処理の情報。
メモ

ImageServer ログと s7access ログは、system/console/status-Bundlelist ページから生成される「すべてダウンロード」パッケージには含まれません。サポート目的で、Dynamic Media の問題がある場合は、カスタマーサポートに連絡する際に ImageServer と s7access のログも添付してください。

デバッグログレベルのアクティベート

デフォルトのログレベル(Apache Sling Logging Configuration)は情報(INFO)なので、デバッグメッセージはログに記録されません。

ロガーのデバッグログレベルをアクティブにするには、リポジトリでプロパティ org.apache.sling.commons.log.level をデバッグに設定します。例えば、/libs/sling/config/org.apache.sling.commons.log.LogManagerglobal Apache Sling Logging を設定します。

注意

デバッグログレベルのログを、不必要に長く残さないでください。多くのログエントリが生成され、リソースが消費されます。

デバッグファイルの行は、通常は DEBUG で始まり、その後にログレベル、インストーラーのアクション、ログメッセージが示されます。次に例を示します。

DEBUG 3 WebApp Panel: WebApp successfully deployed

ログレベルは次のとおりです。

0 重大なエラー アクションが失敗し、インストーラーの処理を続行できません。
1 エラー アクションが失敗しました。インストールは続行しますが、AEM WCM の一部が正常にインストールされなかったので、機能しません。
2 警告 アクションは成功しましたが、問題が発生しました。AEM WCM は正常に機能する場合と機能しない場合があります。
3 情報 アクションが成功しました。

カスタムログファイルの作成

メモ

Adobe Experience Manager を操作しているときは、このようなサービスの設定を管理する方法がいくつかあります。詳細および推奨事項については、OSGi の設定を参照してください。

状況によっては、別のログレベルでカスタムログファイルを作成する必要があります。これをおこなうには、リポジトリで次の手順を実行します。

  1. 既存のものがない場合は、新しい設定フォルダー(sling:Folder)を、プロジェクト(/apps/<project-name>/config)用に作成します。

  2. /apps/<project-name>/config の下に、新しい Apache Sling Logging Logger Configuration 用のノードを作成します。

    • 名前:org.apache.sling.commons.log.LogManager.factory.config-<identifier>(ロガーの場合)

      <identifier> の部分は、インスタンスを識別するフリーテキストに置き換えます(この情報は省略できません)。

      例:org.apache.sling.commons.log.LogManager.factory.config-MINE

    • 型:sling:OsgiConfig

    メモ

    技術的に必須ではありませんが、<identifier> は一意にすることをお勧めします。

  3. このノードで次のプロパティを設定します。

    • 名前:org.apache.sling.commons.log.file

      タイプ:String

      値:ログファイルを指定します。例:logs/myLogFile.log

    • 名前:org.apache.sling.commons.log.names

      タイプ:文字列[] (文字列 + 複数)

      値:ロガーによってメッセージをログに記録する OSGi サービスを指定します。例えば、以下すべてを指定します。

      • org.apache.sling
      • org.apache.felix
      • com.day
    • 名前:org.apache.sling.commons.log.level

      タイプ:String

      値:必要なログレベル(debuginfowarnerror のいずれか)例: debug

    • 必要に応じてその他のパラメーターを設定します。

      • 名前:org.apache.sling.commons.log.pattern

        型:String

        値:必要に応じてログメッセージのパターンを指定します。次に例を示します。

        {0,date,dd.MM.yyyy HH:mm:ss.SSS} *{4}* [{2}] {3} {5}

    メモ

    org.apache.sling.commons.log.pattern では、最大 6 個の引数がサポートされています。

    {0} タイプ java.util.Date のタイムスタンプ

    {1} ログマーカー

    {2} 現在のスレッドの名前

    {3} ロガーの名前

    {4} ログレベル

    {5} ログメッセージ

    ログ呼び出しに Throwable が含まれている場合は、スタックトレースがメッセージに付加されます。

    注意

    org.apache.sling.commons.log.names には値が必要です。

    メモ

    ログライターのパスは、crx-quickstart の場所と相対的です。

    したがって、ログファイルが

    logs/thelog.log

    と指定されている場合、書き込み先は以下となります。

    <cq-installation-dir>/crx-quickstart/logs/thelog.log.

    また、ログファイルが

    ../logs/thelog.log

    と指定されている場合、書き込み先は以下のディレクトリとなります。

    <cq-installation-dir>/logs/
    (例:<cq-installation-dir>/crx-quickstart/ の次)

  4. この手順は、新しいライターが必要な場合(つまり、デフォルトのライターとは異なる設定の場合)にのみ必要です。

    注意

    新しい Logging Writer Configuration は、既存のデフォルトが適切でない場合にのみ必要です。

    明示的なライターが設定されていない場合は、デフォルトに基づいて暗黙のライターが自動的に生成されます。

    /apps/<project-name>/config の下に、新しい Apache Sling Logging Writer Configuration 用のノードを作成します。

    • 名前:org.apache.sling.commons.log.LogManager.factory.writer-<identifier>(Writer の場合)

      Logger の場合のように、<identifier> の部分は、インスタンスを識別するフリーテキストに置き換えます(この情報は省略できません)。例:org.apache.sling.commons.log.LogManager.factory.writer-MINE

    • 型:sling:OsgiConfig

    メモ

    技術的に必須ではありませんが、<identifier> は一意にすることをお勧めします。

    このノードで次のプロパティを設定します。

    • 名前:org.apache.sling.commons.log.file

      型:String

      値:Logger で指定したファイルと一致するようにログファイルを指定します。

      この例の場合は ../logs/myLogFile.log です。

    • 必要に応じてその他のパラメーターを設定します。

      • 名前:org.apache.sling.commons.log.file.number

        型:Long

        値:保持するログファイルの数を指定します。例えば、5 とします。

      • 名前:org.apache.sling.commons.log.file.size

        型:String

        値:ファイルのローテーションをサイズや日付によって制御するために、必要に応じて指定します。例えば、'.'yyyy-MM-dd とします。

    メモ

    org.apache.sling.commons.log.file.size は、次のいずれかを設定することによって、ログファイルのローテーションを制御します。

    • 最大ファイルサイズ
    • 時刻/日付のスケジュール

    これにより、新しいファイルを作成する(また、名前のパターンに従って既存のファイルを名前変更する)条件を示します。

    • サイズの制限は数値で指定できます。サイズインジケーターが指定されていない場合、これはバイト数と見なされます。または、サイズインジケーターの 1 つ(KBMBGB のいずれか)を追加できます(大文字と小文字は区別されません)。
    • 日時スケジュールは、java.util.SimpleDateFormat パターンとして指定できます。これは、ファイルがローテーションされるまでの期間と、ローテーションされたファイルに追加されるサフィックス(識別用)を定義します。

    デフォルトは「.」です。yyyy-MM-dd(毎日のログローテーションの場合)

    例えば、2010年1月20日午前 0 時(またはこの後の最初のログメッセージが正確になった場合)に、…/logs/error.log は …/logs/error.log.2010-01-20 に名前が変更されます。1月21日のログは、次の日の変更時にロールオーバーされるまで、…/logs/error.log(新しく空のもの)に出力されます。

    '.'yyyy-MM 毎月の初めにローテーション。
    '.'yyyy-ww 毎週最初の日(ロケールによって異なる)にローテーション。
    '.'yyyy-MM-dd 毎日深夜 12 時にローテーション。
    '.'yyyy-MM-dd-a 毎日深夜 12 時および正午にローテーション。
    '.'yyyy-MM-dd-HH 毎正時にローテーション。
    '.'yyyy-MM-dd-HH-mm 毎分の初めにローテーション。

    メモ:日時を指定する場合:

    1. 一重引用符(' ')の範囲内で、リテラルテキストを「エスケープ」する必要があります。

      これは、特定の文字がパターン文字として解釈されるのを防ぐためです。

    2. オプションの任意の場所で、有効なファイル名に使用できる文字のみを使用します。

  5. 任意のツールで新しいログファイルを読み取ります。

    この例で作成されるログファイルは ../crx-quickstart/logs/myLogFile.log となります。

Felix コンソールでは、../system/console/slinglog の Sling Log Support に関する情報も提供されます。例えば、https://localhost:4502/system/console/slinglog. です。

監査記録の検索

監査記録は、いつ、誰が、何をしたかの記録を提供するために保持されます。AEM WCM と OSGi の両方のイベントに関して、様々な監査記録が生成されます。

ページオーサリング時に表示される AEM WCM の監査記録

  1. ページを開きます。

  2. サイドキックから、ロックアイコンを含むタブを選択できます。次に、「監査ログ」をダブルクリックします。

  3. 新しいウィンドウが開き、現在のページの監査記録のリストが表示されます。

    screen_shot_2012-02-02at43601pm

  4. ウィンドウを閉じるには、「OK」をクリックします。

リポジトリ内の AEM WCM 監査記録

/var/audit フォルダー内で、監査レコードは、リソースに応じて保持されます。個々のレコードとそのレコードに含まれる情報が表示されるまでドリルダウンできます。

これらのエントリに保持されている情報は、ページ編集時に表示される情報と同じです。

Web コンソールの OSGi 監査記録

OSGi イベントで生成される監査記録は、AEM Web コンソールの「設定ステータス」タブ/「ログファイル」タブから確認できます。

screen_shot_2012-02-13at50346pm

レプリケーションエージェントの監視

レプリケーションキューを監視すると、キューのダウンまたはブロックを検出できます。このような場合、パブリッシュインスタンスまたは外部システムに問題がある可能性があります。

  • 必要なキューがすべて有効になっていますか。

  • 無効なキューの中に、まだ必要なものがありますか。

  • enabled(有効な状態)のキューはすべて、ステータスが idle または active であり、これは正常な動作を示します。キューを blocked(ブロック状態)にしてはいけません。ブロックされている場合、多くは受信者側に問題があります。

  • 時間の経過と共にキューのサイズが大きくなる場合は、キューがブロックされている可能性があります。

レプリケーションエージェントを監視するには:

  1. AEM の「ツール」タブにアクセスします。

  2. レプリケーション」をクリックします。

  3. 適切な環境のエージェントへのリンクをダブルクリックします(左右いずれかのウィンドウ)。例えば、「オーサーのエージェント」などです。

    ウィンドウが開き、オーサー環境のすべてのレプリケーションエージェントの概要が、それぞれのターゲットとステータスを含めて表示されます。

  4. 適切なエージェント名(リンク)をクリックして、そのエージェントの詳細情報を表示します。

    chlimage_1

    ここでは、以下のことができます。

    • エージェントが有効かどうかを確認。

    • レプリケーションのターゲットを確認。

    • レプリケーションキューが現在アクティブ(有効)かどうかを確認。

    • キュー内に項目が含まれているかどうかを確認。

    • 更新​または​消去​して、キューエントリの表示を更新。これは、キューに出入りする項目の確認に役立ちます。

    • ログを表示​して、レプリケーションエージェントによるアクションのログにアクセス。

    • ターゲットインスタンスへの​接続をテスト

    • 必要に応じて、任意のキュー項目で​強制的に再試行

    注意

    パブリッシュインスタンスのリバースレプリケーションアウトボックスには、「接続をテスト」リンクは使用しないでください。

    アウトボックスクエリ用にレプリケーションテストが実行されると、リバースレプリケーションのたびに、テストレプリケーションより古い項目がすべて再処理されます。

    そのような項目がキュー内に既に存在する場合は、次の XPath JCR クエリを使用して検索し、削除する必要があります。

    /jcr:root/var/replication/outbox//*[@cq:repActionType='TEST']

ここでも、すべてのレプリケーションエージェント(/etc/replication/author または /etc/replication/publish の下)を検出して、エージェントのステータス(enableddisabled)および基になるキューのステータス(activeidleblocked)を確認するソリューションを開発できます。

パフォーマンスの監視

パフォーマンスの最適化は、開発時に注目を集めるインタラクティブなプロセスです。デプロイメント後、通常は特定の間隔またはイベントの後でレビューされます。

最適化のための情報収集に使用する方法は、継続中の監視にも使用できます。

メモ

具体的なパフォーマンス向上のための設定も確認できます。

以下のリストは、よく発生するパフォーマンス上の問題と、それぞれの見分け方および対策を示しています。

領域 現象 容量を増やす方法 ボリュームを減らす方法
クライアント クライアントの CPU 使用率が高い。 より高性能のクライアント CPU をインストール。 (HTML)レイアウトを簡素化。
サーバーの CPU 使用率が低い。 より高速なブラウザーにアップグレード。 クライアント側のキャッシュを改善。
高速のクライアントと低速のクライアントがある。
サーバー
ネットワーク サーバーとクライアントの両方で CPU 使用率が低い。 ネットワークのボトルネックを除去。 クライアントキャッシュの設定を改善/最適化。
サーバーのローカルでの参照が(比較的)高速。 ネットワーク帯域幅を増加。 Web ページの「重さ」を軽減(例:画像を減らす、HTML を最適化する)。
Web サーバー Web サーバー上の CPU 使用率が高い。 Web サーバーをクラスター化。 ページごとのヒット数(訪問数)を減らす。
ハードウェアのロードバランサーを使用。
アプリケーション サーバーの CPU 使用率が高い。 AEM インスタンスをクラスター化します。 CPU およびメモリが集中的に使用されている箇所を検索して除去(コードレビュー、タイミング出力などを使用)。
メモリ消費率が高い。 すべてのレベルでキャッシュを改善。
応答時間が遅い。 テンプレートおよびコンポーネント(構造、ロジックなど)を最適化。
リポジトリ
キャッシュ

パフォーマンス問題は、接続速度の一時的低下、CPU の負荷、その他の、Web サイトとは何ら関係のない多くの問題から生じる場合があります。

また、訪問者全員に影響する問題もあれば、一部のみに影響する問題もあります。

この情報をすべて入手し、分類および分析して初めて、一般的なパフォーマンスを最適化したり、特定の問題を解決したりできます。

  • パフォーマンス問題が発生する前の対応:

    • できる限り多くの情報を収集し、正常な状態のシステムに関する十分な実用的知識を構築します。
  • パフォーマンス問題が発生した場合の対応:

    • 1 つ(または 2 つ以上を推奨)の標準的な Web ブラウザー、通常のパフォーマンスが良好であることがわかっている別のクライアント、またはサーバー自体(可能であれば)で、問題を再現します。

    • 適切な時間内に(システムに関連する)何かが変更されたかどうかと、いずれかの変更がパフォーマンスに影響した可能性があるかどうかを確認します。

    • 次の点を確認します。

      • 問題が発生するのは特定の時間のみかどうか。
      • 問題が発生するのは特定のページのみかどうか。
      • その他の要求に影響があるかどうか。
    • できる限り多くの情報を収集し、正常な状態のシステムに関する知識と比較します。

パフォーマンスの監視および分析のツール

パフォーマンスの監視および分析に使用できるツールの一部について、以下で簡単に概要を説明します。

この中には、オペレーティングシステムに依存するものもあります。

ツール 分析対象 使用法/詳細
request.log 応答時間および並行性 request.log の解釈
truss/strace ページの読み込み

システムの呼び出しおよびシグナルをトレースする Unix/Linux コマンド。ログレベルを INFO に上げます。

要求ごとのページの読み込み数、どのページか、などを分析します。

スレッドダンプ JVM スレッドを監視。競合、ロック、長時間の実行を識別。

オペレーティングシステムによって異なります。
- Unix/Linux:kill -QUIT <pid>
- Windows(コンソールモード):Ctrl キーを押しながら Break キーをクリック

TDA などの分析ツールも使用できます。

ヒープダンプ パフォーマンス低下の原因となるメモリ不足の問題。

AEM に対する Java 呼び出しに、
-XX:+HeapDumpOnOutOfMemoryError
」オプションを追加します。

詳しくは、 JVM のトラブルシューティングページのオプション/フラグ.

システム呼び出し タイミングの問題を識別。

System.currentTimeMillis() または com.day.util に対する呼び出し。タイミングはコードから、または HTML コメント経由でタイムスタンプを生成するために使用します。

注意: これらを実装するのは、必要に応じてアクティベート/アクティベート解除できるようにするためです。システムが問題なく動作しているときは、統計を収集するオーバーヘッドは不要です。

Apache Bench メモリリークを識別し、応答時間を選択分析。

基本的な使用法は次のとおりです。

ab -k -n <requests> -c <concurrency> <url>

詳しくは、Apache Bench および ab man ページを参照してください。

Search Analysis 検索クエリーをオフラインで実行し、クエリーの応答時間を特定して、結果セットをテストおよび確認します。
JMeter 読み込みおよび機能テスト。 https://jmeter.apache.org/
JProfiler CPU およびメモリの詳細なプロファイリング。 https://www.ej-technologies.com/
Java Flight Recorder Java Flight Recorder(JFR) は、実行中の Java アプリケーションに関する診断データとプロファイルデータを収集するためのツールです。 https://docs.oracle.com/javase/8/docs/technotes/guides/troubleshoot/tooldescr004.html#BABJJEEE
JConsole JVM の指標およびスレッドを監視。

使用法:jconsole

jconsole および JConsole を使用したパフォーマンスの監視 を参照してください。

注意: JDK 1.8 では、Top や TDA(Thread Dump Analyzer)などのプラグインを使用して JConsole を拡張できます。

Java VisualVM JVM の指標、スレッド、メモリおよびプロファイリングを監視。

使用方法:visualvm または visualvm

詳しくは、 visualvm および (J)VisualVM を使用したパフォーマンスの監視.

注意: JDK 1.8 では、プラグインを使用して VisualVM を拡張できます。VisualVM は JDK 9 以降で廃止されます。 代わりに、Java Flight Recorder を使用してください。

truss/strace、lsof 詳細なカーネル呼び出しおよびプロセス分析(Unix)。 Unix/Linux コマンド。
タイミングの統計 ページレンダリングのタイミングの統計を確認。

ページレンダリングのタイミングの統計を確認するには、Ctrl と Shift キーを押しながら U キーをクリックし、URL で設定されている ?debugClientLibs=true と共に使用します。

CPU およびメモリプロファイリングツール
開発中に低速の要求を分析する際に使用 例えば、YourKit などです。または Java Flight Recorder.
情報収集 インストールの進行中のステータス。 インストールについてできる限り知っておくことは、パフォーマンスの変化の原因や、変化が正当かどうかを追跡する上でも役立ちます。これらの指標を一定の間隔で収集し、重大な変化を簡単に確認できるようにする必要があります。

request.log の解釈

このファイルには、AEM に対するあらゆるリクエストに関する基本情報が登録されています。このことから、貴重な結論を引き出すことができます。

request.log は、リクエストにかかる時間を確認するための組み込みの方法を提供します。開発目的では、request.logtail -f して、応答時間の遅延を監視することが有用です。より大きな request.log を分析するには、応答時間の並べ替えおよびフィルタリングが可能な rlog.jar の使用を推奨します

「遅い」ページを request.log から分離してから、パフォーマンスを向上させるために個別に調整することをお勧めします。これは、通常、コンポーネントごとのパフォーマンス指標を含めるか、 [yourkit](https://www.yourkit.com/) のようなパフォーマンスプロファイルツールを使用して行います。

Web サイトでのトラフィックの監視

request.log は、実行される各要求を、応答と共に登録します。

09:43:41 [66] -> GET /author/y.html HTTP/1.1
09:43:41 [66] <- 200 text/html 797ms

特定の期間(例:様々な 24 時間以上)のすべてのGETエントリを合計することで、Web サイトの平均トラフィックに関する情報を提供できます。

request.log での応答時間の監視

パフォーマンス分析は、request.log から始めることをお勧めします。

<cq-installation-dir>/crx-quickstart/logs/request.log

ログは次のようになっています(簡潔にするために、各行を短縮しています)。

31/Mar/2009:11:32:57 +0200 [379] -> GET /path/x HTTP/1.1
31/Mar/2009:11:32:57 +0200 [379] <- 200 text/html 33ms
31/Mar/2009:11:33:17 +0200 [380] -> GET /path/y HTTP/1.1
31/Mar/2009:11:33:17 +0200 [380] <- 200 application/json 39ms

このログには、要求または応答ごとに 1 行ずつの構成になっています。

  • 要求または応答がおこなわれた日付。

  • 要求の番号(角括弧内)。この番号は、要求と応答で一致しています。

  • 矢印は、要求(右向き矢印)か応答(左向き矢印)かを示しています。

  • 要求の行には、以下が含まれます。

    • メソッド(通常は GET、HEAD または POST)
    • 要求されたページ
    • プロトコル
  • 応答の行には、以下が含まれます。

    • ステータスコード (200 は「成功」を表し、404 は「ページが見つかりません」を表します。
    • MIME タイプ
    • 応答時間

サイズの小さいスクリプトを使用して、ログファイルから必要な情報を抽出し、必要な統計を取ることができます。これらの統計から、どのページ、またはどんなタイプのページが低速か、全体的なパフォーマンスが十分かどうかを確認できます。

request.log での検索応答時間の監視

検索要求は常にログファイルに登録されます。

31/Mar/2009:11:35:34 +0200 [338] -> GET /author/playground/en/tools/search.html?query=dilbert&size=5&dispenc=utf-8 HTTP/1.1
31/Mar/2009:11:35:34 +0200 [338] <- 200 text/html 1562ms

したがって、上記のように、スクリプトを使用して関連する情報を抽出し、統計を取ることができます。

ただし、応答時間を確認したら、その要求になぜそれだけの時間がかかっているのか、応答を改善するために何ができるかに関する分析が必要になる場合があります。

現在のユーザーの数と影響の監視

ここでも、request.log を使用して、並行性およびそれに対するシステムの反応を監視できます。

テストを実施して、悪影響なくシステムが処理できる同時ユーザーの数を特定する必要があります。ここでも、スクリプトを使用してログファイルから結果を抽出できます。

  • 特定の期間(1 分間など)内におこなわれる要求の数を監視します。
  • 特定の数のユーザー全員がほぼ同時に同じ要求をおこなった場合の影響をテストします(例えば、30 人のユーザーが同時に「保存」をクリックするなど)。
31/Mar/2009:11:45:29 +0200 [333] -> GET /author/libs/Personalize/content/statics.close.gif HTTP/1.1
31/Mar/2009:11:45:29 +0200 [334] -> GET /author/libs/Personalize/content/statics.detach.gif HTTP/1.1
31/Mar/2009:11:45:30 +0200 [335] -> GET /author/libs/CFC/content/imgs/logo.rZMNURccynWcTpCxyuBNiTCoiBMmw000.default.gif HTTP/1.1
31/Mar/2009:11:45:32 +0200 [335] <- 304 text/html 0ms
31/Mar/2009:11:45:33 +0200 [334] <- 200 image/gif 31ms
31/Mar/2009:11:45:38 +0200 [333] <- 200 image/gif 31ms
31/Mar/2009:11:45:42 +0200 [336] -> GET /author/libs/CFC/content/imgs/logo.rZMNURccynWcTZRXunQbbQtvuuCMbRRBuWXz0000.default.gif HTTP/1.1
31/Mar/2009:11:45:43 +0200 [337] -> GET /author/titlebar_bg.gif HTTP/1.1
31/Mar/2009:11:45:43 +0200 [336] <- 304 text/html 0ms
31/Mar/2009:11:45:44 +0200 [337] <- 304 text/html 0ms

rlog.jar を使用した所要時間の長い要求の検索

AEM には、次の場所に様々なヘルパーツールが含まれています。
<cq-installation-dir>/crx-quickstart/opt/helpers

その 1 つ、rlog.jar を使用すると、request.log を短時間で分類し、所要時間を基準として、最長から最短の順序で要求を表示できます。

次のコマンドは、考えられる引数を示しています。

$java -jar rlog.jar
Request Log Analyzer Version 21584 Copyright 2005 Day Management AG
Usage:
  java -jar rlog.jar [options] <filename>
Options:
  -h               Prints this usage.
  -n <maxResults>  Limits output to <maxResults> lines.
  -m <maxRequests> Limits input to <maxRequest> requests.
  -xdev            Exclude POST request to CRXDE.

例えば、request.log ファイルをパラメーターとして指定してコマンドを実行し、所要時間が長いほうから 10 個の要求を表示することができます。

$ java -jar ../opt/helpers/rlog.jar -n 10 request.log
*Info * Parsed 464 requests.
*Info * Time for parsing: 22ms
*Info * Time for sorting: 2ms
*Info * Total Memory: 1mb
*Info * Free Memory: 1mb
*Info * Used Memory: 0mb
------------------------------------------------------
     18051ms 31/Mar/2009:11:15:34 +0200 200 GET /content/geometrixx/en/company.html text/ html
      2198ms 31/Mar/2009:11:15:20 +0200 200 GET /libs/cq/widgets.js application/x-javascript
      1981ms 31/Mar/2009:11:15:11 +0200 200 GET /libs/wcm/content/welcome.html text/html
      1973ms 31/Mar/2009:11:15:52 +0200 200 GET /content/campaigns/geometrixx.teasers..html text/html
      1883ms 31/Mar/2009:11:15:20 +0200 200 GET /libs/security/cq-security.js application/x-javascript
      1876ms 31/Mar/2009:11:15:20 +0200 200 GET /libs/tagging/widgets.js application/x-javascript
      1869ms 31/Mar/2009:11:15:20 +0200 200 GET /libs/tagging/widgets/themes/default.js application/x-javascript
      1729ms 30/Mar/2009:16:45:56 +0200 200 GET /libs/wcm/content/welcome.html text/html; charset=utf-8
      1510ms 31/Mar/2009:11:15:34 +0200 200 GET /bin/wcm/contentfinder/asset/view.json/ content/dam?_dc=1238490934657&query=&mimeType=image&_charset_=utf-8 application/json
      1462ms 30/Mar/2009:17:23:08 +0200 200 GET /libs/wcm/content/welcome.html text/html; charset=utf-8

大容量のデータサンプルに関してこの処理をおこなう必要がある場合は、個々の request.log ファイルを連結する必要があります。

Apache Bench

特殊なケース(ガベージコレクションなど)の影響を最小限にするために、apachebench(詳細なドキュメントについては ab などを参照)などのツールを使用してメモリリークを特定し、応答時間を選択分析することをお勧めします。

Apache Bench は次の方法で使用できます。

$ ab -c 5 -k -n 1000 "https://localhost:4503/content/geometrixx/en/company.html"
This is ApacheBench, Version 2.3 <$Revision: 655654 $>
Copyright 1996 Adam Twiss, Zeus Technology Ltd, https://www.zeustech.net/
Licensed to The Apache Software Foundation, https://www.apache.org/

Benchmarking localhost (be patient)
Completed 100 requests
Completed 200 requests
Completed 300 requests
Completed 400 requests
Completed 500 requests
Completed 600 requests
Completed 700 requests
Completed 800 requests
Completed 900 requests
Completed 1000 requests
Finished 1000 requests

Server Software: Day-Servlet-Engine/4.1.52
Server Hostname: localhost
Server Port: 4503

Document Path: /content/geometrixx/en/company.html
Document Length: 24127 bytes

Concurrency Level: 5
Time taken for tests: 69.766 seconds
Complete requests: 1000
Failed requests: 998
(Connect: 0, Receive: 0, Length: 998, Exceptions: 0)
Write errors: 0
Keep-Alive requests: 0
Total transferred: 24160923 bytes
HTML transferred: 24010923 bytes
Requests per second: 14.33 /sec (mean)
Time per request: 348.828 [ms] (mean)
Time per request: 69.766 [ms] (mean, across all concurrent requests)
Transfer rate: 338.20 [Kbytes/sec] received

Connection Times (ms)
min mean[+/-sd] median max
Connect: 0 1 3.9 0 58
Processing: 138 347 568.5 282 8106
Waiting: 137 344 568.1 281 8106
Total: 139 348 568.4 283 8106

Percentage of the requests served within a certain time (ms)
50% 283
66% 323
75% 356
80% 374
90% 439
95% 512
98% 1047
99% 1132
100% 8106 (longest request)

上記の数字は、デフォルトの AEM インストールに含まれている、geometrixx の会社ページにアクセスする標準の MAcBook Pro ラップトップ(2010 年半ば)から取得されたものです。このページは非常に単純ですが、パフォーマンスが最適化されていません。

apachebench は、すべての同時リクエストの平均として、リクエストあたりの時間も表示します。Time per request: 54.595 [ms](すべての同時リクエストの平均)を参照してください。同時実行パラメーター -c の値(一度に実行する複数リクエストの数)を変更して、影響を確認できます。

要求カウンター

要求トラフィックに関する情報(特定の期間の要求数)により、インスタンスの負荷の目安がわかります。この情報は request.log から抽出できますが、カウンターを使用すると、データ収集を自動化し、以下の情報を確認できます。

  • アクティビティの大きな相違点(「多数の要求」と「少ないアクティビティ」を区別)
  • インスタンスが使用されていない時間帯
  • 再起動(カウンターが 0 にリセット)があるかどうか

情報収集を自動化するには、RequestFilter をインストールして、要求がおこなわれるたびにカウンターの数値を増やすこともできます。複数のカウンターを様々な期間に使用できます。

収集された情報を使用して、以下の内容を示すことができます。

  • アクティビティの大きな変化
  • 冗長なインスタンス
  • 再起動(カウンターが 0 にリセット)があるかどうか

HTML コメント

サーバーのパフォーマンスのために、すべてのプロジェクトに html comments を含めることをお勧めします。多くの優れた公開事例を見ることができます。ページを選択し、表示するページソースを開いて、下までスクロールすると、次のようなコードを表示できます。

</body>
 </html>
        <!--
        Page took 58 milliseconds to be rendered by server
         -->

JConsole を使用したパフォーマンスの監視

ツールコマンド jconsole を、JDK で使用できます。

  1. AEM インスタンスを起動します。

  2. 実行 jconsole.

  3. AEM インスタンスを選択して「接続」をクリックします。

  4. Local アプリケーション内から、com.day.crx.quickstart.Main をダブルクリックします。「概要」がデフォルトで表示されます。

    chlimage_1-1

    この後、他のオプションを選択できます。

(J)VisualVM を使用したパフォーマンスの監視

JDK 6-8 の場合、tool コマンド visualvm が使用可能です。 JDK をインストールすると、次の操作を実行できます。

  1. AEM インスタンスを起動します。

    メモ

    Java 5 を使用している場合、JVM を起動する java コマンドラインに -Dcom.sun.management.jmxremote 引数を追加できます。JMX は、Java 6 ではデフォルトで有効になっています。

  2. 次のいずれかを実行します。

    • jvisualvm:JDK 1.6 bin フォルダー内(テスト済みバージョン)
    • visualvmVisualVM からダウンロードできます(最先端バージョン)
  3. Local アプリケーション内から、com.day.crx.quickstart.Main をダブルクリックします。「概要」がデフォルトで表示されます。

    chlimage_1-2

    この後、「監視」など、他のオプションを選択できます。

    chlimage_1-3

このツールを使用すると、スレッドダンプおよびメモリヘッドダンプを生成できます。これは、テクニカルサポートチームから要求されることの多い情報です。

情報収集

インストールについてできる限り知っておくことは、パフォーマンスの変化の原因や、変化が正当かどうかを追跡する上で役立ちます。これらの指標を一定の間隔で収集し、重大な変化を簡単に確認できるようにする必要があります。

有益な情報を以下に示します。

システムで作業をしている作成者の数

インストール以降にシステムを使用した作成者の数を確認するには、次のコマンドラインを使用します。

cd <cq-installation-dir>/crx-quickstart/logs
cut -d " " -f 3 access.log | sort -u | wc -l

特定の日付に作業をしている作成者の数を確認するには、以下を使用します。

grep "<date>" access.log | cut -d " " -f 3 | sort -u | wc -l

1 日あたりのページアクティベーションの平均数

サーバーのインストール以降のページアクティベーションの合計数を確認するには、リポジトリクエリを使用します。CRXDE のツール/クエリで、次のように指定します。

  • XPath

  • パス /

  • クエリ //element(*, cq:AuditEvent)[@cq:type='Activate']

その後、インストール以降の経過日数を計算し、平均を計算します。

このシステムで現在保守しているページ数

現在サーバー上にあるページの数を確認するには、リポジトリクエリを使用します。CRXDE のツール/クエリで、次のように指定します。

  • XPath

  • パス /

  • クエリ //element(*, cq:Page)

MSM を使用する場合は、1 ヶ月あたりのロールアウトの平均数

インストール以降のロールアウトの合計数を特定するには、リポジトリクエリを使用します。CRXDE のツール/クエリで、次のように指定します。

  • XPath

  • パス /

  • クエリ //element(*, cq:AuditEvent)[@cq:type='PageRolledOut']

インストール以降の経過月数を計算し、平均を計算します。

1 ヶ月あたりのライブコピーの平均数

インストール以降におこなわれたライブコピーの合計数を特定するには、リポジトリクエリを使用します。CRXDE のツール/クエリで、次のように指定します。

  • XPath

  • パス /

  • クエリ //element(*, cq:LiveSyncConfig)

ここでも、インストール以降の経過月数を使用して、平均を計算します。

AEM Assets を使用する場合は、Assets で現在保守しているアセットの数

現在保守している DAM アセットの数を確認するには、リポジトリクエリを使用します。CRXDE のツール/クエリで、次のように指定します。

  • XPath
  • パス /
  • クエリ /jcr:root/content/dam//element(*, dam:Asset)

アセットの平均サイズ

/var/dam フォルダーの合計サイズを特定するには:

  1. WebDAV を使用して、 リポジトリをローカルファイルシステムにマップします。

  2. 次のコマンドラインを使用します。

    cd /Volumes/localhost/var
    du -sh dam/
    

    平均サイズを取得するには、グローバルサイズを、/var/dam 内のアセットの合計数(上記で得られた値)で割ります。

現在使用されているテンプレートの数

現在サーバー上にあるテンプレートの数を確認するには、リポジトリクエリを使用します。CRXDE のツール/クエリで、次のように指定します。

  • XPath
  • パス /
  • クエリ //element(*, cq:Template)

現在使用されているコンポーネントの数

現在サーバー上にあるコンポーネントの数を確認するには、リポジトリクエリを使用します。CRXDE のツール/クエリで、次のように指定します。

  • XPath
  • パス /
  • クエリ //element(*, cq:Component)

ピーク時のオーサーシステムの 1 時間あたりの要求数

ピーク時のオーサーシステムの 1 時間あたりの要求数を特定するには:

  1. インストール以降の要求の合計数を特定するには、次のコマンドラインを使用します。

    cd <cq-installation-dir>/crx-quickstart/logs
    grep -R "\->" request.log | wc -l
    
  2. 開始日と終了日を特定するには、以下を使用します。

    vim request.log
    G / 1G: for the last/first lines
    

    これらの値を使用して、インストール以降の経過時間数、さらに 1 時間あたりの要求の平均数を計算します。

ピーク時のパブリッシュシステムの 1 時間あたりの要求数

パブリッシュインスタンスで上記の手順を繰り返します。

具体的なシナリオの分析

以下は、特定のパフォーマンス問題が発生しはじめた場合にチェックするべきことの提案リストです。リストは(残念ながら)完全に網羅的ではありません。

CPU 使用率が 100 %

システムの CPU が常に 100 %で動作している場合は、以下を参照してください。

メモリ不足

このようなエラーは開発およびテストの段階で検出されるべきですが、特定のシナリオが見落とされる可能性もあります。

システムがメモリ不足になっている場合、パフォーマンスの低下や、次のサブテキストを含むエラーメッセージなど、様々な方法で確認できます。

java.lang.OutOfMemoryError

このような場合は、以下をチェックします。

ディスク I/O

システムがディスク容量不足になっている場合や、ディスクスラッシングが始まっていることに気付いた場合は、以下を参照してください。

通常のパフォーマンス低下

リブートのたびにインスタンスのパフォーマンスの低下が確認される場合(場合によって 1 週間後またはそれ以降)は、以下を確認できます。

JVM のチューニング

Java 仮想マシン(JVM)のチューニング機能は大幅に改善されています(特に Java 7 以降)。したがって、ある程度の固定の JVM サイズを指定し、デフォルトを使用すれば、たいていの場合に対応できます。

デフォルト設定が適切でない場合は、GC パフォーマンスを監視および査定する方法を確立してから JVM のチューニングを試みることが重要です。これには、ヒープサイズ、アルゴリズム、その他の局面を含む要因の監視が必要になる場合があります。

一般的な選択肢は以下のとおりです。

  • VerboseGC:

    -verbose:gc \
     -Xloggc:$LOGS/verbosegc.log \
     -XX:+PrintGCDetails \
     -XX:+PrintGCDateStamps
    

結果のログは、次のような GC 可視化機能によって取り込み可能です。

[https://www.ibm.com/developerworks/library/j-ibmtools2/](https://www.ibm.com/developerworks/library/j-ibmtools2/)

JConsole の場合は以下のとおりです。

  • これらの設定は、「広く開放された」JMX 接続用です。

    -Dcom.sun.management.jmxremote \
     -Dcom.sun.management.jmxremote.port=8889 \
     -Dcom.sun.management.jmxremote.authenticate=false \
     -Dcom.sun.management.jmxremote.ssl=false
    
  • 次に、JConsole を使用して JVM に接続します。次を参照してください。
    [https://docs.oracle.com/javase/8/docs/technotes/guides/management/jconsole.html](https://docs.oracle.com/javase/8/docs/technotes/guides/management/jconsole.html)

これは、使用中のメモリ量、使用されている GC アルゴリズム、アルゴリズムの実行にかかる時間、アプリケーションのパフォーマンスへの影響を確認するうえで役立ちます。これがないと、チューニングは「ノブをランダムに回している」だけになります。

メモ

Oracle の VM に関しては、以下にも情報があります。

https://docs.oracle.com/javase/8/docs/technotes/guides/vm/server-class.html

このページ