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:
- ActiveMQs
- AMQP (Apache ActiveMQ Artemis and AMQP 1.0 compliant services)
- AnypointMQs
- BlobContainers
- EventHubs
- Folders
- MSMQs - Not available with version 7.1.x and later
- PostgreSQLs
- Service Bus Queues
- SQLServers
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 – Clean Up Your Dynamic Endpoints Automatically
When services generate dynamic URLs or names (e.g., with IDs), you can quickly end up with hundreds of hard-to-track Endpoints. This clutter makes monitoring and troubleshooting harder.
Replace Rules solve this.
With Replace Rules, you define simple patterns that automatically clean up and standardize endpoint names and URIs before they are logged. This makes your logs easier to read, your dashboards cleaner, and your entire system easier to manage.
[TIP] Use Replace Rules to prevent your environment from being flooded with meaningless endpoint variations.
New 7.x Starting with version 7.x, Replace Rules are managed through the Nodinite Web Client. The settings file is no longer edited manually.
On each intermediate storage configuration (e.g., ActiveMQ, File, Service Bus), you can define multiple Replace Rules. These rules apply to all endpoints processed by that configuration and you can manage then from the Remote Configuration feature in the Nodinite Web Client. Click on the Replace Rules section to add, edit, or remove rules as needed.
Example of Replace Rules management in the Nodinite Web Client.
How It Works
Replace Rules apply a regular expression (RegEx) to the original value, then replace parts of it with readable placeholders. You can apply the rule to either the name or the URI of an endpoint — or both.
New 6.0.1.0 Version 6.0.1.0 and later supports named groups in RegEx, making rules even more powerful.
Replace Rules Table
Property | Description | Example Value |
---|---|---|
Name |
Label to describe what the rule does | Normalize customer endpoint URI |
ReplaceName |
Check to update the Endpoint Name | true |
ReplaceUri |
Check to update the Endpoint URI | true |
Pattern |
RegEx to match values you want to clean | /([0-9]{4,})$ or use named groups |
Group1Value |
Value to insert instead of the matched part (leave blank if using named groups) | {customerId} |
Warning
Avoid using
ReplaceName
andReplaceUri
together in one rule — split into separate rules instead.
Examples
Original Value | Pattern | Group1Value | Result |
---|---|---|---|
https://www.nodinite.com/int042/getCustomer/12345 |
/([0-9]{4,})$ |
{customerId} |
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/(?<envId>\w+)/documents/(?<docId>\w+)/files/(?<fileId>\w+) |
(blank) | https://www.nodinite.com/api/envelopes/{envId}/documents/{docId}/files/{fileId}/url?asObject=true#GET |
:warning: Don’t skip this!
If you ignore Replace Rules during setup, you may end up with thousands of messy Endpoints.
Reach out to Support if you need help cleaning them up.
JSON Examples
"ReplaceRules": [
{
"Name": "Normalize file-based URI with named groups",
"ReplaceName": false,
"ReplaceUri": true,
"Pattern": "https://www\\.nodinite\\.com/api/envelopes/(?<envId>\\w+)/documents/(?<docId>\\w+)/files/(?<fileId>\\w+)",
"Group1Value": ""
},
{
"Name": "Standardize INT name pattern",
"ReplaceName": true,
"ReplaceUri": false,
"Pattern": "INT(101)",
"Group1Value": "100"
}
]
Example Configuration File
💡This applies only to versions < 7.1.x.
See the Troubleshooting section for a fully populated configuration file.