Monitoring Command Line Reference

This section shows the help output (-h) for the monitoring scripts.

usage: tibkmon-start.py [-h] [--show-supported-server-types]
                        [--show-supported-measurements] [-v]
                        [-kc TIBKMONCONFIG] [-ic INFRACONFIG]
                        [--validate-config] [-g] [-o OUTPUT]
                        [--LOG-LEVEL LOG_LEVEL]

Start TIBCO Apache Kafka Monitoring.

optional arguments:
  -h, --help            show this help message and exit
  --show-supported-server-types
                        Displays all supported server-types which can be
                        monitored.
  --show-supported-measurements
                        Displays all supported measurements for each server-
                        type.By default all measurements are polled.
  -v, --version         Prints TIBCO Apache Kafka Monitoring (TIBKMON)
                        version.
  --validate-config     Validates configuration files added using -kc/--kafka-
                        config & -ic/--infra-config without starting any
                        monitoring services.
  -g, --generate-only   Used in conjunction with -kc/--kafka-config &
                        -ic/--infra-config to generate jmxTrans-JSON
                        configuration file, without starting any monitoring
                        services. The default fila is @
                        /var/tmp/<username>/tibco-tibkmon/JSON on Unix. Can be
                        changed using the -o/--output option.
  -o OUTPUT, --output OUTPUT
                        The directory to place jmxTrans configuration file.
                        The default is /var/tmp/<username>/tibco-tibkmon/JSON
                        on Unix.
  --LOG-LEVEL LOG_LEVEL
                        TIBKMON tool logging. Options: INFO, DEBUG, WARNING,
                        ERROR

required named arguments for starting TIBCO Apache Kafka Monitoring:
  -kc TIBKMONCONFIG, --kafka-config TIBKMONCONFIG
                        YAML configuration file with Apache Kafka cluster
                        configuration and settings.
  -ic INFRACONFIG, --infra-config INFRACONFIG
                        YAML configuration file with Grafana & InfluxDB
                        settings.

usage: tibkmon-status.py [-h] [-v] [--LOG-LEVEL LOG_LEVEL] [-d]

Show status of TIBCO Apache Kafka Monitoring.

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         Prints TIBCO Apache Kafka Monitoring (TIBKMON)
                        version.
  --LOG-LEVEL LOG_LEVEL
                        TIBKMON tool logging. Options: INFO, DEBUG, WARNING,
                        ERROR
  -d, --detailed        Shows the detailed status of InfluxDB, Grafana,
                        jmxTrans & Apache Kafka clusters being monitored.

usage: tibkmon-stop.py [-h] [-v] [--LOG-LEVEL LOG_LEVEL] [-s STOP] [-f]

Stop TIBCO Apache Kafka Monitoring.

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         Prints TIBCO Apache Kafka Monitoring (TIBKMON)
                        version.
  --LOG-LEVEL LOG_LEVEL
                        TIBKMON tool logging. Options: INFO, DEBUG, WARNING,
                        ERROR
  -s STOP, --stop STOP  Service to stop. Can be one of Grafana, InfluxDB,
                        jmxTrans or ALL. Defaults to ALL.
  -f, --flush-status    Flush status values after stopping services.

usage: tibkmon-converter.py [-h] [-v] [--LOG-LEVEL LOG_LEVEL]
                            [-f CSV_FILE_LOC] [-o OUTPUT_DIR]

Helps to convert the old CSV config to the new YAML config.

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         Prints TIBCO Apache Kafka Monitoring (TIBKMON)
                        version.
  --LOG-LEVEL LOG_LEVEL
                        TIBKMON tool logging. Options: INFO, DEBUG, WARNING,
                        ERROR
  -f CSV_FILE_LOC, --config-file CSV_FILE_LOC
                        Old CSV Configuration file with broker access and
                        query information on all brokers. Brokers are polled
                        sequentially.
  -o OUTPUT_DIR, --output OUTPUT_DIR
                        Output directory to place the new YAML config.