Workflow Debugging

adobe/skills/plugins/aem/6.5-lts/skills/aem-workflow/workflow-debugging

作者 adobe940b8795c0dfApache-2.0197 個星標收錄於 2026年10月9日更新於 2026年10月8日儲存庫今天更新

Debug AEM Workflow issues on AEM 6.5 LTS and AMS including stuck workflows, failed steps, missing Inbox tasks, launcher failures, stale instances, thread pool exhaustion, queue backlogs, purge failures, and permissions errors. Use when the user reports workflow problems on AEM 6.5 LTS or AMS, asks why a workflow is stuck or failed, needs step-by-step troubleshooting, or provides thread dumps, configuration status dumps, or Sling Job console output for analysis.

AI 產生的概覽

指導逐步偵錯 AEM 6.5 LTS 與 AMS 上的 Granite 工作流程問題,例如工作流程卡住、步驟失敗與佇列積壓。

功能
為 AEM 6.5 LTS 與 AMS 上的 AEM Granite 工作流程問題提供結構化疑難排解程序,涵蓋工作流程卡住或失敗、收件匣任務遺漏、啟動器失敗、過期執行個體、執行緒集區耗盡、佇列積壓、清除失敗與權限錯誤。內容包括症狀對應首要動作、決策樹、執行緒傾印與執行緒集區分析、錯誤記錄模式、OSGi 設定檢查清單、修復步驟以及重要 JMX MBean。也記錄了來自真實事件的常見根因模式,並指向一個參考檔案以取得執行手冊位置。
適用情境
當使用者回報 AEM 6.5 LTS 或 AMS 上的工作流程問題、詢問工作流程為何卡住或失敗、需要逐步疑難排解,或提供執行緒傾印、設定狀態傾印或 Sling Job 主控台輸出以供分析時使用。
執行需求
沒有指令碼,僅有說明。需要存取具備 JMX 權限的 AEM 6.5 LTS 或 AMS 環境(透過 Felix Console 或 JMX 用戶端),並提供執行緒傾印、設定狀態 ZIP、Sling Job 主控台輸出或 error.log 摘錄作為輸入。

AEM Workflow Debugging — 6.5 LTS / AMS

Production-grade debugging for AEM Granite Workflow engine, launcher, Inbox, Sling Jobs, thread pools, and purge on AEM 6.5 LTS and Adobe Managed Services (AMS).

Variant Scope

  • This skill is 6.5-lts-only (includes AMS).
  • Full JMX access via Felix Console or JMX client.
  • Config changes via Felix Console or OSGi config in repository.

When to use this skill

  • Workflow stuck, not progressing, failed, not starting, task not in Inbox, purge/repository bloat, permissions, queue backlog, thread pool exhaustion, auto-advancement not working.
  • User provides thread dumps, configuration status ZIPs, Sling Job console output, or error.log excerpts.
  • Environment: AEM 6.5 LTS / AMS (JMX available).

Step 1: Map symptom to first action

Symptomsymptom_idFirst action
Workflow stuck (not advancing)workflow_stuck_not_progressingOpen instance; note current step type. No work item → stale.
Task not in Inboxtask_not_in_inboxConfirm Participant step; assignee = logged-in user; Inbox filters.
Workflow not starting (launcher)workflow_not_starting_launcherLauncher enabled; path/event match payload.
Workflow fails or shows errorworkflow_fails_or_shows_errorInstance history; error.log for instance ID; payload and process.
Step failed, retries exhaustedstep_failed_retries_exhaustedLogs → process.label → JMX retryFailedWorkItems or Inbox retry.
Stale (no current work item)stale_workflow_no_work_itemJMX countStaleWorkflows → restartStaleWorkflows(dryRun=true).
Repository bloat / too many instancesrepository_bloat_too_many_instancesJMX purgeCompleted(dryRun=true) or Purge Scheduler.
User cannot see or complete itemuser_cannot_see_or_complete_itemAssignee/initiator/superuser; enforce flags.
Cannot delete modelcannot_delete_modelJMX countRunningWorkflows → terminate → delete.
Slow throughput / queue backlogslow_throughput_queue_backlogJMX returnSystemJobInfo; queue.maxparallel on Granite Workflow Queue; Sling thread pool.
Auto-advancement not workingworkflow_auto_advance_failureCheck default thread pool saturation; Sling Scheduler; timeout jobs.
New workflow not workingworkflow_setup_validationModel sync, launcher, process registration, permissions.

Step 2: Decision tree (workflow stuck)

  1. No current work item? → Stale. JMX: countStaleWorkflows → restartStaleWorkflows(dryRun=true).
  2. Participant step → Assignee exists? Inbox visible? Payload accessible? Dynamic participant resolver returning correct user?
  3. Process step → Search error.log for instance ID. Check: process.label registered, payload path exists, bundle active, no exception in execute().
  4. OR/AND Split → Condition evaluates correctly? Routes exist? No dead-end branches? Model synced?

Step 3: Thread dump & thread pool analysis

Thread dumps on 6.5 / AMS are obtained via jstack or by requesting from AMS support. Configuration status ZIPs from Felix Console → Status → Configuration Status.

3a. Sling default thread pool (critical path)

The Sling Scheduler ApacheSlingdefault uses ThreadPool: default. This pool runs:

  • Oak observation events
  • All Quartz-scheduled jobs — including the workflow timeout-detection scheduler that emits com/adobe/granite/workflow/timeout/job events to the Sling Job system (the job itself then runs on the Granite Workflow Queue, see Step 3c)

Check the Sling Thread Pools status page (/system/console/status-slingthreadpools):

FieldHealthyProblem
active count< max pool size= max pool size (saturated)
block policyRUNABORT (rejects tasks when full)
max pool sizesized for workloadOOTB on AEM 6.5 LTS is 5/5 (Apache Sling default). Bump to 20+ in OSGi config for environments with many custom periodic schedulers, otherwise schedulers can starve.

If active count = max pool size AND block policy = ABORT:

  • New scheduled tasks (including workflow timeout/auto-advance jobs) are silently rejected
  • This is the #1 cause of auto-advancement failure

Check the Threads status page (/system/console/status-Threads) or the jstack thread dump (/system/console/status-jstack-threaddump):

  • Search for sling-default- threads
  • If all threads show same stack (e.g. stuck on HTTP call, database, or external service), that's the blocking culprit
  • Note elapsed time — threads stuck for hours indicate a hung external call without timeout

3b. Sling Job thread pool

Check Apache Sling Job Thread Pool in the Sling Thread Pools status page:

  • active count vs max pool size
  • If saturated, Sling Jobs cannot execute (workflow jobs stall)

3c. Granite Workflow Queue

Check the Sling Jobs page (/system/console/slingevent):

FieldHealthyProblem
Queued Jobs (overall)0> 0 (jobs waiting)
Failed Jobs0> 0 (step failures)
Active Jobs0-N0 when Queued > 0 (jobs not picked up)

Check topic statistics for workflow model:

  • Topic: com/adobe/granite/workflow/job/var/workflow/models/<modelName>
  • High Failed Jobs / low Finished Jobs ratio → process step throwing exceptions

Check Granite Workflow Queue configuration:

  • Type: Topic Round Robin
  • Max Parallel: 0.5 OOTB on AEM 6.5 LTS (50% of available CPU cores). Increase for throughput on bursty workloads. Verify the running value at /system/console/configMgr/org.apache.sling.event.jobs.QueueConfiguration~workflow before assuming.
  • Max Retries: 10

3d. Sling Scheduler

Check the Sling Scheduler status page (/system/console/status-slingscheduler):

  • This page lists Quartz-style schedulers, not Sling Job topics. On OOTB AEM 6.5 LTS the workflow-related entry visible here is the periodic WorkflowStatsMBean collector (used by the Statistics MBean) — its nextFireTime should be in the near future; nextFireTime: null means the trigger was deregistered.
  • The com/adobe/granite/workflow/timeout/job topic itself is a Sling Job, not a Quartz job — check it on the Sling Jobs page (/system/console/slingevent), not here.
  • Confirm ApacheSlingdefault uses ThreadPool: default — that's how the periodic timeout-detection scheduler reaches the workflow engine.

Step 4: Error log patterns

