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 rendre l'extension disponible, elle doit être chargée sur le stockage du cluster. L'outil de configuration d'Orchestrator peut le faire via le paramètre -n|--nlog-extensions-folder :

./orchestrator-configurator.sh -n nlogextensions

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

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 à l'aide de l'outil Orchestrator Configurator :

   ./orchestrator-configurator.sh -l nlog.custom.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" }
           }
       }
   }