Command Line Interface

usage: igwn-alert [-h] [--no-auth] [-g GROUP] [-c CONSUMER_GROUP] [-j]
                  [-l {critical,error,warning,info,debug}] [-n NETRC]
                  [-p PORT] [-r] [-s SERVER] [-t LISTEN_RETRIES] [-u USERNAME]
                  [-w RETRY_WAIT] [-V]
                  {listen,subscriptions,topics,unsubscribe,send} ...

Positional Arguments

action

Possible choices: listen, subscriptions, topics, unsubscribe, send

sub-command help

Named Arguments

--no-auth

If set, disable authentication.

Default: False

-g, --group

GraceDB group name (e.g., gracedb, gracedb-playground)

Default: “gracedb”

-c, --consumer-group

Consumer group ID to use for consuming messages across sessions

-j, --jsonpp

Output pretty print json

Default: False

-l, --log

Possible choices: critical, error, warning, info, debug

Log level

Default: “error”

-n, --netrc

netrc file (default: read from NETRC environment variable or ~/.netrc)

-p, --port

igwn-alert server port

Default: 9092

-r, --retry-on-fatal

reconnect listener on fatal exceptions

Default: False

-s, --server

igwn-alert server hostname

Default: “kafka://kafka.scimma.org/”

-t, --listen_retries

fatal reconnect retry attempts

Default: 3

-u, --username

User name (default: look up in auth.toml or .netrc)

-w, --retry_wait

fatal reconnect retry attempts

Default: 0.1

-V, --version

show program’s version number and exit

Sub-commands

listen

Listen for igwn-alert messages and print them to stdout.

igwn-alert listen [-h] [topics ...]

Positional Arguments

topics

a pubsub topic or list of topics (e.g. cbc_gstlal)

subscriptions

List your subscriptions

igwn-alert subscriptions [-h]

topics

List available pubsub topics

igwn-alert topics [-h]

unsubscribe

Unsubscribe from one or more topics

igwn-alert unsubscribe [-h]

send

publish contents of a file to a pubsub topic

igwn-alert send [-h] topic [topic ...] alertfile [alertfile ...]

Positional Arguments

topic

a pubsub topic (e.g. cbc_gstlal)

alertfile

name of the file with the alert to send