Plugins

Hinter dem Punkt Plugins verbirgt sich ein sehr mächtiges Werkzeug. Hier können Sie eigene Skripte erstellen, die sich dann auf von Ihnen ausgewählten Hosts ausführen lassen. Z. B. können Sie dadurch eine Änderung der Firewall-Einstellungen auf allen Systemen gleichzeitig realisieren. Aktuell unterstützen wir die Laufzeitumgebungen Bash (Linux), Python 3 (Linux) und PowerShell (Windows).

Was sind Plugins?

Mit Plugins bezeichnen wir Skripte, die Sie regelmäßig oder als Reaktion auf ein Systemereignis auf Ihren Systemen ausführen können. Sie können Plugins via Tags auf mehreren Systemen oder auch nur auf einzelnen Systemen ausführen. Die Skripte können Sie selber schreiben, für bestimmte Zwecke gibt es aber auch schon Vorlagen.

Parallelität bei der Ausführung von Plugins

Der Agent kann mehrere gleichzeitig geplante Plugins parallel ausführen. Die Standardanzahl parallel ausgeführter Plugins beträgt 10. Diese Einstellung ist konfigurierbar in der Datei config.json im Abschnitt "override" → "plugins", über den Wert "concurrency". Dabei gilt:

• Wert 0 bedeutet, dass die Standardanzahl von 10 parallel ausgeführten Plugins verwendet wird.

• Möchten Sie die Anzahl der parallel ausgeführten Plugins anpassen, können Sie hier einen anderen Wert eintragen.

Ein Beispiel für eine entsprechende Konfiguration in der config.json:

{
  "override": {
    "plugins": {
      "disabled": false,
      "concurrency": 0
    }
  }
}

Bitte beachten Sie, dass bei gleichzeitig geplanten Plugins die von jedem Plugin erzeugte Systemlast berücksichtigt werden muss, um eine Überlastung Ihrer Systeme zu vermeiden.

Plugin-Vorlagen

Auf der Enginsight Plattform finden Sie bereits einige Vorlagen für Plugins. Weitere Vorschläge und Ideen finden Sie unter https://github.com/enginsight.

Plugins erstellen

Um ein neues Plugin zu erstellen, klicken Sie auf “Hosts”, anschließend klicken Sie im linken Side-Menü auf “Plugins” und dann auf “Plugin erstellen”.

Klicken Sie auf das Bild, um es zu vergrößern

Plugins ausführen

Plugins lassen sich entweder regelmäßig ausführen, bspw. um Routineaufgaben abzuarbeiten. Oder sie können autonom auf Systemereignisse reagieren.

Regelmäßige automatische Ausführung: Mittels Cronjob

1. Wählen Sie dafür unter 'Cronjob' entweder einen speziellen Host oder Sie wählen alle Geräte, die Sie mit einem speziellen Tag versehen haben, aus.

2. Mittels Cron-Ausdruck legen Sie den Zeitpunkt für die regelmäßige Ausführung fest. Vergessen Sie nicht, das Häkchen bei 'Geplante Ausführung' zu setzen.

3. Legen Sie die gewünschte Zeitzone fest, nach der sich die automatische Ausführung richten soll.

4. Die Erstellung des Plugins schließen Sie ab, indem Sie oben rechts auf 'Neues Plugin erstellen' klicken.

Beispiel: Backup der MySQL Datenbanken

Eine beliebte Einsatzmöglichkeit für regelmäßig ausgeführte Plugins ist das Durchführen von Backups, bspw. einer MySQL Datenbank.

1. Legen Sie zunächst wie beschrieben ein neues Plugin an. Nutzen Sie folgedes Bash-Script als Vorlage:

#!/bin/bash
# Shell script to backup MySQL database
#==============================================
# Author       : Name
# Organisation : Unternehmen
# Created      : xx.xx.xxx, xx:xx:xx
#==============================================

# Set these variables
MyUSER=""	# DB_USERNAME
MyPASS=""	# DB_PASSWORD
MyHOST=""	# DB_HOSTNAME

# Backup Dest directory
DEST="" # /home/username/backups/DB

# Email for notifications
EMAIL=""

# How many days old files must be to be removed
DAYS=3

# Linux bin paths
MYSQL="$(which mysql)"
MYSQLDUMP="$(which mysqldump)"
GZIP="$(which gzip)"

# Get date in dd-mm-yyyy format
NOW="$(date +"%d-%m-%Y_%s")"

# Create Backup sub-directories
MBD="$DEST/$NOW/mysql"
install -d $MBD

# DB skip list
SKIP="information_schema
another_one_db"

# Get all databases
DBS="$($MYSQL -h $MyHOST -u $MyUSER -p$MyPASS -Bse 'show databases')"

