Events Healthcheck Commands

The events subcommand runs health checks for Pulse ad-events services and displays information from the Pulse Events database (NATS). It enables you to view, manage, and troubleshoot event streams, consumers, and object stores.

To view all available subcommands and flags, run:

Bash
    
xxxxxxxxxx
 
accelo admin hc events --help
Copy

Available Subcommands

consumer
delete
update
view
object

Default Behavior

By default, the following command lists all event streams available in NATS:

Bash
    
xxxxxxxxxx
 
accelo admin hc events
Copy

Sample Output

Bash
    
 
INFO: Running health check for Events DB╔══════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╗║ Events DB                                                                                                                        ║╠════════════════════════════════════════════╦════════════════╦════════╦═════════════════════════════════════════╦═════════════════╣║ STREAM NAME                                ║ TOTAL MESSAGES ║ OFFSET ║ LAST MESSAGE TIMESTAMP                  ║ TOTAL CONSUMERS ║╠════════════════════════════════════════════╬════════════════╬════════╬═════════════════════════════════════════╬═════════════════╣║ hive_queries_events_smokey                 ║              0 ║      0 ║ 0001-01-01 00:00:00 +0000 UTC           ║               1 ║║ impala_agent_events_smokey                 ║           6503 ║   6503 ║ 2025-01-30 11:25:20.135115216 +0000 UTC ║               0 ║║ impala_coord_events_offset_smokey          ║              0 ║      0 ║ 0001-01-01 00:00:00 +0000 UTC           ║               0 ║║ yarn_containers_rminterface_metrics_smokey ║              0 ║      0 ║ 0001-01-01 00:00:00 +0000 UTC           ║               1 ║╚════════════════════════════════════════════╩════════════════╩════════╩═════════════════════════════════════════╩═════════════════╝
Copy

Commonly Used Flags

Flag	Description
-s <stream-name>	Displays detailed information for a specific stream
-d <url>	URL where `ad-events` is running (default: `http://localhost:19009`)

Consumer Commands

List Consumers

Lists all consumers for a given stream.

Bash
    
xxxxxxxxxx
 
accelo admin hc events consumer -s <stream-name>
Copy

Consumer Info

Displays detailed information for a specific consumer.

Bash
    
xxxxxxxxxx
 
accelo admin hc events consumer info -s <stream-name> -c <consumer-name>
Copy

For example:

Bash
    
xxxxxxxxxx
 
accelo admin hc events consumer info -s impala_agent_events_odp_smokey -c impala_coord_odp_smokey
Copy

Sample output:

Bash
    
xxxxxxxxxx
 
╔════════════════════════════════════════════════════════════╗║ Consumer Info                                              ║╠══════════════════╦═════════════════════════════════════════╣║ Consumer Name    ║ impala_coord_odp_smokey                 ║║ Stream Name      ║ impala_agent_events_odp_smokey          ║║ Durable Name     ║ impala_coord_odp_smokey                 ║║ Pending Messages ║ 0                                       ║║ Ack Pending      ║ 0                                       ║║ Waiting          ║ 1                                       ║║ Redelivered      ║ 0                                       ║║ Date Created     ║ 2025-01-31 06:12:46.366355429 +0000 UTC ║╚══════════════════╩═════════════════════════════════════════╝
Copy

Delete Consumer

Deletes a consumer from a stream.

Bash
    
xxxxxxxxxx
 
accelo admin hc events consumer delete -s <stream-name> -c <consumer-name>
Copy

To verify deletion, run the consumer list command again.

Delete Stream

Deletes a stream from NATS.

Bash
    
xxxxxxxxxx
 
accelo admin hc events delete -s <stream-name>
Copy

To confirm deletion, rerun the stream list command.

Update Stream

Updates the configuration of an existing stream.

Bash
    
Copy

For example:

Bash
    
Copy

Sample Output:

Bash
    
Copy

View Stream Data

Displays subject data for a given offset.

Bash
    
Copy

For example:

Bash
    
Copy

Sample Output:

Bash
    
Copy

Object Store Commands

The object subcommand manages NATS object stores associated with events.

List Object Stores

Bash
    
Copy

Sample Output:

Bash
    
Copy

If the name of the object store is provided along with the above mentioned command then it returns object Store info.

Bash
    
Copy

Object Store Info

Displays details for a specific object store.

Bash
    
Copy

Delete Object Store

Deletes an object store, if it exists.

Bash
    
Copy

Watch Object Store

Streams live events for an object store.

Bash
    
Copy

List Objects

Lists all objects in an object store.

Bash
    
Copy

Get Object Data

Loads object data into memory. You can redirect the output to a file if needed.

Bash
    
Copy

Edit Object Store Metadata

Updates object store metadata such as size, replicas, or TTL.

Bash
    
Copy

Available flags:

Flag	Description
-m, --max-bytes	Maximum object store size (default: `-1`)
-r, --replicas	Number of replicas (default: `1`)
-t, --ttl	Time to live in seconds (default: `86400`)

Last updated on

Was this page helpful?