リビジョンクリーンアップ

TarMK の永続性形式が AEM 6.5 で変更されます。これらの変更には、事前の移行手順は必要ありません。既存のリポジトリは、周期的な移行を実行します。これはユーザーに対して透過的です。AEM 6.5（または関連ツール）がリポジトリに初めてアクセスすると、移行プロセスが開始されます。

AEM 6.5 永続性形式への移行が開始されると、リポジトリを以前の AEM 6.3 永続性形式に戻すことはできなくなります。

AEM 6.3 で、特にオンラインでのリビジョンクリーンアップのパフォーマンスと効果を高めるために、ストレージ形式の変更が必要となりました。これらの変更は後方互換性がなく、古い Oak セグメント（AEM 6.2 以前）で作成されたリポジトリは移行する必要があります。

ストレージ形式を変更するその他メリットは次のとおりです。

• スケーラビリティの向上（セグメントサイズの最適化）
• データストアのガベージの収集の迅速化
  
• 将来の機能強化に向けた基盤整備

オフラインでのリビジョンクリーンアップでは、最新の 2 世代のオンラインでのリビジョンクリーンアップと比較して、最新以外のすべての世代が再利用されます。新しいリポジトリの場合、オンラインでのリビジョンクリーンアップでは、オフラインでのリビジョンクリーンアップ後に初めて実行されたとき、再利用できるほど古い世代がないので、スペースを再利用できません。

この章の「オフラインでのリビジョンクリーンアップの実行後にオンラインでのリビジョンクリーンアップを実行した場合」の節も参照してください。

オンラインでのリビジョンクリーンアップは、AEM 6.3 以降のリリースでのみ使用できます。また、古いバージョンの AEM を使用している場合は、新しい Oak Segment Tar に移行する必要があります。

• リポジトリのサイズ
• システムへの負荷（リクエスト/分、特に書き込み操作）
• アクティビティパターン（読み取りと書き込み）
• ハードウェアの仕様（CPU パフォーマンス、メモリ、IOPS）

オンラインでのリビジョンクリーンアップ中、ディスク領域は継続的に監視されます。使用可能なディスク領域が臨界値を下回った場合、プロセスはキャンセルされます。臨界値とは、リポジトリのその時点でのディスクフットプリントの 25%であり、変更はできません。

最初に予測したリポジトリサイズよりも少なくとも 2 倍または 3 倍大きなディスクサイズにすることをお勧めします。

クリーンアッププロセス中、空きヒープ領域が継続的に監視されます。空きヒープ領域が臨界値を下回った場合、プロセスはキャンセルされます。臨界値は、org.apache.jackrabbit.oak.segment.SegmentNodeStoreService#MEMORY_THRESHOLD を使用して設定します。デフォルト値は 15% です。

最小コンパクションヒープサイズ設定の推奨事項は、AEM のメモリサイズ設定の推奨事項と切り離されていません。原則として、AEM インスタンスが、ユースケースとそこで予測されるペイロードに対応するのに十分なサイズの場合、クリーンアッププロセスは十分なメモリを取得します。

• クリーンアップが毎日実行されていることを確認してください。
  
• 操作ダッシュボードでメンテナンスウィンドウを適切に設定して、リポジトリのアクティビティが最も少ない時間帯にクリーンアップが実行されるようにしてください。
• システムリソース（CPU、メモリ、I/O）を拡張してください。

リビジョンクリーンアップでは見積もりフェーズで、クリーンアップするのに十分なガベージがあるかどうかを判断します。見積もりでは、最後のコンパクション後のリポジトリのサイズと現在のサイズが比較されます。サイズが設定された差分を超えると、クリーンアップが実行されます。サイズの差分は 1 GB に設定されています。これは、リポジトリーのサイズが前回のクリーンアップの実行から 1 GB 増加しなかった場合、新しいリビジョンのクリーンアップの反復がスキップされることを事実上意味します。

見積もりフェーズに関連するログエントリは以下のとおりです。

• リビジョンの GC が実行される：サイズ差分は N% または N/N（N/N バイト）であるため、コンパクションを実行
• リビジョンの GC が実行 されない：サイズ差分は N% または N/N（N/N バイト）であるため、とりあえずコンパクションをスキップ

