Oak-run.jar索引用例

注意

AEM 6.4已结束扩展支持,本文档将不再更新。 有关更多详细信息,请参阅 技术支助期. 查找支持的版本 此处.

Oak-run支持在命令行上索引用例,而无需通过AEM JMX控制台编排这些用例的执行。

使用oak-run.jar index命令方法管理Oak索引的主要优势包括:

  1. Oak-run index命令为AEM 6.4提供了新的索引工具集。
  2. Oak-run可缩短重新索引的时间,从而缩短大型存储库上的重新索引时间。
  3. Oak-run可减少在AEM中重新索引期间的资源消耗,从而整体提高系统性能。
  4. Oak-run提供带外重新索引,支持必须提供生产的情况,并且不能容忍重新索引所需的维护或停机。

以下部分将提供示例命令。 oak-run index命令支持所有NodeStore和BlobStore设置。 以下提供的示例涉及具有FileDataStore和SegmentNodeStore的设置。

用例1 — 索引一致性检查

这是与索引损坏相关的用例。 在某些情况下,无法确定哪些索引已损坏。 因此,Adobe提供了以下工具:

  1. 对所有索引执行索引一致性检查,并提供索引有效和无效的报告;
  2. 即使AEM不可访问,工具也可用;
  3. 易于使用。

可通过 --index-consistency-check 操作:

java -jar oak-run*.jar index --fds-path=/path/to/datastore  /path/to/segmentstore/ --index-consistency-check

这将在 indexing-result/index-consistency-check-report.txt. 有关示例报表,请参阅下文:

Valid indexes :
        - /content/oak:index/enablementResourceName
        - /oak:index/cqProjectLucene
        - /oak:index/cqTagLucene
        - /oak:index/lucene
        - /oak:index/ntBaseLucene
        - /oak:index/socialLucene
    Invalid indexes :
        - /oak:index/atDamIndex
        - /oak:index/atIndex
        - /oak:index/cqPageLucene
        - /oak:index/damAssetLucene
        - /oak:index/groups
        - /oak:index/slingeventJob
        - /oak:index/users
        - /oak:index/workflowDataLucene
    Ignored indexes as these are not of type lucene:
        - /oak:index/acPrincipalName
        - /oak:index/active

好处

支持人员和系统管理员现在可以使用此工具快速确定哪些索引已损坏,然后重新编入索引。

用例2 — 索引统计

为了诊断查询性能Adobe的某些情况,通常需要现有索引定义,需要从客户设置中索引相关统计信息。 到目前为止,这些信息分散在多个资源中。 为了更轻松地进行故障诊断,Adobe创建了工具,工具将:

  1. 将系统上存在的所有索引定义转储到一个JSON文件中;

  2. 从现有索引中转储重要统计信息;

  3. 转储索引内容以进行离线分析;

  4. 即使AEM无法访问,也将可用

现在可以通过以下操作索引命令完成上述操作:

  • --index-info — 收集和转储与索引相关的各种统计信息

  • --index-definitions — 收集和转储索引定义

  • --index-dump — 转储索引内容

请参阅下面命令在实践中的工作原理示例:

java -jar oak-run*.jar index --fds-path=/path/to/datastore  /path/to/segmentstore/ --index-info --index-definitions --index-dump

报告将在 indexing-result/index-info.txtindexing-result/index-definitions.json

此外,还通过Web控制台提供了相同的详细信息,这些信息将包含在配置转储zip文件中。 可在以下位置访问它们:

https://serverhost:serverport/system/console/status-oak-index-defn

好处

此工具能够快速收集与索引或查询问题相关的所有必需详细信息,并减少提取此信息所花费的时间。

用例3 — 重新索引

根据 情景,在某些情况下,需要执行重新索引。 当前,可通过设置 reindex 标记为 true 通过CRXDE或通过索引管理器用户界面在索引定义节点中。 标记设置完成后,将异步重新编入索引。

有关重新索引的一些注意事项:

  • 重新索引的速度在 DocumentNodeStore 设置与 SegmentNodeStore 设置所有内容都是本地内容的;

  • 使用当前设计时,如果重新编制索引,则异步索引器会被阻止,并且所有其他异步索引都会失效,并且在索引期间不会获取更新。 因此,如果系统正在使用,用户可能看不到最新的结果;

  • 重新索引涉及遍历整个存储库,这会给AEM设置带来高负载,从而影响最终用户体验;

  • 对于 DocumentNodeStore 如果在安装中重新编制索引可能需要相当长的时间,如果与Mongo数据库的连接在操作过程中失败,则必须从头开始重新编制索引;

  • 在某些情况下,由于文本提取,重新索引可能需要很长时间。 这主要适用于具有大量PDF文件的设置,在这些设置中,文本提取所花费的时间可能会影响索引时间。

