Zuletzt Aktualisiert: 22.11.2024
Was ist der Support-Collector und wie funktioniert er?
Der Support-Collector bietet eine einfache Möglichkeit, alle wichtigen Informationen eines Servers und der installierten Softwarekomponenten automatisch zu erfassen. Mit wenigen Befehlen wird eine ZIP-Datei erstellt, die dann unserem Support-Team zur Verfügung gestellt werden kann. Diese Datei enthält umfassende Informationen über den Server und die Softwarekomponenten, so dass wiederholtes Nachfragen nach Details wie Softwareversionen oder Konfigurationen oft nicht mehr notwendig ist.
Welche Daten werden gesammelt?
Um den Schutz der Daten zu gewährleisten, werden Passwörter, Tokens automatisch entfernt, bevor die ZIP-Datei generiert wird. Dateien mit gewissen Endungen (z. B. *.key, *.csr, *.crt, *.pem) werden generell nicht gesammelt. Es ist jedoch ratsam, die gesammelten Informationen vor dem Versand auf sensible Inhalte zu prüfen.
Der Support-Collector unterstützt folgende Module:
- base – Ein Modul das Basisinformationen über den Server sammelt. Dies sind z. B. das installierte Betriebssystem, die Kernel-Version, CPU, Arbeitsspeicher oder laufende Prozesse
- Ansible
- Apache 2
- Corosync
- Elastic
- Foreman
- Grafana
- Graphite
- Graylog
- Icinga 2
- Icinga DB
- Icinga Director
- Icinga Web
- InfluxDB
- keepalived
- MongoDB
- MySQL
- NGINX
- PostgreSQL
- Prometheus
- Puppet
- Redis
Wie installiert man den Support-Collector?
Die Installation des Support-Collectors erfolgt über den NETWAYS Paket-Server. Die folgende Anleitung beschreibt die Schritte für verschiedene Linux-Distributionen. Der Quellcode kann auf GitHub unter NETWAYS/support-collector eingesehen werden.
Installation unter RHEL
Installieren und Konfigurieren des NETWAYS Extras Repositories:
dnf install https://packages.netways.de/extras/epel/9/noarch/netways-extras-release/netways-extras-release-9-2.el9.netways.noarch.rpmInstallation des Support-Collectors:
dnf install netways-support-collectorInstallation unter SLES / OpenSuSE
Installieren und Konfigurieren des NETWAYS Extras Repositories:
zypper ar https://https://packages.netways.de/extras/$releasever/.... .repoInstallation des Support-Collectors:
zypper in netways-support-collectorInstallation unter Debian / Ubuntu
Installieren und Konfigurieren des NETWAYS Extras Repositories:
wget -O - https://packages.netways.de/netways-repo.asc | gpg --dearmor > /etc/apt/trusted.gpg.d/netways.gpg
echo "deb [signed-by=/etc/apt/trusted.gpg.d/netways.gpg] https://packages.netways.de/extras/ubuntu ${DIST} main" > /etc/apt/sources.list.d/netways-extras.list Installation des Support-Collectors:
apt-get install netways-support-collectorWie sammelt man Daten und wie erstellt man die ZIP-Datei?
Nachdem der Support Collector installiert wurde, ist keine weitere Konfiguration erforderlich.
Der Support-Collector sammelt standardmäßig alle relevanten Systeminformationen und speichert sie in einer ZIP-Datei. Du musst keine zusätzlichen Optionen angeben – alles funktioniert direkt nach dem Start.
Ein simpler Aufruf reicht vollkommen aus. Die ZIP-Datei wird in dem Verzeichnis abgelegt in dem du zum Zeitpunkt der Ausführung stehst. Wir empfehlen vor dem Ausführen nach /tmp zu wechseln.
Sobald der Vorgang abgeschlossen ist, wird der Pfad zur generierten ZIP-Datei angezeigt. Diese Datei kannst du überprüfen und an unser Support-Team weiterleiten.
cd /tmp
support-collectorEin Beispiel-Output des Support-Collectors:
[root@testhost ~]# support-collector --disable-wizard
INFO[11:43:22] Detailed collection is enabled
INFO[11:43:22] Could not find ansible. Skipping
INFO[11:43:22] Collecting base system information
INFO[11:43:28] Could not find corosync. Skipping
INFO[11:43:28] Could not find elastic. Skipping
INFO[11:43:28] Could not find foreman. Skipping
INFO[11:43:28] Collecting grafana information
INFO[11:43:30] Could not find graphite. Skipping
INFO[11:43:30] Could not find graylog. Skipping
INFO[11:43:30] Collecting Icinga Director information
INFO[11:43:31] Collecting Icinga 2 information
INFO[11:43:34] Collecting IcingaDB information
INFO[11:43:35] Collecting Icinga Web 2 information
INFO[11:43:40] Collecting InfluxDB information
INFO[11:43:41] Could not find keepalived. Skipping
INFO[11:43:41] Could not find mongodb. Skipping
INFO[11:43:41] Collecting MySQL/MariaDB information
INFO[11:43:43] Could not find postgresql. Skipping
INFO[11:43:43] Could not find prometheus. Skipping
INFO[11:43:43] Could not find puppet. Skipping
INFO[11:43:43] Could not find redis. Skipping
INFO[11:43:43] Collecting webservers information
INFO[11:43:44] Collection complete, took us 22.223 seconds
INFO[11:43:44] Obfuscation replaced 32 token in 13 files (9 definitions)
INFO[11:43:44] Generated ZIP file located at /root/support-collector_testhost_20241122-1143.zipEine detaillierte Übersicht aller möglichen Optionen ist in der README.md auf Github zu finden.
Solltest du Dinge wie z. B. den Output-Pfad oder die verwendeten Module verändern wollen, ist dies über den eingebauten Wizard möglich. Dieser erscheint beim Aufruf des Support Collectors ohne jegliche Optionen
[root@testhost ~]# support-collector
Welcome to the support-collector wizard!
We will guide you through all required details.
If you do not want to use the wizard, you can also pass an answer file containing the configuration.
For more details have a look at the official repository.
https://github.com/NETWAYS/support-collector
The following modules are available:
ansible,base,corosync,elastic,foreman,grafana,graphite,graylog,icinga-director,icinga2,icingadb,icingaweb2,influxdb,keepalived,mongodb,mysql,postgresql,prometheus,puppet,redis,webservers
Filename for resulting zip - (Default: 'support-collector_testhost_20241122-1142.zip'):
Which modules should be enabled? (Comma separated list of modules) - (Default: 'all'):
Enable detailed collection including logs and more (recommended)? [y/n] - (Default: 'true'):
Do you want to define some custom obfuscators (passwords, secrets etc.) [y/n] - (Default: 'false'):Was mache ich wenn ich noch Passwörter gefunden habe?
Der Support-Collector versucht anhand mehrerer Regeln Passwörter, Tokens und sensible Dateien möglichst gut aus den gesammelten Informationen zu entfernen oder gar nicht erst zu sammeln. Solltest du dennoch sensible Informationen finden, kann man diese im Wizard zusätzlich ausschließen.
Do you want to define some custom obfuscators (passwords, secrets etc.) [y/n] - (Default: 'false'): TheSecretIWantToHideFazit
Der NETWAYS Support Collector ist ein flexibles, kleines Tool das im Supportfall dem Kunden als auch uns als Support Engineers und System Engineers hilft schnell und komfortabel an wichtige Informationen zum Server und zur Installation zu kommen. Die Erfahrung zeigt das dadurch eine Vielzahl an Rückfragen vermieden werden können und man zusammen schneller zur Lösung des eigentlichen Problems gelangt.
