gstlal_snax_aggregate
=====================

Command line options
--------------------



.. code-block:: none

   Usage: gstlal_snax_aggregate [--options]
   
   an executable to aggregate and generate job metrics for streaming features
   
   Options:
     -h, --help            show this help message and exit
   
     Aggregator Options:
       General settings for configuring the online aggregator.
   
       -v, --verbose       Print to stdout in addition to writing to
                           automatically generated log.
       --log-level=LOG_LEVEL
                           Sets the verbosity of logging. Default = 10.
       --rootdir=path      Location where log messages and sqlite database lives
       --tag=string        Sets the name of the tag used. Default = 'test'
       --sample-rate=Hz    Set the sample rate for feature timeseries output,
                           must be a power of 2. Default = 1 Hz.
       --processing-cadence=PROCESSING_CADENCE
                           Rate at which the aggregator acquires and processes
                           data. Default = 0.1 seconds.
       --request-timeout=REQUEST_TIMEOUT
                           Timeout for requesting messages from a topic. Default
                           = 0.2 seconds.
       --kafka-server=string
                           Sets the server url that the kafka topic is hosted on.
                           Required.
       --input-topic-basename=string
                           Sets the input kafka topic basename. Required.
       --jobs=JOBS         Specify jobs to process. Can be given multiple times.
       --influx-hostname=INFLUX_HOSTNAME
                           Specify the hostname for the influxDB database.
                           Required if --data-backend = influx.
       --influx-port=INFLUX_PORT
                           Specify the port for the influxDB database. Required
                           if --data-backend = influx.
       --influx-database-name=INFLUX_DATABASE_NAME
                           Specify the database name for the influxDB database.
                           Required if --data-backend = influx.
       --enable-auth       If set, enables authentication for the influx
                           aggregator.
       --enable-https      If set, enables HTTPS connections for the influx
                           aggregator.
       --data-type=string  Specify datatypes to aggregate from 'min', 'max',
                           'median'. Default: max
       --num-processes=NUM_PROCESSES
                           Number of processes to use concurrently, default 2.