同時書き込みが可能なシステムでは、コンパクションサイクルの終了時に変更をコミットできるように、オンラインでのリビジョンクリーンアップで排他書き込みアクセスが必要になる場合があります。システムは forceCompact モードになります。詳細に関しては、oak のドキュメントを参照してください。強制コンパクションでは、同時書き込みの干渉を受けずに最終的に変更をコミットするために、排他的な書き込みロックが取得されます。応答時間に対する影響を制限するために、タイムアウト値を定義できます。この値はデフォルトで 1 分に設定されています。つまり、1 分以内に強制コンパクションが完了しない場合は同時コミットが優先され、コンパクションプロセスは中止されます。

強制コンパクションの実行時間は以下の要素によって変動します。

• ハードウェア：特に IOPS。IOPS が増えるにつれ、処理時間が短くなります。
• セグメントストアのサイズ：時間はセグメントストアのサイズと共に長くなります。

スタンバイインスタンスでは、オンラインでのリビジョンクリーンアップはどのように実行されますか。

コールドスタンバイセットアップでは、オンラインでのリビジョンクリーンアップの実行を設定する必要があるのは、プライマリインスタンスのみです。スタンバイインスタンスで、オンラインでのリビジョンクリーンアップを明示的にスケジュールする必要はありません。

スタンバイインスタンスでの対応する操作は自動クリーンアップです。これは、オンラインでのリビジョンクリーンアップのクリーンアップフェーズに相当します。自動クリーンアップは、プライマリインスタンスでオンラインリビジョンクリーンアップが実行された後、スタンバイインスタンスで実行されます。

見積もりフェーズとコンパクションフェーズは、スタンバイインスタンスでは実行されません。

オフラインでのリビジョンクリーンアップでは、古いリビジョンを即座に削除できますが、オンラインでのリビジョンクリーンアップでは、アプリケーションスタックによって参照されている古いリビジョンを考慮する必要があります。 そのため、前者は後者よりも積極的にガベージを削除することができ、数回のガベージ収集サイクルで効果が表れます。

この章の「オフラインでのリビジョンクリーンアップの実行後にオンラインでのリビジョンクリーンアップを実行した場合」の節も参照してください。

• Windows 環境では、通常のファイルアクセスが常に強制的に利用されるので、メモリマップアクセスは使用されません。一般的に、利用可能なすべての RAM をヒープに割り当て、segmentCache サイズを大きくする必要があります。segmentCache のサイズは、org.apache.jackrabbit.oak.segment.SegmentNodeStoreService.config に segmentCache.size オプションを追加して大きくします（例：segmentCache.size=20480）。オペレーティングシステムや他のプロセス用に、一定の RAM を残しておいてください。
• Windows 以外の環境では、物理メモリのサイズを大きくすることで、リポジトリのメモリマップの効率性を向上できます。

• オンラインでのリビジョンクリーンアップが有効な場合は、ディスクスペースを監視する必要があります。ディスク領域が不十分な場合、クリーンアップは実行されないか、早期に終了します。
• オンラインでのリビジョンクリーンアップの完了時間をログで確認してください。これは 2 時間以下である必要があります。
• チェックポイントの数。コンパクションの実行時にチェックポイントが 3 つ以上ある場合は、チェックポイントをクリーンアップすることをお勧めします。

オンラインでのリビジョンクリーンアップが正常に完了したかどうかは、ログを確認して確認できます。

例：「TarMK GC #{}: compaction completed in {} ({} ms), after {} cycles 」は、メッセージ「TarMK GC #{}: compaction gave up compacting concurrent commits after {} cycles」（同時負荷が大きすぎることを意味する）が先行しない限り、コンパクションステップが正常に完了したことを意味します。

それに伴い、クリーンアップステップの正常終了を示すメッセージ「TarMK GC #{}: cleanup completed in {} ({} ms」が表示されます。

ステータス、進行状況および統計は、JMX（SegmentRevisionGarbageCollection MBean）経由で表示されます。SegmentRevisionGarbageCollection MBean の詳細に関しては、次の段落 を参照してください。

