Le paramétrage du portail Nudge APM s’effectue en éditant un fichier au format properties nommé nudge-server.properties
.
L’emplacement par défaut du fichier est le répertoire ~/.nudge/
. Cependant, en utilisant la propriété -Dnudge.properties
au démarrage de la JVM du conteneur sur lequel est déployé le portail Nudge APM, il est possible d’indiquer l’emplacement de ce fichier.
Si un tel fichier n’existe pas au premier démarrage du portail Nudge APM, alors il essaiera de créer le fichier ~/.nudge/nudge-server.properties
avec un contenu par défaut.
L’intégration LDAP est activée avec auth.mode=ldap
, c’est à dire dès lors que la propriété auth.mode
possède la valeur ldap
. Il faut aussi définir une configuration liée aux accès réseau, à la sécurité et au schéma de données.
Voici l’ensemble des propriétés du fichier nudge-server.properties
relatives à la connexion avec un service LDAP
(avec des valeurs d’exemple) :
auth.ldap.url
est le lien de connexion vers le service compatible LDAP. Il doit inclure le protocole et le port de communication en plus du nom de la machine (ou IP).
auth.ldap.bind
est l’utilisateur ou le DN de connexion pour effectuer des recherches d’utilisateurs. Cet identifiant doit avoir les droits nécessaires pour effectuer une recherche d’utilisateur dans le DN mentionné par auth.ldap.dn.user
sur la base des champs mentionnés par auth.ldap.field.login
et auth.ldap.field.email
.
auth.ldap.pass
est le mot de passe correspondant à l’utilisateur référencé par auth.ldap.bind
.
auth.ldap.dn.user
est le DN dans lequel se trouve l’ensemble des données des utilisateurs à considérer. Les recherches d’utilisateurs s’effectueront dans ce DN.
auth.ldap.objectClass
est la classe d’objet du schéma LDAP correspondant à un utilisateur.
auth.ldap.field.email
est le champ de donnée correspondant à l’adresse mèl d’un utilisateur.
auth.ldap.field.login
est le champ de donnée correspondant à l’identifiant de connexion d’un utilisateur. Les valeurs de ce champ seront utilisées par les utilisateurs pour se connecter.
auth.ldap.field.firstname
est une propriété optionelle qui est le champ de donnée correspondant au prénom d’un utilisateur.
auth.ldap.field.lastname
est une propriété optionelle qui est le champ de donnée correspondant au nom d’un utilisateur.
Il est possible d’adapter les rapports à votre société. Vous pouvez facilement modifier l’en-tête, le pied de page et insérer le logo de votre société (en remplacement du logo de Nudge-APM inclus par défaut).
Voici l’ensemble des propriétés du fichier nudge-server.properties
relatives à l’adaptation du document des rapports (avec des valeurs d’exemple) :
reporting.brand.logo.path
est l’emplacement du fichier à utiliser pour afficher le logo affiché en hat à droite de chaque page.reporting.brand.logo.scale
est le facteur de redimenssionnement de ce logo en pourcentage.reporting.brand.legal
est le texte affiché en bas à gauche de chaque page.reporting.brand.contact
est le texte affiché en bas à droite de chaque page.Dans les divers texte de configuration, afin d’insérer des caractères spéciaux, il faut utiliser la syntaxe \uXXXX
où XXXX doit être remplacé par le code unicode hexadécimal correspondant au caractère. Ce code peut être trouvé avec une table de correspondance ASCII. Par exemple, \u00A9
sera utilisé pour avoir le symbole ©.
Il est possible d’utiliser la séquence \n
pour indiquer un saut de ligne.
Voici la structure d’une page de rapport :
Nom du rapport période de temps concernée |
le logoreporting.brand.logo.* |
|
Contenu | ||
reporting.brand.legal |
date et auteur | reporting.brand.contact |