通过JMX控制台,您可以监控和管理CRX服务器上的服务。 以下各节概述了通过JMX框架公开的属性和操作。
有关如何使用控制台控件的信息,请参阅使用JMX控制台。 有关JMX的背景信息,请参阅Oracle网站上的Java管理扩展(JMX)技术页面。
有关创建MBean以使用JMX控制台管理服务的信息,请参阅将服务与JMX控制台集成。
用于管理正在运行、已完成、已失效和失败的工作流实例的操作。
有关其他工作流管理工具以及可能工作流实例状态的描述,请参阅工作流控制台。
listRunningWorkflowsPerModel列出为每个工作流模型运行的工作流实例数。
listCompletedWorkflowsPerModel列出每个工作流模型的已完成工作流实例数。
returnWorkflowQueueInfoLists有关已处理和已排队等待处理的工作流项目的信息。
参数:无
返回的值:包含以下列的表数据:
returnWorkflowJobTopicInfoLists按主题组织的工作流作业的处理信息。
参数:无
返回的值:包含以下列的表格数据:
returnFailedWorkflowCount显示失败的工作流实例数。您可以指定工作流模型来查询或检索所有工作流模型的信息。
参数:
模型:要查询的模型的ID。 要查看所有工作流模型的失败工作流实例计数,请不指定任何值。 ID是模型节点的路径,例如:
/conf/global/settings/workflow/models/dam/update_asset/jcr:content/model
返回的值:失败的工作流实例数。
returnFailedWorkflowCountPerModel显示每个工作流模型失败的工作流实例数。
terminateFailedInstancesTerminate失败的工作流实例。您可以终止所有失败实例,或仅终止特定模型的失败实例。 (可选)您可以在实例终止后重新启动实例。 您还可以测试操作以查看结果,而不实际执行操作。
参数:
重新启动实例:(可选)指定值true
,以在实例终止后重新启动实例。 默认值false
不会重新启动已终止的工作流实例。
练习:(可选)指定值true
,以查看操作结果,而不实际执行操作。 默认值false
会导致执行该操作。
模型:(可选)应用操作的模型的ID。 指定任何模型,以将操作应用到所有工作流模型的失败实例。 ID是模型节点的路径,例如:
/conf/global/settings/workflow/models/dam/update_asset/jcr:content/model
返回的值:有关已终止的实例的表格数据,包含以下列:
retryFailedWorkItemsAttems执行失败的工作项步骤。您可以重试所有失败的工作项,或仅重试特定工作流模型的失败工作项。 您可以选择测试该操作以查看结果,而不实际执行该操作。
参数:
练习:(可选)指定值true
,以查看操作结果,而不实际执行操作。 默认值false
会导致执行该操作。
模型:(可选)应用操作的模型的ID。 指定任何模型,以将操作应用于所有工作流模型的失败工作项。 ID是模型节点的路径,例如:
/conf/global/settings/workflow/models/dam/update_asset/jcr:content/model
返回的值:有关重试的失败工作项的表格数据,包括以下列:
PurgeActiveRemoves特定页面的活动工作流实例。您可以清除所有模型的活动实例,或仅清除特定模型的实例。 您可以选择测试操作以查看结果,而不实际执行操作。
参数:
模型:(可选)应用操作的模型的ID。 指定任何模型,以将该操作应用到所有工作流模型的工作流实例。 ID是模型节点的路径,例如:
/conf/global/settings/workflow/models/dam/update_asset/jcr:content/model
工作流启动后间隔的天数:要清除的工作流实例的年龄(以天为单位)。
练习:(可选)指定值true
,以查看操作结果,而不实际执行操作。 默认值false
会导致执行该操作。
返回的值:有关已清除的活动工作流实例的表格数据,包括以下列:
countStaleWorkflows返回过时的工作流实例数。您可以检索所有工作流模型或特定模型的过时实例数。
参数:
模型:(可选)应用操作的模型的ID。 指定任何模型,以将该操作应用到所有工作流模型的工作流实例。 ID是模型节点的路径,例如:
/conf/global/settings/workflow/models/dam/update_asset/jcr:content/model
返回的值:过时的工作流实例数。
restartStaleWorkflows重新启动过时的工作流实例。您可以为特定模型重新启动所有过时实例或仅重新启动过时实例。 您还可以测试操作以查看结果,而不实际执行操作。
参数:
模型:(可选)应用操作的模型的ID。 指定任何模型以将操作应用到所有工作流模型的失效实例。 ID是模型节点的路径,例如:
/conf/global/settings/workflow/models/dam/update_asset/jcr:content/model
练习:(可选)指定值true
,以查看操作结果,而不实际执行操作。 默认值false
会导致执行该操作。
返回的值:重新启动的工作流实例列表。
fetchModelListList列出所有工作流模型。
countRunningWorkflows返回正在运行的工作流实例数。您可以检索所有工作流模型或特定模型的正在运行的实例数。
参数:
模型:(可选)返回运行实例数的模型的ID。 指定不返回所有工作流模型正在运行的实例数的模型。 ID是模型节点的路径,例如:
/conf/global/settings/workflow/models/dam/update_asset/jcr:content/model
返回的值:正在运行的工作流实例数。
countCompletedWorkflows返回已完成的工作流实例数。您可以检索所有工作流模型或特定模型的已完成实例数。
参数:
模型:(可选)返回已完成实例数的模型的ID。 指定任何模型以返回所有工作流模型的已完成实例数。 ID是模型节点的路径,例如:
/conf/global/settings/workflow/models/dam/update_asset/jcr:content/model
返回的值:已完成的工作流实例数。
purgeCompletedRemoves从存储库中删除特定年龄的已完成工作流的记录。当您大量使用工作流时,请定期使用此操作以最大程度地减小存储库的大小。 您可以清除所有模型的已完成实例,或仅清除特定模型的实例。 您可以选择测试操作以查看结果,而不实际执行操作。
参数:
模型:(可选)应用操作的模型的ID。 指定任何模型,以将该操作应用到所有工作流模型的工作流实例。 ID是模型节点的路径,例如:
/conf/global/settings/workflow/models/dam/update_asset/jcr:content/model
工作流完成后间隔的天数:工作流实例处于已完成状态的天数。
练习:(可选)指定值true
,以查看操作结果,而不实际执行操作。 默认值false
会导致执行该操作。
返回的值:有关已清除的已完成工作流实例的表格数据,包括以下列:
有关CRX存储库的信息
名称JCR存储库实施的名称。只读.
版本存储库实施版本。只读.
HomeDir存储库所在的目录。默认位置为<QuickStart_Jar_Location>/crx-quickstart/repository。 只读.
CustomerName软件许可证颁发给的客户的名称。只读.
许可证密钥此存储库安装的唯一许可证密钥。只读.
AvailableDiskSpace存储库的此实例可用的磁盘空间(以MB为单位)。只读.
MaximumNumberOfOpenFiles一次可打开的文件数。只读.
SessionTrackercrx.debug.sessions系统变量的值。true表示调试会话。 false表示正常会话。 读/写。
描述符表示存储库属性的一组键值对。所有属性均为只读。
键 | 值 |
---|---|
option.node.and.property.with.same.name.supported | 指示节点和节点的属性是否可以具有相同的名称。 true表示支持相同的名称,false表示不支持。 |
identifier.stability | 指示不可引用节点标识符的稳定性。 可以使用以下值:
|
query.xpath.pos.index | 指示是否支持JCR 1.0 XPath查询语言。 true表示支持,false表示不支持。 |
crx.repository.systemid | 系统标识符,在system.id文件中找到。 |
option.query.sql.supported | 指示是否支持JCR 1.0 XPath查询语言。 true表示支持,false表示不支持。 |
jcr.repository.version | 存储库实施的版本。 |
option.update.primary.node.type.supported | 指示节点的主节点类型是否可以更改。 true表示可以更改主节点类型,false表示不支持更改。 |
option.node.type.management.supported | 指示是否支持节点类型管理。 true表示支持,false表示不支持。 |
node.type.management.overrides.supported | 指示是否可以覆盖节点类型的继承属性或子节点定义。 true表示支持覆盖,false表示不覆盖。 |
option.observation.supported | true表示支持异步观察存储库更改。 支持异步观察,使应用程序能够在每次发生更改时接收并响应通知。 |
query.jcrscore | true表示jcr:score伪属性在包含jcrfn:contains(在XPath中)或CONTAINS(在SQL中)函数的XPath和SQL查询中可用,以执行全文搜索。 |
option.simple.versioning.supported | true表示存储库支持简单的版本化。 通过简单的版本控制,存储库会维护节点的一系列连续版本。 |
option.workspace.management.supported | true表示存储库支持使用API创建和删除工作区。 |
option.update.mixin.node.types.supported | true表示存储库支持添加和删除现有节点的mixin节点类型。 |
node.type.management.primary.item.name.supported | true表示存储库使节点定义能够将主项包含为子项。 无需知道项目名称,即可使用API访问主项目。 |
level.2.supported | true表示LEVEL_1_SUPPORTED和OPTION_XML_IMPORT_SUPPORTED都为true。 |
write.supported | true表示存储库使用API提供写访问。 false表示只读访问。 |
node.type.management.update.in.use.supported | true表示您可以更改现有节点正在使用的节点定义。 |
jcr.specification.version | 存储库实施的JCR规范的版本。 |
option.journaled.observation.supported | true表示应用程序可以执行对存储库的日志观察。 通过日志观察,可以在特定时间段内获得一组变化通知。 |
query.languages | 存储库支持的查询语言。 没有值表示不支持查询。 |
option.xml.export.supported | true表示存储库支持将节点导出为XML代码。 |
node.type.management.multiple.binary.properties.supported | true表示存储库支持注册具有多个二进制属性的节点类型。 false表示节点类型支持单个二进制属性。 |
option.access.control.supported | true表示存储库支持访问控制,用于设置和确定节点访问的用户权限。 |
option.baselines.supported | true表示存储库支持配置和基线。 |
option.shareable.nodes.supported | true表示存储库支持创建可共享节点。 |
crx.cluster.id | 存储库群集的标识符。 |
query.stored.queries.supported | true表示存储库支持存储的查询。 |
query.full.text.search.supported | true表示存储库支持全文搜索。 |
node.type.management.inheritance | 指示对节点类型继承的存储库支持级别。 可以使用以下值: node.type.management.interhance.minimal:主节点类型的注册仅限于仅将nt:base作为超类型的节点类型。 混合节点类型的注册仅限于那些没有超类型的节点类型。 node.type.management.international.single:主节点类型的注册仅限于具有一个超类型的节点类型。 混合节点类型的配准被限制为最多具有一个超类型的节点类型。
|
crx.cluster.preferredMaster | true表示此群集节点是群集的首选主控。 |
option.transactions.supported | true表示存储库支持交易。 |
jcr.repository.vendor.url | 存储库供应商的URL。 |
node.type.management.value.constraints.supported | true表示存储库支持节点属性的值约束。 |
node.type.management.property.types | javax.jcr.PropertyType常量的数组,表示注册节点类型可以指定的属性类型。 零长度数组表示注册的节点类型无法指定属性定义。 属性类型包括字符串、URI、布尔值、长、双精度、小数、二进制、日期、名称、路径、弱引用、引用和未定义(如果支持) |
node.type.management.orderable.child.nodes.supported | true表示存储库支持保留子节点的顺序。 |
jcr.repository.vendor | 存储库供应商的名称。 |
query.joins | 对查询中连接的支持级别。 可以使用以下值:
|
org.apache.jackrabbit.spi.commons.AdditionalEventInfo | |
query.xpath.doc.order | true表示存储库支持XPath 1.0查询语言。 |
query.jcrpath | |
option.xml.import.supported | true表示存储库支持将XML代码导入为内容。 |
node.type.management.same.name.siblings.supported | true表示存储库支持具有相同名称的同级节点(具有相同父项的节点)。 |
node.type.management.residual.definitions.supported | true表示存储库支持具有剩余定义的名称属性。 如果支持,项目定义的name属性可以是星号("*")。 |
node.type.management.autocreated.definitions.supported | true表示在创建节点时,存储库支持自动创建节点的子项(节点或属性)。 |
crx.cluster.master | true表示此存储库节点是群集的主控节点。 |
level.1.受支持 | true表示option.xml.export.support为true,query.languages的长度为非零。 |
option.unfiled.content.supported | true表示存储库支持未存档的内容。 未存档的节点不是存储库层次结构的一部分。 |
jcr.specification.name | 存储库实施的JCR规范的名称。 |
option.versioning.supported | true表示存储库支持完全版本控制。 |
jcr.repository.name | 存储库的名称。 |
option.locking.supported | true表示存储库支持节点锁定。 通过锁定,用户可暂时阻止其他用户进行更改。 |
jcr.repository.version.display | |
option.activities.supported | true表示存储库支持活动。 活动是在工作区中执行的一组更改,这些更改会合并到另一个工作区中。 |
node.type.management.multivalued.properties.supported | true表示存储库支持的节点属性可以具有零个或更多值。 |
option.retention.supported | true表示存储库支持使用外部保留管理应用程序将保留策略应用于内容,并支持保留和释放。 |
option.lifecycle.supported | true表示存储库支持生命周期管理。 |
工作区名称存储库中工作区的名称。只读.
DataStoreGarbageCollectionDelay垃圾收集在每十个节点扫描后休眠的时间(以毫秒为单位)。读/写。
BackupDelay备份过程在备份的每个步骤之间休眠的时间(以毫秒为单位)。读/写。
BackupInProgressA值为true表示正在执行备份进程。只读.
BackupProgress对于当前备份,备份的所有文件所占的百分比。只读.
CurrentBackupTarget对于当前备份,是存储备份文件的ZIP文件。当备份未进行时,不会显示任何值。 只读.
BackupWasSuccessfulA值为true表示在当前备份期间未发生错误,或未进行任何备份。false表示当前备份期间发生错误。 只读.
BackupResult当前备份的状态。可以使用以下值:
只读.
TarOptimizationRunningSince当前TAR文件优化过程开始的时间。只读.
TarOptimizationDelayTAR优化流程在流程每个步骤之间停留的时间(以毫秒为单位)。读/写。
ClusterProperties(群集属性)一组表示群集属性和值的键值对。表中的每一行都表示一个群集属性。 只读.
ClusterNodes存储库群集的成员。
ClusterId此存储库群集的标识符。只读.
ClusterMasterId此存储库群集主控节点的标识符。只读.
ClusterNodeId存储库群集的此节点的标识符。只读.
createWorkspace在此存储库中创建工作区。
参数:
返回的值:无
runDataStoreGarbageCollectionExces对存储库节点执行垃圾收集。
参数:
返回的值:无
stopDataStoreGarbageCollectionStops运行的数据存储垃圾收集。
startBackup在ZIP文件中备份存储库数据。
参数:
target
:(可选)一 String
个值,表示要在其中存档存储库数据的ZIP文件或目录的名称。要使用ZIP文件,请包含ZIP文件扩展名。 要使用目录,请不包含文件扩展名。
要执行增量备份,请指定以前用于备份的目录。
您可以指定绝对路径或相对路径。 相对路径是相对于crx-quickstart目录的父路径。
未指定值时,将使用默认值backup-currentdate.zip
,其中currentdate
的格式为yyyyMMdd-HHmm
。
返回的值:无
cancelBackup停止当前备份进程并删除该进程为存档数据而创建的临时存档。
blockRepositoryWritesBlocks对存储库数据的更改。所有存储库备份侦听器都会收到该块的通知。
unlockRepositoryWrites从存储库中删除块。所有存储库备份侦听器都会收到删除块的通知。
startTarOptimization使用tarOptimizationDelay的默认值启动TAR文件优化流程。
stopTarOptimizationStops TAR文件优化。
tarIndexMerge合并所有TAR集的顶级索引文件。顶级索引文件是具有不同主要版本的文件。 例如,以下文件将合并到文件index_3_1.tar中:index_1_1.tar、index_2_0.tar、index_3_0.tar。 将删除已合并的文件(在上一个示例中,将删除index_1_1.tar、index_2_0.tar和index_3_0.tar)。
参数:
background
:一个布尔值,指示是否在后台运行操作,以便在执行期间可以使用Web控制台。值为true会在后台运行操作。返回的值:无
becomeClusterMaster将此存储库节点设置为群集的主控节点。如果尚未主控,此命令将停止当前主控实例的侦听器,并在当前节点上启动主控侦听器。 然后,此节点将设置为主控节点并重新启动,从而导致群集中的所有其他节点(即由主控控制的节点)连接到此实例。
joinCluster将此存储库作为由群集主控控制的节点添加到群集中。您必须提供用户名和密码才能进行身份验证。 连接使用基本身份验证。 安全凭据在发送到服务器之前进行base-64编码。
参数:
master
:一个字符串值,表示运行主控存储库节点的计算机的IP地址或计算机名称。username
:用于通过群集进行身份验证的名称。password
:用于身份验证的密码。返回的值:无
traversalCheckTroverses和(可选)修复特定节点处子树开头的不一致问题。持久性管理器文档中详细介绍了该内容。
consistencyCheckChecks和(可选)修复数据存储中的一致性。有关数据存储的文档中详细介绍了该内容。
org.apache.jackrabbit.api.stats.RepositoryStatistics
定义的每个统计类型的TimeSeries字段值。
域: com.adobe.granite
类型: TimeSeries
名称:org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
枚举类中的以下值之一:
为报告的每种统计类型提供了以下属性:
有关存储库查询的统计信息。
SlowQueryes有关完成所用时间最长的存储库查询的信息。只读.
SlowQueryesQueueSize要包含在SlowQuerys列表中的查询数上限。读写。
PopularQueries关于发生次数最多的存储库查询的信息。只读.
PopulalQueriesQueueSizePopulalQuerys列表中的最大查询数。读写。
clearSlowQueryesQueue从SlowQuerys列表中删除所有查询。
clearPopulalQueriesQueue从PopulalQuerys列表中删除所有查询。
监控每个复制代理的服务。 创建复制代理时,该服务会自动显示在JMX控制台中。
Id表示复制代理配置标识符的字符串值。多个代理可以使用相同的配置。 只读.
ValidA布尔值,指示代理配置是否正确:
true
:配置有效。false
:配置包含错误。只读.
Enabled:指示是否启用代理的布尔值:
true
: 启用.false
: 已禁用.QueueBlockedA布尔值,指示队列是否存在且被阻止:
true
: 已阻止. 自动重试挂起。false
:未阻止或不存在。只读.
QueuePaused布尔值,指示作业队列是否暂停:
true
:暂停(暂停)false
:未暂停或不存在。读写。
QueueNumEntries表示代理队列中作业数的整数值。只读.
QueueStatusTimeA日期值,指示获取显示状态值时服务器上的时间。值与页面加载时间相对应。 只读.
QueueNextRetryTimeFor blocked queues,一个日期值,指示何时发生下一次自动重试。当没有时间显示时,不会阻止队列。 只读.
QueueProcessingSinceA日期值,指示当前作业处理开始的时间。当没有出现时间时,队列会被阻止或空闲。 只读.
QueueLastProcessTime指示上一个作业完成时间的日期值。只读.
queueForceRetryFor blocked队列向队列发出重试命令。
queueClearRemoves队列中的所有作业。
提供有关HTTP请求的统计信息,以便您能够监控SlingRequestProcessor服务的性能。
RequestsCount自上次重置统计信息以来发生的请求数。
MinRequestDurationMsec自上次重置统计信息以来处理请求所需的最短时间(以毫秒为单位)。
MaxRequestDuratioMsec处理请求自上次重置统计信息以来所需的最长时间(以毫秒为单位)。
StandardDevationDurationMsec处理请求所需时间量的标准偏差。自上次重置统计信息以来,标准偏差会使用所有请求进行计算。
MeanRequestDurationMsec处理请求所需的平均时间。自上次重置统计信息后,平均值会使用所有请求计算
resetStatistics将所有统计信息设置为零。当您需要分析特定时间段内的请求处理性能时,请重置统计信息。
有关包管理器包含的所有包的信息。
有关启动过程和快速启动启动启动器的信息。
日志
在“快速启动”窗口中显示一条消息。
参数:
String
值。 下图显示了调用p1值为this is a log message
的log
的结果。startupFinished
调用服务器启动器的startupFinished方法。 方法会尝试在Web浏览器中打开欢迎页面。
startupProgress
设置服务器启动进程的完成值。 “快速启动”窗口中的进度条表示完成值。
参数:
返回的值:无。
若干第三方服务器资源安装向JMX控制台显示属性和操作的MBean。 下表列出了第三方资源并提供了指向更多信息的链接。
域 | 类型 | MBean类 |
---|---|---|
JMI实施 | MBeanServerDelegate | javax.management.MBeanServerDelegate |
com.sun.management | 热点诊断 | com.sun.management.HotSpotDiagnosticMXBean |
java.lang |
|
javax. managementpackage |
java.util.logging | java.util.logging.LoggingMXBean | |
osgi.core |
|
org.osgi.jmx. frameworkpackage |
JMX控制台显示有关服务器上运行的多项服务的信息:
与OSGi服务一起部署的MBean向控制台显示服务属性和操作。 MBean确定公开的属性和操作,以及属性是只读还是读写。
JMX控制台的主页包含一个服务表。 表中的每一行都表示由MBean公开的服务。
CRX允许外部应用程序通过Java管理扩展(JMX)与受管Bean(MBean)进行交互。 使用通用控制台(如JConsole或特定于域的监控应用程序),可以获取和设置CRX配置和属性,以及监控性能和资源使用情况。
要使用JConsole连接到CRX,请执行以下步骤:
打开终端窗口。
输入以下命令:
jconsole
将启动JConsole,并出现JConsole窗口。
JConsole将显示本地Java虚拟机进程的列表。 该列表将包含两个快速启动进程。 从本地进程(通常是PID较高的进程)列表中选择快速启动“CHILD”进程。
要连接到远程CRX进程,需要启用承载远程CRX进程的JVM以接受远程JMX连接。
要启用远程JMX连接,在启动JVM时必须设置以下系统属性:
com.sun.management.jmxremote.port=portNum
在上述属性中,portNum
是要启用JMX RMI连接的端口号。 请务必指定未使用的端口号。 除了发布用于本地访问的RMI连接器外,设置此属性还会在指定端口的专用只读注册表中使用众所周知的名称“jmxrmi”发布一个额外的RMI连接器。
默认情况下,启用JMX代理进行远程监视时,它会根据在启动Java VM时需要使用以下系统属性指定的密码文件使用密码验证:
com.sun.management.jmxremote.password.file=pwFilePath
有关设置密码文件的详细说明,请参阅相关JMX文档。
示例:
$ java
-Dcom.sun.management.jmxremote.password.file=pwFilePath
-Dcom.sun.management.jmxremote.port=8463
-jar ./cq-quickstart.jar
在连接到快速启动进程后,JConsole为CRX正在运行的JVM提供一系列常规监控工具。
要访问CRX的内部监控和配置选项,请转到MBeans选项卡,然后从左侧的分层内容树中,选择您感兴趣的“属性”或“操作”部分。 例如com.adobe.granite/Repository/Operations部分。
在该部分中,在左窗格中选择所需的属性或操作。