Back to Conductor

Server Metrics

docs/documentation/metrics/server.md

2019-04-12-13004.3 KB
Original Source

Server Metrics

!!! Info "Feature Update" Since v3.21.16, Conductor has switched to Micrometer for metrics collection.

Conductor uses Micrometer for metrics collection and export.

The following metrics are published by the Conductor server. You can export these metrics to set up alerts for your workflows and tasks.

Metric NameDescriptionTags
workflow_server_errorThe rate at which server-side errors are occurring.methodName
workflow_failureThe number of failed workflows.workflowName, status
workflow_start_errorThe number of workflows that fail to start.workflowName
workflow_runningThe number of running workflows.workflowName, version
workflow_executionThe time taken for workflow completion.workflowName, ownerApp
task_queue_waitThe amount of time spent by a task in queue.taskType
task_executionThe time taken to execute a task.taskType, includeRetries, status
task_pollThe time taken to poll for a task.taskType
task_poll_countThe number of times the task is being polled.taskType, domain
task_queue_depthThe queue depth for pending tasks.taskType, ownerApp
task_rate_limitedThe current number of tasks that are being rate limited.taskType
task_concurrent_execution_limitedThe current number of tasks that are being limited by its concurrent execution limit.taskType
task_timeoutThe number of timed-out tasks.taskType
task_response_timeoutThe number of tasks that timed out due to responseTimeout.taskType
task_update_conflictThe number of task update conflicts.

For example, a worker updates the task status even though the workflow is already in a terminal state. | workflowName, taskType, taskStatus, workflowStatus | | event_queue_messages_processed | The number of messages fetched from an event queue. | queueType, queueName | | observable_queue_error | The number of errors encountered when fetching messages from an event queue. | queueType | | event_queue_messages_handled | The number of messages executed from an event queue. | queueType, queueName | | external_payload_storage_usage | The number of times an external payload storage was used. | name, operation, payloadType |

Supported monitoring systems

Conductor supports the following Micrometer publishers:

Enabling metrics collection

To enable metrics collection to a particular monitoring system, refer to the Micrometer documentation complete the implementation. You will also need to enable the particular monitoring system in the Conductor's application.properties file.