- 4 minutes to read

Release Notes

Configuration of the Nodinite Pickup Log Events Service Logging Agent

This guide provides step-by-step instructions for configuring the Nodinite Pickup Log Events Service Logging Agent. With proper configuration, you can collect Nodinite JSON Log Events from any supported source, enabling true end-to-end logging and monitoring.

Configuration File Overview

Note

This paragraph applies to versions <7.1.x. Later versions include a Remote Configuration feature that allows configuration via the Nodinite web interface (Web Client).

The agent uses a JSON configuration file named Settings.json.

Default path:

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

Important: You must restart the Nodinite Pickup Log Events Service Logging Agent after making any changes to the configuration file for updates to take effect.

Regardless of the intermediate storage source, the following sections apply to all configurations:

Specific Configurations

The agent supports the following specific configurations:

Tip

Use a matching Nodinite Monitoring Agent to monitor the health and performance of the Nodinite Pickup Log Events Service Logging Agent and its configurations.

General

The General section contains global settings that affect the internal behavior of the Nodinite Pickup Log Events Service Logging Agent.

Property Description Value Example Comment
Environment Name of the environment where the agent runs Test, Prod, QA
Debug Enables detailed diagnostics logging true or false (default) Set to false in production
Version Internal version number for the configuration file 1.2.3.4 Read only – do not change manually
CultureInfo Formats date and time output SV-SE, EN-us Not currently implemented

Shared Configuration

Property Description Value Example Comment
Enabled Enables or disables logging true or false Temporarily disable pickup service without removing configuration
Log API Address of the Nodinite Log API https://localhost/Nodinite/Dev/LogAPI/ Update as needed for your environment
UseConfigurationDatabase Bypass the LogAPI for high-throughput scenarios true or false Use only for high-performance needs; may increase system load
ConfigurationDatabaseConnectionString Connection string to the Nodinite Configuration database Server=localhost;Database=NodiniteConfig_Dev;Integrated Security=True;Connection Timeout=60;TrustServerCertificate=true

Replace Rules

Info: The Replace Rules section is shared by many configuration options.

ReplaceRules is an array of rules to update provided Endpoints with a new Name or URI, especially when they are dynamic (e.g., contain IDs).

Version 6.0.1.0 and later support named groups and RegEx without a group for advanced use cases.

Property Description Value Example
Name Entry name for documentation
ReplaceName Whether to update the Endpoint Name true (default) or false Not recommended to use with ReplaceUri simultaneously
ReplaceUri Whether to update the Endpoint URI true (default) or false Not recommended to use with ReplaceName simultaneously
Pattern RegEx pattern to match values for replacement /([0-9]{4,})$ Only the first group is replaced unless using named groups
Group1Value New value to write instead of the match Leave blank if using named groups

Replace Rules Examples

Value Pattern Group1Value Result
https://www.nodinite.com/int042/getCustomer/12345 /([0-9]{4,})$ https://www.nodinite.com/int042/getCustomer/{CustomerId}
INT(101) 101 100 INT100
INT101 INT101 INT100 INT100
https://www.nodinite.com/api/envelopes/H1ZUP5uDh/documents/rJxZ8P5OP2/files/CDRS1QQ1U7ul_o7n/url?asObject=true#GET https://www.nodinite.com/api/envelopes/(?\w+)/documents/(?\w+)/files/(?\w+) https://www.nodinite.com/api/envelopes/{envId}/documents/{docId}/files/{fileId}/url?asObject=true#GET

If you do not configure ReplaceRules before deploying, you may end up with many unnecessary Endpoints. Contact Support for help cleaning up.

Replace Rules JSON Examples

Below are example configurations for ReplaceRules:

"ReplaceRules": [
  {
    "Name": "Fix endpoint uri according to RegEx, supports named groups",
    "ReplaceName": false,
    "ReplaceUri": true,
    "Pattern": "https://wwww\\.nodinite\\.com/api/envelopes/(?<envId>\\w+)/documents/(?<docId>\\w+)/files/(?<fileId>\\w+)",
    "Group1Value": ""
  },
  {
    "Name": "Fix Endpoint name according to RegEx, supports named groups",
    "ReplaceName": true,
    "ReplaceUri": false,
    "Pattern": "INT(101)",
    "Group1Value": "100"
  }
]

Example Configuration File

See the Troubleshooting section for a fully populated configuration file.

Next Step