Configuration de NLog

Ajout d'extensions NLog

Orchestrator charge les extensions suivantes par défaut, vous n'avez donc pas besoin de les inclure dans le dossier ou la configuration NLog :

• NLog.Targets.ElasticSearch
• UiPath.Orchestrator.Logs.Elasticsearch
• Microsoft.ApplicationInsights.NLogTarget
• NLog.Extensions.AzureEventHub

Seules les extensions compatibles Linux peuvent être utilisées dans cette configuration. Assurez-vous donc que l'extension NLog choisie respecte cette règle.

Pour que l'extension soit disponible, elle doit être téléchargée sur le stockage du cluster. L'outil de ligne de commande uipathctl peut le faire via la commande uipathctl config orchestrator upload :

uipathctl config orchestrator upload --nlog-extensions-directory /path/to/extensions/directory

Si vous utilisez une configuration de stockage externe au niveau du cluster, vous devez l'indiquer en incluant le paramètre --is-external-storage.

Configuration avancée de NLog

Création de la configuration avancée de NLog

1. Créez le fichier nlog.config.json contenant les sections standards : extensions, cibles et règles.
   La section d'extensions est un tableau d'éléments qui spécifient les assemblys d'extension, via assemblyFile, et le chemin de l'assembly.

   Si des plug-ins nlog personnalisés ont été chargés (comme décrit dans Ajout d’extensions NLog), ils seront référencés dans la section extensions.
2. Configurez la cible et la règle dans le fichier nlog.config.json.
3. Appliquez le fichier nlog.config.json en utilisant l'outil de ligne de commande uipathctl :

   uipathctl config orchestrator update-config --nlog-config nlog.custom.json

   Attention : Cette action écrase la configuration NLog personnalisée existante. Vous pouvez vérifier quelle est la configuration existante en utilisant cette commande :

   uipathctl config orchestrator get-config --nlog-config

   Exemple de fichier nlog.config.json qui écrit des journaux dans Azure Blob :

   {   "NLog": {
           "extensions": [
               { "assemblyFile": "NLog.Extensions.AzureBlobStorage.dll" }
           ],
           "targets": {
               "azureBlob": {
                   "type": "AzureBlobStorage",
                   "connectionString": "DefaultEndpointsProtocol=https;AccountName=test;AccountKey=key;EndpointSuffix=core.windows.net",
                   "container": "orchestratorlogs",
                   "blobName": "${date:format=yyyy-MM-dd hh.mm}",
                   "layout": {
                     "type": "JsonLayout",
                     "includeAllProperties": true,
                     "Attributes": [
                       {"name": "ts","layout": "${longdate}"},
                       {"name": "level","layout": "${level:upperCase=true}"},
                       {"name": "logger","layout": "${logger}"},
                       {"name": "message","layout": "${message}"},
                       {"name": "exception","layout": "${onexception:${ui-pretty-exception}}"}
                     ]
                   }
               }
           },
           "rules": { "70_Final": { "writeTo": "stdout,azureBlob" } }
       }
   }

   Exemple de fichier nlog.config.json qui écrit les journaux du robot dans Splunk :

   {
       "Nlog": {
           "extensions": [
               { "assemblyFile": "NLog.Targets.Splunk.dll" },
               { "assembly": "UiPath.Orchestrator.Logs.DatabaseBulk.NLogTarget" }
           ],
           "targets": {
               "Splunk": {
                   "type": "BufferingWrapper",
                   "flushTimeout": 5000,
                   "target": {
                       "type": "SplunkHttpEventCollector",
                       "serverUrl": "http://splunk.example.com",
                       "token": "splunk-token",
                       "channel": "",
                       "source": "${logger}",
                       "sourceType": "_json",
                       "index": "uipath",
                       "retriesOnError": "0",
                       "batchSizeBytes": "0",
                       "batchSizeCount": "0",
                       "includeEventProperties": "true",
                       "includePositionalParameters": "true",
                       "includeMdlc": "true",
                       "maxConnectionsPerServer": "10",
                       "ignoreSslErrors": "false",
                       "useProxy": "false",
                       "proxyUrl": "",
                       "proxyUser": "",
                       "proxyPassword": ""
                   }
               }
           },
           "rules": {
               "20_Robot_Primary": { "writeTo": "Splunk,database,insightsRobotLogs" }
           }
       }
   }

Mise à jour de la configuration avancée de NLog

Les commandes uipathctl nécessaires à la mise à jour de la configuration NLog sont :

• uipathctl config orchestrator get-config --nlog-config : cela exporte la configuration actuelle dans un fichier json à paire clé-valeur, prêt à être modifié.

  Vous pouvez en savoir plus à ce sujet.

• uipathctl config orchestrator update-config --nlog-config nlog.config.json : met à jour la configuration en fonction de vos modifications.

  Vous pouvez en savoir plus à ce sujet.

1. Exportez la configuration NLog personnalisée actuelle vers un fichier json à l'aide de cette commande :

   uipathctl config orchestrator get-config --nlog-config > nlog.config.json

2. Modifiez le fichier nlog.config.json exporté selon vos besoins. Vous pouvez ajouter, supprimer ou modifier l'un de ses paramètres.
   Remarque : vous devez exporter à nouveau le fichier à chaque fois que vous devez effectuer une modification, car la mise à jour écrase tous les paramètres NLog.
3. Mettez à jour la configuration NLog à l'aide de cette commande :

   uipathctl config orchestrator update-config --nlog-config nlog.config.json
   orchestrator config updated