Konfiguration
Command Line Argumente
Die Command-Line Argumente nutzen Standardwerte, die mit Environment Variablen konfiguriert, aber per CLI überschrieben werden können.
run Command
Parameter | Beschreibung | Default |
---|---|---|
--console-log-level | Beschränkt das Loglevel der Console auf das Level |
COLLECTOR_CONSOLE_LEVEL; 'info' |
--log-dir | Setzt das Verzeichsis, in dem die Logdateien gespeichert werden. Der Collector legt das Verzeichnis an, wenn es noch nicht existiert. Der Collector muss Schreibrechte auf dem Ordner besitzen. Relative Pfade sind erlaubt und sind relativ zum 'Working directory'. |
COLLECTOR_LOG_DIR; COLLECTOR_WORK_DIR/logs |
dir | Das Ausführungsverzeichnis des Collectors. Der Collector legt Dateien entsprechend des Verzeichnisses an. |
Linux: COLLECTOR_WORK_DIR;'.' Docker: COLLECTOR_WORK_DIR;'/opt/ite-si/collector/tmp/' Windows: COLLECTOR_WORK_DIR;'%APPDATA%\iTE-SI\Collector\' |
--config-dir | Das Konfigurationsverzeichnis des Collectors. Der Collector legt das Verzeichnis und leere Konfigurationsdateien an, wenn es nicht existiert. |
Linux/Windows: COLLECTOR_CONFIG_DIR;$working-dir Docker: COLLECTOR_CONFIG_DIR;'/opt/ite-si/collector/etc/' |
migrate-v1 Command
Setzt eine Collector v1 Konfigurationsdatei (config.toml) in die passenden Collector v2 Konfigurationsdateien um. Weitere Details gibt es über die Command-Line mit dem folgenden Befehl
iTE-SI_Collector migrate-v1 --help
Environment Variables
Variable | Beschreibung |
---|---|
COLLECTOR_CONSOLE_LOG_LEVEL | Gibt den Default Wert für das Console Log Level beim Start des Collectors. |
COLLECTOR_LOG_DIR | Gibt den Default Wert für das Log Verzeichnis an |
COLLECTOR_WORK_DIR | Gibt das Standard-Ausführungsverzeichnis an |
COLLECTOR_CONFIG_DIR | Gibt das Standardverzeichnis für die Konfigurationsdateien (service.toml, objects.toml) an |
Konfigurationsdateien
Der Collector verwendet zwei Konfigurationsdateien: service.toml und objects.json. Die Konfigurationsdateien werden angelegt, wenn Sie nicht existieren. Die 'service.toml' soll manuell editiert werden, die objects.json soll nicht vom Nutzer bearbeitet werden. Diese Datei wird im laufendem Betrieb modifiziert.
service.toml
Beispiel-Konfiguration
version = 1
[general]
hideConsole = false
[http]
port = 8001
token = "unsecure-plaintext-token"
[http.certificate]
certificateFile = "./cert.pem"
keyFile = "./key.pem"
Beschreibung der Felder
Section | Feld | Typ | Optional | Beschreibung | Default |
---|---|---|---|---|---|
version | Internes Format der Json Datei. Dient zum automatischem Upgrade, bei Format Änderungen | 1 | |||
general | hideConsole | bool | Versteckt das Fenster unter Windows. | false | |
http | port | uint16 | Die REST API wird unter diesem Port gestartet | 8001 | |
http | token | string | true | HTTP Bearer Token für Authentifizierung der REST API. Kann weggelassen werden um | |
http.certificate | true | HTTP Zertifikat zur Verwendung von ssl/tls in der REST API | |||
http.certificate | certificateFile | string | Pfad zum HTTPs Zertifikatim PEM-Format. Relativ zum Konfigurationsverzeichnis. | ||
http.certificate | keyFile | string | Pfad zum HTTPs Private Key im PEM-Format. Relativ zum Konfigurationsverzeichnis. Datei darf nicht Passwort geschützt sein. |