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
Copy

Available Subcommands

  • consumer
  • delete
  • update
  • view
  • object

Default Behavior

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

Bash
Copy

Sample Output

Bash
Copy

Commonly Used Flags

FlagDescription
-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
Copy

Consumer Info

Displays detailed information for a specific consumer.

Bash
Copy

For example:

Bash
Copy

Sample output:

Bash
Copy

Delete Consumer

Deletes a consumer from a stream.

Bash
Copy

To verify deletion, run the consumer list command again.

Delete Stream

Deletes a stream from NATS.

Bash
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:

FlagDescription
-m, --max-bytesMaximum object store size (default: -1)
-r, --replicasNumber of replicas (default: 1)
-t, --ttlTime to live in seconds (default: 86400)
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard