C3 AI Documentation Home

C3 AI Console Reference - c3MonitorQueues

c3MonitorQueues shows how many entries are in specific queues at an interval. You can specify one or more queues to be monitored, or default to all queues in your environment. If an interval is not specified, c3MonitorQueues defaults to a 1 minute interval.

Parameters

NameTypeMandatoryDescription
intervalnumberOptionalPolling frequency in milliseconds. Defaults to (1 minute).
queueobjectOptionalQueue instance to be monitored (for example, CronQueue). Defaults to all queues.

Examples

Monitor all queues:

JavaScript
c3MonitorQueues()

Show entries in the cron job queue:

JavaScript
c3MonitorQueues(CronQueue)

Show entries in multiple queues:

JavaScript
c3MonitorQueues(CronQueue, BatchQueue)

Monitor multiple queues at 5-second intervals:

JavaScript
c3MonitorQueues(5000, CronQueue, KafkaQueue)

See also

Was this page helpful?