PatternCauseAction
Error executing workflow stepProcess step exceptionCheck stack; fix process code or payload
getProcess for '<name>' failedNo WorkflowProcess registeredDeploy bundle; match process.label
Cannot archive workitemArchive failure → stale riskJMX restartStaleWorkflows
refreshing the session since we had to wait for a lockLock contentionTune queue.maxparallel on the Granite Workflow Queue (Apache Sling Job Queue Configuration); reduce concurrent writes to the same path
Terminate failed / Resume failed / Suspend failedPermissions (not initiator/superuser)Check enforceWorkflowInitiatorPermissions; add to superusers
PathNotFoundException (workflow/payload)Payload/launcher path missingVerify payload exists; check launcher config path
Error adding launcher configLauncher config path not createdCreate /conf/global/settings/workflow/launcher/config
retrys exceeded - remove isTransientTransient workflow failed after retriesFix process code; instance persisted for admin handling
RejectedExecutionExceptionThread pool full with ABORT policyIncrease pool size or change policy to RUN; fix stuck threads
Workflow is already finishedTerminate on completed/aborted instanceCheck logic calling terminate
Workflow purge '<name>' : repository exceptionPurge JCR errorCheck permissions; repo health

Step 5: Configuration checklist

In Felix Console → OSGi → Configuration (/system/console/configMgr):

ConfigPropertyCheck
WorkflowSessionFactorycq.workflow.job.retryDefault 3; increase for flaky steps
WorkflowSessionFactorycq.workflow.superuserMust include admin users/groups (OOTB list includes admin, administrators, workflow-process-service, workflow-service, workflow-administrators, wcm-workflow-service)
WorkflowSessionFactorygranite.workflow.enforceWorkitemAssigneePermissionstrue (OOTB) = only assignee sees items
WorkflowSessionFactorygranite.workflow.enforceWorkflowInitiatorPermissionstrue (OOTB) = only initiator (or superuser) can terminate/suspend/resume
WorkflowSessionFactorygranite.workflow.inboxQuerySizeMax work items returned per Inbox query. OOTB 2000; raise if heavy users hit the cap
WorkflowSessionFactorygranite.workflow.maxPurgeSaveThresholdOOTB 20 — commit after this many purged instances. Raise carefully to reduce JCR overhead during large purges
WorkflowSessionFactorygranite.workflow.maxPurgeQueryCountOOTB 1000 — JCR query batch size during purge. Tune with above
Granite Workflow Queue (org.apache.sling.event.jobs.QueueConfiguration~workflow)queue.maxparallelReal parallelism knob. OOTB on AEM 6.5 LTS is 0.5 (50% of CPU cores). Adobe's Workflows Best Practices recommends between half and three-quarters of processor cores. cq.workflow.job.max.procs displayed in Felix Config Manager is an orphaned metatype label with no code path that reads it (verified against source on release/660 and prod/cq660) — do not rely on it. Verify the running value at /system/console/configMgr/org.apache.sling.event.jobs.QueueConfiguration~workflow
DefaultThreadPool (name=default)block policyOOTB RUN. ABORT would silently drop workflow timeout jobs — keep RUN unless you have a specific reason
DefaultThreadPool (name=default)max pool sizeOOTB on AEM 6.5 LTS is 5 (Apache Sling default). Bump to 20+ for environments with many custom periodic schedulers; otherwise the pool can starve under load
Purge Scheduler (com.adobe.granite.workflow.purge.Scheduler)scheduledpurge.daysold30 default; tune per environment. Factory PID — deploy one config per schedule
Purge Schedulerscheduledpurge.workflowStatusArray-typed; e.g. ["COMPLETED"]

Step 6: Remediation quick reference

Action6.5 LTS / AMS approach
Retry failed work itemJMX retryFailedWorkItems or Inbox Retry
Restart stale workflowsJMX restartStaleWorkflows(dryRun=true) then execute
Purge completedJMX purgeCompleted(dryRun=true) or Purge Scheduler
Increase parallelismFelix Console: queue.maxparallel on the Granite Workflow Queue (Apache Sling Job Queue Configuration); or OSGi config in repo
Fix thread pool exhaustionRestart instance (immediate); fix stuck scheduler code; change block policy to RUN
Fix process not foundDeploy bundle; process.label must match; Sync model
Fix auto-advancementVerify default pool not saturated; timeout jobs scheduled; block policy = RUN