進行状況は、 EstimatedRevisionGCCompletion のフィールド名で追跡できます。 SegmentRevisionGarbageCollection MBean.

MBean の参照を取得するには、 ObjectName org.apache.jackrabbit.oak:name="Segment node store revision garbage collection",type="SegmentRevisionGarbageCollection" を使用します。

確認できるのは、システムを最後に起動した以降の統計情報のみであることにご注意ください。外部の監視ツールを利用すると、AEM の稼動時間外もデータを監視できます。詳細に関しては、 外部の監視ツールの例として、Nagios にヘルスチェックを接続するための AEM のドキュメントを参照してください。

• オンラインでのリビジョンクリーンアップが開始/停止しました
  • オンラインでのリビジョンクリーンアップは、見積もり、コンパクション、クリーンアップの 3 つのフェーズで構成されます。リポジトリに十分な量のガベージが含まれていない場合は、見積もりによってコンパクションとクリーンアップがスキップされることがあります。最新バージョンの AEM では、メッセージ「TarMK GC #{}: estimation started」は見積もりの開始を示し、「TarMK GC #{}: compaction started, strategy={}」はコンパクションの開始を示し、「TarMK GC #{}: cleanup started. Current repository size is {} ({} bytes」はクリーンアップの開始を示します。
• リビジョンのクリーンアップで取得したディスクスペース
  • スペースは、クリーンアップフェーズが完了した場合にのみ再利用されます。クリーンアップフェーズの完了は、ログメッセージ「TarMK GC #{}: cleanup completed in {} ({} ms」で示されます。クリーンアップ後のサイズは {}（{} バイト）で、再利用された領域は {}（{} バイト）です。コンパクションマップの重み付け／深さは {}／{}（{} バイト／{}）です。
• リビジョンのクリーンアップ中に問題が発生しました
  • 多くの失敗条件があり、すべての障害は、「TarMK GC」で始まる WARN または ERROR ログメッセージで示されます。

また、エラーメッセージに基づくトラブルシューティングの節を参照してください。

オンラインでのリビジョンクリーンアップの後は、リポジトリの整合性チェックは必要ありません。

ただし、クリーンアップ後にリポジトリのステータスを確認するには、次の操作を実行できます。

• リポジトリトラバーサルチェック
• クリーンアッププロセスが完了したら、oak-run ツールを使用して不整合をチェックします。この方法について詳しくは、 Apache ドキュメントを参照してください。 ツールを実行するために AEM をシャットダウンする必要はありません。

リビジョンのクリーンアップヘルスチェックは、 操作ダッシュボードの一部です。

オンラインでのリビジョンクリーンアップメンテナンスタスクの最後の実行が正常に完了した場合、ステータスは緑になります。

オンラインでのリビジョンクリーンアップのメンテナンスタスクが 1 回キャンセルされた場合、ステータスはイエローになります。

オンラインでのリビジョンクリーンアップのメンテナンスタスクを 3 回連続でキャンセルした場合は、赤になります。この場合、手動の操作が必要であるか、オンラインでのリビジョンクリーンアップが再び失敗する可能性が高くなります。詳細情報に関しては、以下のトラブルシューティングの節を参照してください。

システムの再起動後に、ヘルスチェックステータスがリセットされることにもご注意ください。そのため、新しく再起動したインスタンスは、リビジョンクリーンアップのヘルスチェックが緑色のステータスで表示されます。外部の監視ツールを利用すると、AEM の稼動時間外もデータを監視できます。外部の監視ツールの例として、Nagios にヘルスチェックを接続するための AEM のドキュメントを参照してください。

スタンバイインスタンスで自動クリーンアップを監視する方法を教えてください。

ステータス、進行状況および統計は、SegmentRevisionGarbageCollection MBean を使用し、JMX 経由で表示されます。次の Oak ドキュメントも参照してください。

MBean の参照は、ObjectName org.apache.jackrabbit.oak:name="Segment node store revision garbage collection",type="SegmentRevisionGarbageCollection" を使用して取得できます。