# Archive database dumps
for db in $DBS
do
    skipdb=-1
    if [ "$SKIP" != "" ];
    then
		for i in $SKIP
		do
			[ "$db" == "$i" ] && skipdb=1 || :
		done
    fi
 
    if [ "$skipdb" == "-1" ] ; then
    	FILE="$MBD/$db.sql"
	$MYSQLDUMP -h $MyHOST -u $MyUSER -p$MyPASS $db > $FILE
    fi
done

# Archive the directory, send mail and cleanup
cd $DEST
tar -cf $NOW.tar $NOW
$GZIP -9 $NOW.tar

echo "MySQL backup is completed! Backup name is $NOW.tar.gz" | mail -s "MySQL backup" $EMAIL
rm -rf $NOW

# Remove old files
find $DEST -mtime +$DAYS -exec rm -f {} \;

2. Tragen Sie in das Script Ihren Benutzernamen, Passwort und Hostnamen der MySQL-Datenbank ein. Modifizieren Sie außerdem den Pfad zum Backup-Verzeichnis. Bitte beachten Sie, dass möglicherweise weitere Anpassungen für Ihre Datenbanksysteme notwendig sind.

3. Gehen Sie nun auf 'Cronjob' und wählen Sie 'Geplante Ausführung' sowie den entsprechenden Host. Sie können via Tags das Plugin auch auf mehrere Hosts gleichzeitig schalten.

4. Vergeben Sie einen Cron-Ausdruck, um festzulegen, wann das Backup ausgeführt werden soll. Bspw. * 2 * * 3 für jeden Mittwoch um 2 Uhr nachts.

5. Über 'Neues Plugin erstellen' legen Sie das neue Plugin an. Wenn Sie möchten, können Sie das Plugin testen. Klicken Sie dazu auf 'Testen' und wählen einen gewünschten Host.

Autonome Reaktion auf Systemereignis: Mittels Alarm

1. Erstellen Sie dazu unter Alarme einen neuen Alarm. Wählen Sie unter Referenz denjenigen Host, Endpunkt oder diejenige agentlose Überwachung (Observation), auf dessen Verhalten mit dem Plugin reagiert werden soll.

2. Legen Sie eine Bedingung für die Ausführung des Plugins fest.

3. Vergeben Sie eine Beschreibung.

4. Legen Sie fest, wer über die Ausführung des Plugins benachrichtigt werden soll.

5. Wählen Sie unter Plugins den Host, auf dem das Plugin ausgeführt werden soll und das von Ihnen erstellte Plugin aus.

6. Speichern Sie Ihren Alarm, indem Sie auf 'Alarm hinzufügen' klicken.

Beispiel: Restart Apache Webserver

Erstellen Sie wie beschrieben ein neues Plugin. Nutzen Sie das folgende Bash-Script als Vorlage:

#!/bin/bash
#==============================================
# Author       : Name
# Organisation : Unternehmen
# Created      : xx.xx.xxx, xx:xx:xx
#==============================================

ps auxw | grep apache2 | grep -v grep > /dev/null

if [ $? != 0 ]
then
        /etc/init.d/apache2 start > /dev/null
fi

Legen Sie nun einen Alarm an. In diesem Fall bieten sich zwei Szenarien an, die das Plugin zur Ausführung triggern können. Einerseits, dass der Prozess des Apache Webservers nicht ausgeführt wird, andererseits, dass die Webseite nicht verfügbar ist.

Prozess wird nicht ausgeführt

1. Wählen Sie die Alarmart Host und als Referenz den entsprechenden Server.

2. Legen Sie die Bedingung 'Prozess wird nicht ausgeführt' fest und wählen Sie aus der sich öffnenden Liste den Prozess des Apaches.

3. Vergeben Sie eine Beschreibung und legen Sie fest, wer benachrichtigt werden soll.

4. Wählen Sie den Host, auf dem das Plugin ausgeführt werden soll, in diesem Fall ist das identisch mit der Referenz.

5. Wählen Sie das erstellte Plugin aus und fügen Sie den Alarm hinzu.

Webseite nicht verfügbar

1. Wählen Sie die Alarmart Endpunkt und als Referenz eine Webseite, die auf dem Apache-Webserver läuft. Sollten Sie mehrere Webseiten auf dem entsprechenden Webserver gehostet haben, ist es sinnig, via Tag den Alarm auf alle diese Webseiten zu schalten.

2. Wählen Sie die Bedingung 'Webseite nicht erreichbar'.

3. Vergeben Sie eine Beschreibung und legen Sie fest, wer benachrichtigt werden soll.

4. Wählen Sie den Host, auf dem das Plugin ausgeführt werden soll, d.h. auf dem sich der Apache befindet.

5. Wählen Sie das erstellte Plugin aus und füge den Alarm hinzu.