Référence de configuration de l'Agent 1.x

La configuration par défaut de l'agent se trouve dans le fichier /etc/redirectionio/agent.yml.

Configuration minimale

Après avoir installé l'agent, vous devez modifier ce fichier afin d'y insérer le nom de votre instance redirection.io. Voici la configuration minimale :

# name of this instance, mandatory for logging
instance_name: "A UNIQUE NAME"

Référence de configuration

L'agent prend cependant en charge d'autres clés d'option, détaillées dans les sections ci-dessous.

instance_name

• Type: string
• Par défaut: -
• Cette directive est requise

La directive de configuration instance_name permet de donner un nom unique à cette instance d'agent. Vous devez utiliser un nom unique pour ce paramètre parmi tous les agents exécutés pour votre projet. Sinon, l'agent apparaîtra comme mal configuré sur le tableau de bord du projet, et ses logs seront ignorés.

Une bonne idée peut être d'utiliser le nom d'hôte comme instance_name.

listen

• Type: string
• Par défaut: 127.0.0.1:10301
• Cette directive est optionnelle

La directive de configuration listen détermine sur quelle interface l'agent écoute. Elle est par défaut à 127.0.0.1:10301 (port 10301 sur le localhost), mais peut prendre d'autres valeurs :

• /var/run/redirectionio.sock: si vous préférez utiliser un fichier, veuillez vous assurer que l'utilisateur exécutant l'agent (redirectionio, par défaut) a le droit de créer ce fichier
• "": une chaîne vide, si vous voulez que votre agent écoute sur toutes les interfaces réseau, sur le port 10301 (non conseillé)

persist

• Type: boolean
• Par défaut: true
• Cette directive est optionnelle

La directive de configuration persist permet de définir si les règles doivent être stockées sur le disque. Cela permet de redémarrer l'agent avec les règles existantes sans avoir besoin d'appeler le backend de redirection.io, et ajoute bien sûr plus de résilience à votre configuration.

datadir

• Type: string
• Par défaut: /var/lib/redirectionio
• Cette directive est optionnelle

Si la directive persist est activée, datadir définit le répertoire où les règles seront persistées sur le système de fichiers local. Bien sûr, l'utilisateur exécutant redirectionio-agent doit avoir une permission d'écriture sur ce répertoire.

cache

• Type: integer
• Par défaut: 10000
• Cette directive est optionnelle

La directive de configuration cache définit le nombre de versions compilées des règles qui seront stockées en mémoire (RAM). Ce paramètre rend l'agent beaucoup plus rapide, mais peut consommer plus de mémoire sur des ensembles de règles très volumineux s'il est réglé à une valeur élevée.

La valeur par défaut est 10000, ce qui devrait utiliser environ 150-200Mo de mémoire pour un ensemble de règles très volumineux. Il n'est pas nécessaire de définir cette valeur beaucoup plus élevée, car l'agent mettra en cache en priorité les chemins les plus utilisés.

Vous pouvez complètement désactiver le cache mémoire des règles, afin de minimiser l'utilisation de la mémoire, en définissant cache: 0

log

Cette section optionnelle contient des directives pour configurer la journalisation de l'agent. Chaque sous-section est optionnelle et indépendante l'une de l'autre. Si cette section est manquante dans le fichier de configuration, l'agent ne journalisera simplement pas les erreurs ou les avertissements.

file

Cette sous-section peut contenir des directives pour la journalisation de fichiers.

level

• Type: string
• Par défaut: info
• Cette directive est optionnelle

Ceci définit le niveau de verbosité des logs. Il peut s'agir de debug, info, error.

path

• Type: string
• Par défaut: -
• Cette directive est requise

Chemin du fichier de log dans lequel écrire. Veuillez vous assurer que l'utilisateur exécutant l'agent (redirectionio, par défaut) a le droit de créer ce fichier.

syslog

Cette sous-section peut contenir des directives pour la journalisation syslog.

network

• Type: string
• Par défaut: -
• Cette directive est requise

address

• Type: string
• Par défaut: -
• Cette directive est requise

level

• Type: string
• Par défaut: info
• Cette directive est optionnelle

Ceci définit le niveau de verbosité des logs. Il peut s'agir de debug, info, error.

tag

• Type: string
• Cette directive est optionnelle

Ceci permet d'attacher un tag aux logs envoyés à syslog.

Exemple complet

Voici une configuration complète, pour référence :

# Nom de cette instance, obligatoire pour la journalisation
instance_name: "A UNIQUE NAME"

# Interface d'écoute. "" pour toutes les interfaces (non conseillé)
# /run/redirectionio.sock ou 127.0.0.1:10301
listen: 127.0.0.1:10301
#listen: /run/redirectionio.sock # Si vous utilisez un fichier, veuillez vous assurer que l'utilisateur exécutant l'agent a le droit de le créer

# Indique si les règles doivent être stockées sur le disque.
# Cela permet de redémarrer l'agent avec les règles existantes sans avoir besoin d'appeler le backend de redirection.io
persist: true

# Répertoire où les règles seront persistées
datadir: /var/lib/redirectionio

# Nombre d'éléments à stocker en mémoire.
# Cela rend l'agent beaucoup plus rapide, mais consommera plus de mémoire sur des ensembles de règles très volumineux si ce paramètre est élevé
# Avec la valeur par défaut, un ensemble de règles très volumineux devrait consommer environ 150-200 Mo de mémoire
# Définir à 0 pour désactiver le cache et minimiser l'utilisation de la mémoire
# Valeur par défaut: 10000
cache: 10000

# Définit la configuration des logs. Chaque section est optionnelle et indépendante l'une de l'autre.
log:
    file:
        level: debug
        path: /proc/self/fd/2

    syslog:
        # pousse vers le syslog local
        network: "" # chaîne vide
        address: "" # chaîne vide
        level: info
        tag: redirectionio-agent

Fichier de configuration défini au démarrage

Bien que l'agent démarre en utilisant un fichier de configuration /etc/redirectionio/agent.yml ou $HOME/.redirectionio/agent.yml, vous pouvez également passer une option -config-file pour forcer un fichier de configuration donné :

/usr/bin/redirectionio-agent -config-file /path/to/some/configuration/directory/some-config-file.yml