確認できるのは、システムが最後に起動されて以降の統計情報のみであることにご注意ください。外部の監視ツールを利用すると、AEM の稼動時間外もデータを監視できます。また、 外部の監視ツールの例として、Nagios にヘルスチェックを接続するための AEM のドキュメントも参照してください。

ログファイルを使用して、自動クリーンアップのステータス、進行状況および統計情報を確認することもできます。

スタンバイインスタンスでの自動クリーンアップ中に監視する必要があるものは何ですか。

• 自動クリーンアップの実行中は、ディスクスペースを監視する必要があります。
• （ログを使用して）完了時間が 2 時間を超えていないことを確認します。
• 自動クリーンアップが実行された後のセグメントストアサイズ。スタンバイインスタンスでのセグメントストアのサイズは、プライマリインスタンスでのサイズとほぼ同じである必要があります。

• まず、ログエントリを確認します。
  
• ログの情報に応じて、適切なアクションを実行します。
  • ログに、5 回の失敗したコンパクションサイクルとforceCompactサイクルでのタイムアウトが示されている場合は、リポジトリへの書き込みが少ない、処理が少ない時間帯にメンテナンスウィンドウをスケジュールします。リポジトリーへの書き込みは、https://serveraddress:serverport/libs/granite/operations/content/monitoring/page.html にあるリポジトリー指標の監視ツールで確認できます。
  • メンテナンスウィンドウの最後にクリーンアップが停止した場合は、メンテナンスタスクのユーザーインターフェイスでメンテナンスウィンドウの設定が十分に大きいことを確認してください
  • 使用可能なヒープメモリが不十分な場合は、インスタンスに十分なメモリがあることを確認します。
  • 反応が遅れるとセグメントストアが大きくなりすぎ、メンテナンスウィンドウが長くても、オンラインでのリビジョンクリーンアップを完了できない可能性があります。例えば、先週にオンラインでのリビジョンクリーンアップが正常に完了しなかった場合は、セグメントストアを管理可能なサイズに戻すために、オフラインでのメンテナンスを計画し、オフラインでのリビジョンクリーンアップを実行することをお勧めします。

SegmentNotFoundException は、TarMK がアクセスを試みたストレージユニット（セグメント）が見つからなかったときに、TarMK によってログに記録されます。この問題を引き起こす可能性のあるシナリオは次の 3 つです。

1. 推奨されるアクセスメカニズム（Sling や JCR API など）を回避し、下位レベルの API/SPI を使用してリポジトリにアクセスし、セグメントの保持時間を超えるアプリケーション。つまり、オンラインでのリビジョンクリーンアップで許可されている保持時間（デフォルトでは 24 時間）より長い間、エンティティへの参照を保持します。このケースは一時的なもので、データの破損にはつながりません。復旧するには、oak-run ツールを使用して、この例外が一時的なものである（oak-run チェックでエラーが報告されない）ことを確認する必要があります。このためには、インスタンスをオフラインにし、後で再起動する必要があります。
2. ディスク上のデータの破損を招いた外部イベント。これは、ディスク障害、ディスク容量不足、または必要なデータファイルの誤った変更などになります。この場合は、インスタンスをオフラインにし、oak-run チェックを使用して修復する必要があります。oak-run チェックの実行方法についての詳細は、以下の Apache ドキュメント を参照してください。
3. 他のすべての状況では、アドビカスタマーケア に連絡して対処する必要があります。

クリーンアップの実行時間は、リポジトリサイズとクリーンアップする必要があるリビジョンの数によって決まります。

• Oak リビジョン： Oak では、ノードとプロパティで構成される大規模なツリー階層ですべてのコンテンツを整理しています。このコンテンツツリーの各スナップショットまたはリビジョンは不変であり、ツリーの変更は新しいリビジョンのシーケンスとして表されます。通常、コンテンツを変更するたびに新しいリビジョンがトリガーされます。リンクをフォロー も参照してください。
• ページバージョン：バージョン管理では、特定の時点でのページの「スナップショット」が作成されます。通常は、ページがアクティベートされたときに新しいバージョンが作成されます。詳細情報に関しては、ページバージョンの処理 を参照してください。