pixel
Select Page

Support Collector

The Support Collector allows our customers to automatically collect all relevant information from their system. A resulting ZIP file can then be made available to our support team. The collected data gives us a detailed overview of the environment, eliminating the need to ask for and collect information about versions or configurations, for example.

When compiling the data, all common passwords and tokens are removed before generating the ZIP file to ensure the necessary security. The collected data is in plain text and should be checked for sensitive content before sending.

Information from the following tools are currently collected by the Support Collector:

  • Base (System information)
  • Icinga 2
  • Icinga Web 2
  • Icinga 2 Director
  • Mysql / MariaDB
  • InfluxDB
  • PostgreSQL
  • Ansible
  • Puppet
  • Graphite
  • Grafana

The source code can be viewed on GitHub at NETWAYS/support-collector.

Usage

By default, Support Collector collects all the data it finds on the system and saves it to a zip file. No further options are required for this. The path to the generated file is output at the end of the call.

$ support-collector

However, it is possible to make user-specific settings if desired.

$ support-collector --help
Usage of support-collector:
-o, --output string Output file for the ZIP content (default "netways-support-20220316-1109.zip")
--enable strings List of enabled module (default [base,icinga2,icingaweb2,icinga-director,mysql,influxdb,postgresql,ansible,puppet,grafana,graphite])
--disable strings List of disabled module
--command-timeout duration Timeout for command execution in modules (default 1m0s)
-v, --verbose Enable verbose logging
-V, --version Print version and exit

Example call including output:

[root@support-collector-demo ~]# support-collector
INFO[0000] Starting NETWAYS support collector version 0.5.1
INFO[0000] Collecting Base system information
INFO[0000] Collecting Icinga 2 system information
INFO[0000] Collecting Icinga Web 2 information
INFO[0003] Could not find Icinga Director
INFO[0003] Collecting MySQL/MariaDB information
INFO[0004] Could not find InfluxDB
INFO[0004] Could not find PostgreSQL
INFO[0004] Could not find ansible
INFO[0004] Could not find puppet
INFO[0004] Could not find grafana
INFO[0004] Could not find graphite
INFO[0004] Obfuscation replaced 21 token in 9 files (4 definitions)
INFO[0004] Collection complete, took us 32.163 seconds
INFO[0004] Generated ZIP file located at /root/netways-support-20220316-1115.zip

Installation

The Support Collector can be installed via the NETWAYS Package Server:

RHEL 7 & Centos 7

$ yum install https://packages.netways.de/extras/epel/7/noarch/netways-extras-release/netways-extras-release-7-1.el7.netways.noarch.rpm
$ yum install netways-support-collector

RHEL 8 & Centos Stream 8

$ dnf install https://packages.netways.de/extras/epel/7/noarch/netways-extras-release/netways-extras-release-7-1.el7.netways.noarch.rpm
$ dnf install netways-support-collector

Debian Buster

$ wget -O - https://packages.netways.de/netways-repo.asc | sudo apt-key add -
$ echo "deb https://packages.netways.de/extras/debian buster main" | sudo tee /etc/apt/sources.list.d/netways-extras-release.list
$ apt update
$ apt install netways-support-collector

Debian Bullseye

$ wget -O - https://packages.netways.de/netways-repo.asc | sudo apt-key add -
$ echo "deb https://packages.netways.de/extras/debian bullseye main" | sudo tee /etc/apt/sources.list.d/netways-extras-release.list
$ apt update

$ apt install netways-support-collector

Ubuntu Bionic Beaver

$ wget -O - https://packages.netways.de/netways-repo.asc | sudo apt-key add -
$ echo "deb https://packages.netways.de/extras/ubuntu bionic main" | sudo tee /etc/apt/sources.list.d/netways-extras-release.list
$ apt update

$ apt install netways-support-collector

Ubuntu Focal Fossa

$ wget -O - https://packages.netways.de/netways-repo.asc | sudo apt-key add -
$ echo "deb https://packages.netways.de/extras/ubuntu focal main" | sudo tee /etc/apt/sources.list.d/netways-extras-release.list
$ apt update
$ apt install netways-support-collector

In addition to the official NETWAYS package sources for the Support Collector, binaries of the tool are provided in GitHub with each release.