Step 7: Key JMX MBeans

All workflow maintenance and diagnostic operations live on a single MBean: com.adobe.granite.workflow:type=Maintenance. A separate MBean — com.adobe.granite.workflow:type=Statistics — exposes time-series workflow execution metrics for trend analysis.

MBeanOperationsPurpose
com.adobe.granite.workflow:type=MaintenancepurgeCompleted(model [optional], days, dryRun), purgeActive(model [optional], days, dryRun), countRunningWorkflows(model [optional]), countCompletedWorkflows(model [optional]), countStaleWorkflows(model [optional]), restartStaleWorkflows(model [optional], dryRun), retryFailedWorkItems(dryRun, model [optional]), terminateFailedInstances(restart, dryRun, model [optional]), returnSystemJobInfo(), returnWorkflowQueueInfo(), returnWorkflowJobTopicInfo(), returnFailedWorkflowCount(model [optional]), returnFailedWorkflowCountPerModel(), listRunningWorkflowsPerModel(), listCompletedWorkflowsPerModel(), fetchModelList()Purge, stale detection/restart, retry failed items, bulk terminate, queue/job diagnostics, per-model counts and enumeration
com.adobe.granite.workflow:type=StatisticsgetResults, clearRecords; plus get/set accessors for DataLifeTime, DataFidelityTime, DataProcessRate, DataRateTime-series workflow execution statistics

Always use dryRun=true first before executing destructive purge or retry operations.


Step 8: Common root cause patterns (from real incidents)

Pattern A: Thread pool starvation → auto-advance failure

Symptom: Workflow auto-advancement stops; timeout jobs not firing; workflows stuck at participant step despite timeout configured.

Root cause chain:

  1. Custom scheduler (e.g. AccessTokenScheduler) makes blocking HTTP call without timeout
  2. concurrent = true allows overlapping executions on each cron trigger
  3. Each stuck execution consumes a default pool thread indefinitely
  4. All pool threads consumed (OOTB on AEM 6.5 LTS that's only 5; environments hardened for throughput typically run with 20+) → pool saturated
  5. If block policy has been changed to ABORT (OOTB is RUN), new Quartz triggers are rejected silently; on RUN they instead pile up on the caller thread and back-pressure the dispatch
  6. The workflow timeout-detection scheduler cannot dispatch new com/adobe/granite/workflow/timeout/job events
  7. Auto-advancement never happens

Diagnosis checklist:

  • Sling Thread Pools page (/system/console/status-slingthreadpools): Pool default → active count = max pool size?
  • Sling Thread Pools page: Pool default → block policy = ABORT?
  • Threads page (/system/console/status-Threads) or jstack: All sling-default-* threads stuck on same stack?
  • Sling Jobs page (/system/console/slingevent): Workflow job topic has high Failed Jobs?
  • Sling Scheduler page (/system/console/status-slingscheduler): ThreadPool = default for ApacheSlingdefault?

Fix: Restart instance (immediate); fix scheduler code (add HTTP timeout, set concurrent=false); change pool policy to RUN; increase pool size.

Pattern B: High workflow job failure rate

Symptom: numberOfFailedJobs >> numberOfFinishedJobs for a workflow topic.

Root cause: Process step exception, payload deleted, or process not registered.

Diagnosis: Search error.log for Error executing workflow step + model name. Check process.label in Felix Console → OSGi Components.

Pattern C: Stale workflows accumulating

Symptom: Workflows in RUNNING state but no work items; Inbox empty despite running instances.

Root cause: Cannot archive workitem during transition; JCR session crash during step completion.

Diagnosis: Search for Cannot archive workitem; JMX countStaleWorkflows; restartStaleWorkflows(dryRun=true).


References

  • For runbook locations: see reference.md [blocked]

來源與署名

來源:adobe/skills位於plugins/aem/6.5-lts/skills/aem-workflow/workflow-debugging提交940b879

授權條款: Apache-2.0

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架