system-cep-clocks

Retrieves the CEP clocks registered for each host up to the current time. When an external clock based on log timestamps is used as the basis for CEP context expiration and timeouts, you can check the clock status of each host.

Command properties

ItemDescription
Command typeDriver query
Required permissionNone
License usageNot counted
Parallel executionNot supported
Distributed executionNot supported

Syntax

system-cep-clocks

Output fields

FieldTypeDescription
hoststringHost name
timetimestampCurrent CEP clock time for the host
evict_queue_lenintegerEviction queue length

Error codes

Parse errors

N/A

Runtime errors

N/A

Description

The system-cep-clocks command retrieves the clock status for each host registered in the CEP (Complex Event Processing) engine.

The CEP engine manages per-host external clocks based on log timestamps. These clocks are used to determine the expiration time and timeout of event contexts. You can check the number of event contexts queued for eviction through the evict_queue_len field.

Note
The output field names defined in `getFieldOrder()` (`host`, `time`, `expire_queue_len`, `timeout_queue_len`) differ from the field names assigned in the actual `run()` method (`evict_queue_len`). The actual returned field name is `evict_queue_len`.

Examples

  1. Retrieve CEP clocks by host

    system-cep-clocks
    

    Retrieves the CEP clock status for all currently registered hosts.

  2. Retrieve hosts with non-empty eviction queues

    system-cep-clocks | search evict_queue_len > 0
    

    Filters and retrieves only hosts that have event contexts queued for eviction.