- 0 minutes to read

A Fully Populated Configuration File (Pickup Service)

Note

This document applies to version < 7.1.x. For version 7.1.x and later, please use the Remote Configuration feature in the Nodinite Web Client.

This page presents a comprehensive example of a fully populated configuration file for the Nodinite Pickup Log Events Service Logging Agent. Use this template to accelerate your setup, ensure best practices, and unlock the full potential of end-to-end logging and integration with Nodinite.

Info

The configuration file is named Settings.json and is located in the root folder of your installation.

Default path:

C:\Program Files\Nodinite\Logging Agent - Pickup Service\Settings.json

The configuration file is written in standard JSON format, making it easy to edit, version, and automate.

Below is a real-world example that demonstrates all available options and supported sources. While your production setup may not require every section, this template helps you understand the flexibility and power of Nodinite logging.

{
  "Environment": "Test",
  "Debug": false,
  "Version": "3.6",
  "CultureInfo": "sv-SE",
  "ActiveMQs": [
    {
      "Enabled": true,
      "LogApi": "http://localhost/Nodinite/LogAPI/",
      "UseConfigurationDatabase": false,
      "ConfigurationDatabaseConnectionString": "Server=.;Database=NodiniteConfig_Dev;Integrated Security=True;Connection Timeout=60;TrustServerCertificate=True",
      "ActiveConsumers": 4,
      "ConnectionString": "tcp://127.0.0.1:61616",
      "Username": "system",
      "Password": "manager",
      "Queue": "Nodinite.LogAgent.PickupService.Test",
      "DeadLetterQueue": "Nodinite.LogAgent.PickupService.Test.DLQ",
      "ReplaceRules": [
        {
          "Name": "Fix Endpoint name to change customer Id to {customerId}",
          "ReplaceName": false,
          "ReplaceUri": true,
          "Pattern": "/([0-9]{4,})$",
          "Group1Value": "{customerId}"
        }
      ]
    }
  ],
  "AMQPs": [
    {
      "Enabled": true,
      "LogAPI": "http://localhost/Nodinite/Dev/LogAPI/",
      "UseConfigurationDatabase": false,
      "ConfigurationDatabaseConnectionString": "Server=.;Database=NodiniteConfig_Dev;Integrated Security=True;Connection Timeout=60;TrustServerCertificate=true",
      "ConnectionString": "amqp://localhost:5672",
      "Username": "artemis",
      "Password": "artemis",
      "Queue": "a1",
      "DeadLetterQueue": "DLQ",
      "ReplaceRules": [
        {
          "Name": "Fix Endpoint name to change customer Id to {customerId}",
          "ReplaceName": true,
          "ReplaceUri": true,
          "Pattern": "/([0-9]{4,})$",
          "Group1Value": "{customerId}"
        }
      ]
    }
  ],
  "AnypointMQs": [
                      {
      "Enabled": true,
      "LogAPI": "http://localhost/Nodinite/Dev/LogAPI/",
      "UseConfigurationDatabase": false,
      "ConfigurationDatabaseConnectionString": null,
      "ActiveConsumers": 1,
      "Username": "nodinite-reader",
      "Password":"1337",
      "Environment": "prod",
      "EnvironmentId" : "f7a16b7b-1337-4cb5-93ba-1e5289f707ec",
      "OrganizationId": "75ec82b6-f930-4ea2-1337-7c56ee24c9d3",
      "UseConnectedApp": true,
      "IsEuPanel": false,
      "ClientId": "9186414a9dc4dfc94c4ccf670d25e4e",
      "ClientSecret": "replaceme",
      "RegionId": "eu-west-1",
      "Queue": "LogEvents",
      "DeadLetterQueue": "LogEvents.dlq",
      "ReplaceRules": null
    }],
  "BlobContainers": [
    {
      "Enabled": true,
      "LogAPI": "http://localhost/Nodinite/Dev/LogAPI/",
      "UseConfigurationDatabase": false,
      "ConfigurationDatabaseConnectionString": null,
      "BlobStorageConnectionString": "DefaultEndpointsProtocol=https;AccountName=xyz;AccountKey=xyz==;EndpointSuffix=core.windows.net",
      "ContainerName": "nodinitelogevents",
      "BackoutContainerName": "nodinitelogeventsbackout",
      "DisableCheckAccessRights": false,
      "RemoveEmptyBlobs": false,
      "ReplaceRules": []
    }
  ],
  "EventHubs": [
    {
      "Enabled": true,
      "LogAPI": "http://localhost/Nodinite/Dev/LogAPI/",
      "UseConfigurationDatabase": false,
      "ConfigurationDatabaseConnectionString": null,
      "EventHubConnectionString": "Endpoint=sb://replaceme.servicebus.windows.net/;SharedAccessKeyName=somename;SharedAccessKey=replaceme-1337=;EntityPath=replaceme",
      "EventHubName": null,
      "StorageContainerName": "event-hub-replaceme",
      "StorageAccountName": "replaceme",
      "StorageAccountKey": "replaceme-42=",
      "ReplaceRules": null
    }],
  "Folders": [
    {
      "Enabled": true,
      "LogApi": "https://localhost/Nodinite/LogAPI/",
      "UseConfigurationDatabase": false,
      "ConfigurationDatabaseConnectionString": "Server=.;Database=NodiniteConfig_Dev;Integrated Security=True;Connection Timeout=60;TrustServerCertificate=True",
      "Folder": "C:\\Temp\\Nodinite.LogAgent.PickupService.Test",
      "BackoutFolder": "C:\\Temp\\BackoutFiles",
      "RemoveEmptyFiles": true,
      "Filter": "*.json",
      "IncludeChildFolders": false,
      "ExcludeChildFolders": [
        {
          "Name": "C:\\Temp\\Nodinite.LogAgent.PickupService.Test\\NotMe"
        }
      ],
      "ReplaceRules": [
        {
          "Name": "Fix Endpoint name to change customer Id to {customerId}",
          "ReplaceName": false,
          "ReplaceUri": true,
          "Pattern": "/([0-9]{4,})$",
          "Group1Value": "{customerId}"
        }
      ]
    }
  ], 
  "MSMQs": [
    {
      "Enabled": true,
      "LogApi": "https://localhost/Nodinite/LogAPI/",
      "UseConfigurationDatabase": false,
      "ConfigurationDatabaseConnectionString": "Server=.;Database=NodiniteConfig_Dev;Integrated Security=True;Connection Timeout=60;TrustServerCertificate=True",
      "ActiveConsumers": 4,
      "Server": "localhost",
      "Queue": "Nodinite.LogAgent.PickupService.Test",
      "DeadLetterQueue": "Nodinite.LogAgent.PickupService.Test.DLQ",
      "ReplaceRules": [
        {
          "Name": "Fix Endpoint name to change customer Id to {customerId}",
          "ReplaceName": false,
          "ReplaceUri": true,
          "Pattern": "/([0-9]{4,})$",
          "Group1Value": "{customerId}"
        }
      ]
    }
  ], 
  "PostgreSQLs": [
    {
      "Enabled": true,
      "LogAPI": "http://localhost/Nodinite/Dev/LogAPI/",
      "UseConfigurationDatabase": false,
      "ConfigurationDatabaseConnectionString": null,
      "ConnectionString": "Server=name.databases.appdomain.cloud;Port=31902;Database=ibmclouddb;User Id=ibm_cloud_user;Password=yoursecretpassword;SSLMode=Prefer;Trust Server Certificate=true",
      "MaxRowsLimit": 500,
      "ReplaceRules": null
    }],   
  "ServiceBusQueues": [
    {
      "Enabled": true,
      "LogAPI": "https://localhost/Nodinite/LogAPI/",
      "UseConfigurationDatabase": true,
      "ConfigurationDatabaseConnectionString": "Server=.;Database=NodiniteConfig_Dev;Integrated Security=True;Connection Timeout=60;TrustServerCertificate=True",
      "ConnectionString": "Endpoint=sb://nodinite.com/servicebus.windows.net/;SharedAccessKeyName=yoursecretkey;SharedAccessKey=ib2+ofZaFyEhbwzgn1nAhw2XDY3UVc1JefdlGgLGIbb=",
      "Queue": "pickup",  
      "ReplaceRules": [
        {
          "Name": "Fix Endpoint name to change customer Id to {customerId}",
          "ReplaceName": false,
          "ReplaceUri": true,
          "Pattern": "/([0-9]{4,})$",
          "Group1Value": "{customerId}"
        }
      ]
    }
  ],     
  "SQLServers": [
  {
      "Enabled": true,
      "LogAPI": "http://localhost/Nodinite/Dev/LogAPI/",
      "UseConfigurationDatabase": false,
      "ConfigurationDatabaseConnectionString": null,
      "ConnectionString": "Server=name.databases.appdomain.cloud;Port=31902;Database=ibmclouddb;User Id=ibm_cloud_user;Password=yoursecretpassword;SSLMode=Prefer;Trust Server Certificate=true",
      "MaxRowsLimit": 500,
      "ReplaceRules": null
    }]                      
}

Next Step

Configure
Pickup Log Events Service Logging Agent

Install Log Agent - Pickup Service
JSON Log Event