Notifications Remote Syslog

Aperçu

• Source: https://tools.ietf.org/html/rfc5424
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • Corps: 32768
• Créer votre URL Apprise

Configuration du compte

Remote Syslog permet aux equipements reseau d’envoyer des messages d’evenement vers un serveur de journalisation, generalement appele serveur Syslog. Le protocole Syslog est pris en charge par un large eventail d’equipements et peut etre utilise pour journaliser differents types d’evenements.

Syntaxe

La syntaxe valide est la suivante :

• rsyslog://{host}
• rsyslog://{host}:{port}
• rsyslog://{host}/{facility}
• rsyslog://{host}:{port}/{facility}

Vous pouvez par exemple remplacer la facility par defaut sur un serveur syslog distant (rsyslog) comme ceci :

• rsyslog://localhost/local5

Détail des Paramètres

Variable	Obligatoire	Description
host	Non	Nom d’hote du serveur Syslog distant.
port	Non	Port associe a votre serveur rsyslog. Si aucune valeur n’est fournie, le port 514 est utilise par defaut.
facility	Non	Facility a utiliser ; la valeur par defaut est user. Les options valides sont kern, user, mail, daemon, auth, syslog, lpr, news, uucp, cron, local0, local1, local2, local3, local4, local5, local6 et local7.
logpid	Oui	Inclut le PID dans la sortie de journalisation.

Paramètres Globaux

Variable	Description
overflow	Ce paramètre peut être défini sur split, truncate ou upstream. Il détermine la manière dont Apprise remet le message que vous lui transmettez. Par défaut, il vaut upstream. 👉 upstream : ne fait aucune modification et transmet le message exactement tel qu’il a été reçu au service. 👉 truncate : veille à ce que le message tienne dans la limite amont documentée par le service. Si plus d’informations sont fournies que la limite définie, l’excédent est tronqué. 👉 split : similaire à truncate, sauf que si le message dépasse la limite amont documentée par le service, il est découpé en plusieurs morceaux plus petits puis envoyés séquentiellement.
format	Ce paramètre peut être défini sur text, html ou markdown. Certains services prennent en charge plusieurs formats de publication du contenu. La valeur par défaut varie selon le service choisi et peut correspondre à l’un de ces trois formats. Vous pouvez facultativement forcer cette option pour vous écarter du comportement par défaut. Si le service ne prend pas en charge plusieurs formats de transmission, ce champ est ignoré.
verify	Les requêtes externes vers des emplacements sécurisés, par exemple via https, utilisent des certificats. Par défaut, Apprise vérifie la validité de ces certificats ; si ce n’est pas le cas, aucune notification n’est envoyée à la source. Dans certains cas, un utilisateur ne dispose pas d’une autorité de certification pour valider la clé ou fait simplement confiance à la source ; dans ce cas, vous pouvez définir ce drapeau sur no. Par défaut, il vaut yes.
cto	Signifie Socket Connect Timeout. Il s’agit du nombre de secondes pendant lesquelles Requests attend que votre client établisse une connexion avec une machine distante, ce qui correspond à l’appel connect() sur la socket. La valeur par défaut est de 4.0 secondes.
rto	Signifie Socket Read Timeout. Il s’agit du nombre de secondes pendant lesquelles le client attend que le serveur envoie une réponse. La valeur par défaut est de 4.0 secondes.
emojis	Active la prise en charge des emojis, par exemple :+1: qui sera traduit en 👍. Par défaut, cette option vaut no. Remarque : selon la configuration côté serveur, l’administrateur peut désactiver globalement la prise en charge des emojis ; mais par défaut, ce n’est pas le cas.
tz	Identifie le fuseau horaire de la base IANA que vous souhaitez utiliser. Par défaut, celui-ci est détecté à partir de la configuration du serveur qui exécute Apprise. Vous pouvez le définir sur des valeurs comme America/Toronto, ou sur tout autre fuseau correctement formaté correspondant à votre région.

Exemples

Envoyer une notification Remote Syslog :

# L'exemple ci-dessous envoie une notification syslog vers la facility `user`
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   rsyslog://localhost

Serveur de Test RSyslog Interne

# Creer un Dockerfile minimal qui lancera notre serveur rsyslog :
cat << _EOF > dockerfile.syslog
FROM ubuntu
RUN apt update && apt install rsyslog -y
RUN echo '\$ModLoad imudp\n \\
\$UDPServerRun 514\n \\
\$ModLoad imtcp\n \\
\$InputTCPServerRun 514\n \\
\$template RemoteStore, "/var/log/remote/%\$year%-%\$Month%-%\$Day%.log"\n \\
:source, !isequal, "localhost" -?RemoteStore\n \\
:source, isequal, "last" ~ ' > /etc/rsyslog.conf
ENTRYPOINT ["rsyslogd", "-n"]
_EOF

# Construire l'image :
docker build -t mysyslog -f dockerfile.syslog .

# Puis la lancer :
docker run  --cap-add SYSLOG --restart always \
  -v $(pwd)/log:/var/log \
  -p 514:514 -p 514:514/udp --name rsyslog mysyslog

# Dans un autre terminal, vous pourrez consulter le repertoire
# `log` cree a l'emplacement depuis lequel vous avez lance la commande.
# Il pourra etre necessaire d'ajuster ses permissions ; le fichier journal
# ne sera cree qu'apres l'envoi d'une notification Apprise.