NETWAYS support collector

The support collector allows our customers to collect relevant information from their servers. A resulting ZIP file can then be provided to our support team for further inspection.

If you are a customer, you can contact us at support@netways.de or netways.de/en/contact/.

WARNING: DO NOT transfer the generated file over insecure connections or by email, it contains potential sensitive information!

Inspired by icinga2-diagnostics.

Usage

WARNING: Some passwords or secrets are automatically removed, but this no guarantee, so be careful what you share.

The --hide flag can be used multiple times to hide sensitive data, it supports regular expressions.

support-collector --hide "Secret:.*" --hide "Password:.*" --enable base

By default, we collect all we can find. You can control this by only enabling certain modules, or disabling some.

If you want to see what is collected, add --verbose.

Usage of support-collector:
  -o, --output string              Output file for the zip content
      --enable strings             List of enabled module (default [base,icinga2,icingaweb2,icinga-director,icingadb,corosync,keepalived,mysql,influxdb,postgresql,ansible,puppet,grafana,graphite])
      --disable strings            List of disabled module
      --hide stringArray           List of keywords to obfuscate. Can be used multiple times.
      --command-timeout duration   Timeout for command execution in modules (default 1m0s)
  -v, --verbose                    Enable verbose logging
  -V, --version                    Print version and exit

Modules

A brief overview about the modules, you can check the source code under modules for what exactly is collected.

Most modules check if the component is installed before trying to collect data.

Base

Module: base

Will collect basic information about your system:

• Kernel and Operating system versions
• CPU, memory, disk and other hardware and vendor information
• Current process and load status
• Status of AppArmor and SELinux
• Repositories

See modules/base/collector.go for details.

Icinga 2

Module: icinga2

• Configuration from /etc/icinga2
• Files in PluginDir
• Package information
• Service status
• Config check result
• Log files from /var/log/icinga2
• Object list for Zone and Endpoint
• Variables like NodeName and ZoneName

See modules/icinga2/collector.go for details.

Icinga Web 2

Module: icingaweb2

• Configuration from /etc/icingaweb2
• Package information
• Log files from /var/log/icingaweb2
• Version for icingaweb2 and its modules, including Git information
• Installed PHP packages and php-fpm service status
• Installed webserver packages

See modules/icingaweb2/collector.go for details.

IcingaDB

Module: icingadb

• Configuration from /etc/icingadb, /etc/icingadb-redis and /etc/icinga2/features-enabled/icingadb.conf
• Service status from icingadb, icingadb-redis and icingadb-redis-server
• Package information
• Journal logs from icingadb, icingadb-redis and icingadb-redis-server

Icinga Director

Module: icinga-director

• Package or Git version information
• Service status
• Health status

See modules/icingadirector/collector.go for details.

Corosync

Module: corosync

• Version
• Service status from corosync and pacemaker
• Configuration from corosync
• Logs from corosync and pacemaker

See modules/corosync/collector.go for detauls

Keepalived

Module: keepalived

• Version
• Service status from keepalived
• Configuration from keepalived

See modules/keepalived/collector.go

MongoDB

Module: mongodb

• MongoDB version
• Package versions
• Service status
• Configuration from /etc/mongod.conf

See modules/mongodb/collector.go for details.

MySQL

Module: mysql

Is looking for standard MySQL or MariaDB installations.

• Mysql version
• Package versions
• Service status
• Configuration files from /etc/my* (depending on the known paths)

See modules/mysql/collector.go for details.

PostgreSQL

Module: postgresql

• PostgreSQL version
• Package versions
• Service status
• Configuration files from /etc/postgresql and /var/lib/pgsql (depending on OS)

See modules/postgresql/collector.go for details.

Ansible

Module: ansible

• Configuration from /etc/ansible
• Package versions

See modules/ansible/collector.go for details.

Puppet

Module: puppet

• Configuration from /etc/puppetlabs
• Package Versions
• Puppet module list

See modules/puppet/collector.go for details.

InfluxDB

Module: influxdb

• Configuration file from /etc/influxdb/config.*
• Package versions
• Service status

See modules/influxdb/collector.go for details.

Grafana

Module grafana

• Configuration files from/etc/grafana and /usr/share/grafana
• Package Versions
• Service status
• grafana-cli version
• grafana-cli plugins list

See modules/grafana/collector.go for details.

Graphite

Module: graphite

• Configuration from:
  • /opt/graphite/conf,
  • /opt/graphite/webapp/graphite/local_settings.py,
  • /etc/carbon
  • /etc/graphite-api*
  • /etc/graphite-web*
• Package versions
• Python and pip version & list
• Process list for *graphite* and *carbon*

See modules/graphite/collector.go for details.

Graylog

Module graylog

• Configuration files from/etc/graylog
• Package Versions
• Service status

See modules/grafana/collector.go for details.

Supported systems

Note: Currently, only Linux is supported by the collector.

Distribution	Supported	Tested	Comment
CentOS / EL	✅️	CentOS 7/8	Should work on all similar enterprise platforms
Debian	✅
Ubuntu	✅
SLES / OpenSUSE	✅

License

Copyright (C) 2021 NETWAYS GmbH

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.