Sync Service metrics - Sync Service metrics - Alfresco - Alfresco Sync Service - Alfresco/Alfresco-Sync-Service/3.0/Alfresco-Sync-Service/Alfresco-Sync-Service/Administer/Monitor-Sync-Service/Sync-Service-metrics - 3.0

Alfresco Sync Service

Platform
Alfresco
Product
Alfresco Sync Service
Release
3.0
ft:lastPublication
2026-05-06T19:49:28.818000
ft:locale
en-US
ArchiveStatus
Archived

The Sync Service exposes a collection of metrics that are useful in managing the Sync Service. These metrics can be accessed using JMX (see bean metrics) or a REST call:

GET https://localhost:9090/alfresco/api/-default-/private/alfresco/versions/1/metrics

The response is JSON and contains all the metrics collected by the Sync Service. In particular:

Metric Name Type Description
nodeEventLag Timer Specifies the time taken for events sent by the repository to be consumed by the Sync Service. It is measured in milliseconds. Note: Timer measures the rate that a particular piece of code is called and the distribution of its duration. See Timers.
nodeEventsBrokerTime Timer Specifies the amount of time the event spends in the (ActiveMQ) broker.
nodeEventBrokerLag Timer Specifies the lag between events being sent to the (ActiveMQ) broker by the repository and the time at which the broker receives the event.
nodeEventConsumerLag Timer Specifies the lag between the broker sending out events and the Sync Service consuming them.
lagBetweenEventCreateAndSend Timer Specifies the lag between the event creation time and the time the event is sent to the (ActiveMQ) broker.
syncsTimedOut Meter Specifies the syncs that have timed out (possibly due to long query times). Note: Meter measures the rate of events over time, for example, requests per seconds. See Meters.
syncFailuresMeter Meter Specifies the sync failures.
syncsTimer Timer Specifies the distribution of sync times.
timePerCommit Timer Specifies the node event database commit times.
timePerEventUpdate Timer Specifies the node event database insert times.
timePerGetChanges Timer Specifies the sync query times.
numActiveClusterMembers Gauge Number of active Sync Service cluster members. Note: Gauge is an instantaneous measurement of a value. See Gauges.