为实现这些目标,oak-run索引工具支持不同的重新索引模式,这些模式可以根据需要使用。 oak-run index命令具有以下优势:

  • 带外重新索引 - oak运行的重新索引可以与正在运行的AEM设置分开执行,从而最大限度地减少对正在使用的AEM实例的影响;

  • 车道外重新索引 — 重新编制索引不会影响索引操作。 这意味着异步索引器可以继续索引其他索引;

  • 简化了DocumentNodeStore安装的重新索引 — 对于 DocumentNodeStore 安装时,只需使用一个命令即可完成重新索引,这可确保以最佳方式完成重新索引;

  • 支持更新索引定义并引入新的索引定义

重新索引 — DocumentNodeStore

对于 DocumentNodeStore 安装可通过单个oak-run命令完成重新索引:

java -jar oak-run*.jar index --reindex --index-paths=/oak:index/lucene --read-write --fds-path=/path/to/datastore mongodb://server:port/aem

这具备以下优势

  • 对运行AEM实例的影响最小。 大多数读取操作都可从辅助服务器完成,并且运行AEM缓存不会因为重新索引所需的所有遍历而受到影响;
  • 用户还可以通过 --index-definitions-file 选项。

重新索引 — SegmentNodeStore

对于 SegmentNodeStore 安装重新索引可以通过以下方式之一完成:

联机重新索引 — SegmentNodeStore

遵循通过设置 reindex 标记。

联机重新索引 — SegmentNodeStore -AEM实例正在运行

对于 SegmentNodeStore 只有一个进程才能以读写模式访问区段文件。 由于这一原因,在oak-run索引中执行某些操作需要执行额外的手动步骤。

这将涉及以下内容:

  1. 步骤文本

  2. 连接 oak-run 到AEM在只读模式下使用的同一存储库,并执行索引。 有关如何实现此操作的示例:

    java -jar oak-run-1.7.6.jar index --fds-path=/Users/dhasler/dev/cq/quickstart/target/crx-quickstart/repository/datastore/ --checkpoint 26b7da38-a699-45b2-82fb-73aa2f9af0e2 --reindex --index-paths=/oak:index/lucene /Users/dhasler/dev/cq/quickstart/target/crx-quickstart/repository/segmentstore/
    
  3. 最后,通过 IndexerMBean#importIndex 运行上述命令后,oak-run保存索引文件的路径中的操作。

在这种情况下,您不必停止AEM服务器或配置任何新实例。 但是,由于索引涉及遍历整个存储库,因此会增加安装的I/O负载,从而对运行时性能产生负面影响。

联机重新索引 — SegmentNodeStore - AEM实例已关闭

对于 SegmentNodeStore 安装可通过单个oak-run命令完成重新索引。 但是,需要关闭AEM实例。

您可以使用以下命令触发重新索引:

java -jar oak-run*.jar index --reindex --index-paths=/oak:index/lucene --read-write --fds-path=/path/to/datastore  /path/to/segmentstore/

此方法与上述方法的区别在于,检查点创建和索引导入是自动完成的。 缺点是在该过程中AEM需要关闭。

带外重新索引 — SegmentNodeStore

在此用例中,您可以对克隆的设置执行重新索引,以最大限度地减少对运行的AEM实例的影响:

  1. 通过JMX操作创建检查点。 为此,您可以转到 JMX控制台 和搜索 CheckpointManager. 然后,单击 createCheckpoint(long p1) 使用高值过期(以秒为单位)的操作(例如, 2592000)。

  2. 复制 crx-quickstart 文件夹到新计算机

  3. 通过oak-run index命令执行重新索引

  4. 将生成的索引文件复制到AEM服务器

  5. 通过JMX导入索引文件。

在此用例下,我们假定数据存储可在其他实例上访问,如果 FileDataStore 置于EBS等基于云的存储解决方案中。 这不包括以下情景: FileDataStore 也克隆了。 如果索引定义不执行全文索引,则可以访问 DataStore 不是必需的。

用例4 — 更新索引定义

目前,您可以通过 ACS Ensure Index 包。 这允许通过内容包发送索引定义,该内容包稍后需要通过设置 reindex 标记为 true.

这非常适用于重新建立索引不需要很长时间的较小安装。 但是,对于非常大的存储库,重新编制索引将在相当长的时间内完成。 对于此类情况,我们现在可以使用oak-run索引工具。

Oak-run现在支持以JSON格式提供索引定义,并在带外模式下创建索引,在带外模式下,实时实例不会执行任何更改。

对于此用例,您需要考虑的流程是:

  1. 开发人员将在本地实例上更新索引定义,然后通过 --index-definitions 选项

  2. 更新的JSON随后将提供给系统管理员

  3. 系统管理员遵循带外方法并准备其他安装上的索引

  4. 完成此操作后,将在运行AEM安装时导入生成的索引文件。

在此页面上