- 0 minutes to read

Add or Manage a Nodinite Log Agent

This step-by-step guide shows you how to configure Nodinite Log Agents for your integration landscape. You'll learn to set up unique identifiers, configure status codes, and integrate with your integration brokers and custom applications.

Tip

New to Log Agents? Start with these conceptual guides:

Before You Begin

When do I need to configure a Log Agent?

  • Initial setup - First time sending events from an integration broker or custom application
  • New environment - Adding production, test, or development environments
  • Platform migration - Moving from BizTalk 2013 to BizTalk 2016, or adding new platforms
  • Status code mapping - Translating platform-specific codes (like BizTalk's numeric codes) to business-friendly descriptions

Warning

Log Agent Value Id is permanent - Once you assign a Log Agent Value Id and start logging events, this identifier must never change. Changing it will break historical event tracking and reporting.

Add or Manage Log Agent Configuration

You can either manage an existing Log Agent or add a new one:

From the Log Agents Overview From Add or Manage Log Agent page
Add Log Agent button in Log Agents Overview Add Log Agent from source menu

New Log Agent configuration form
The Log Agent configuration form with all required and optional fields.

Name (Required)

The Name is the user-friendly display name for this Log Agent. This name appears throughout Nodinite in the Log Agents Overview, Log Views, reports, and dashboards.

Naming best practices:

  • Include platform and environment - Makes it easy to identify the source at a glance
  • Use consistent conventions - Helps when filtering and searching across multiple agents
  • Keep it concise - Avoid overly long names that truncate in UI grids

Example naming patterns:

Pattern Examples Use Case
Platform - Environment BizTalk 2016 - Prod
Azure Logic Apps - Test		 Standard environments
Platform - Location SAP - North Europe
MuleSoft - US East		 Multi-region deployments
Application - Environment iCore - Production
CRM Integration - Dev		 Custom applications
Team - Platform Finance Team - BizTalk
Sales - Azure Functions		 Department-specific

Note

Nodinite automatically creates Log Agent entries with the default name Not Set when it receives the first event from a new Log Agent Value Id. Rename these immediately for clarity.

Log Agent Value Id (Required)

Log Agent Value Id is the permanent unique identifier for this Log Agent configuration. This positive integer value is embedded in every Log Event from this agent, enabling precise tracking and filtering.

[!CRITICAL] This value is permanent - Once set and events are logged, the Log Agent Value Id must never change. Changing it breaks:

  • Historical event queries and reporting
  • Saved filters and Log Views
  • Cross-environment event correlation
  • Business process monitoring and SLA tracking

How Log Agent Value Ids work:

  1. Your integration code or Log Agent includes this Id in every event
  2. Nodinite uses this Id to link events to this specific configuration
  3. Status code mappings, names, and descriptions are applied based on this Id
  4. Historical events remain linked even if you rename the Log Agent

Choosing a Log Agent Value Id:

Strategy Examples Best For
Sequential 1, 2, 3, 4, ... Small environments with few agents
Platform blocks BizTalk: 100-199
Azure: 200-299
Custom: 300-399		 Organized multi-platform landscapes
Environment ranges Prod: 1000-1999
Test: 2000-2999
Dev: 3000-3999		 Environment-based segmentation
Meaningful numbers 1337, 42, 2023 Memorable identifiers for specific projects

Common scenarios:

  • New BizTalk production environment: Assign Id 100, configure status codes for BizTalk-specific codes (success, failure, suspended)
  • Azure Logic Apps test environment: Assign Id 210, map HTTP status codes (200, 404, 500) to Success/Warning/Error
  • Custom .NET application: Assign Id 301, define application-specific status codes from your logging framework

Tip

Document your Id assignment strategy in a shared wiki or configuration management database. This prevents accidental Id collisions when multiple teams configure Log Agents.

Description (Optional)

The Description field provides additional context about this Log Agent configuration. Use this space to document:

  • Purpose - What this Log Agent monitors (e.g., "Tracks all SAP RFC calls for Finance Department")
  • Scope - Which integrations or business processes it covers
  • Contact information - Team responsible for this integration platform
  • Special considerations - Custom logging rules, throttling limits, data retention policies

Example descriptions:

BizTalk 2016 Production - Monitors all EDI 850 Purchase Orders and 810 Invoices.
Owner: Finance IT Team (finance-it@company.com)
SLA: Critical - 24/7 monitoring required

Azure Logic Apps (West Europe) - Customer onboarding workflows for EMEA region.
Includes: Account creation, credit checks, welcome email sequences.
Contact: Customer Success Engineering

Web Site (Optional)

The Web Site field accepts a URL linking to relevant documentation. Common uses:

  • Platform documentation - Link to your BizTalk/MuleSoft/Azure documentation wiki
  • Runbook - Operations manual for this integration platform
  • Architecture diagrams - Confluence/SharePoint page with integration maps
  • Incident management - ServiceNow or Jira project for this platform

Example URLs:

  • https://wiki.company.com/integrations/biztalk-prod
  • https://confluence.acme.com/display/IT/SAP+Integration+Guide
  • https://dev.azure.com/myorg/IntegrationProject

Tip

Keep documentation links up-to-date. Outdated links frustrate teams during incident response.

Configure Log Status Codes

Log Status Codes translate platform-specific numeric codes into human-readable descriptions with visual indicators. This enables:

  • Visual process tracking - Color-coded status in BPM diagrams (green success, red errors, yellow warnings)
  • Business-friendly dashboards - Show "Payment Processing Failed" instead of "Error Code 1042"
  • Rapid troubleshooting - Filter Log Views by Success/Warning/Error instead of memorizing numeric codes
  • Cross-platform consistency - Standardize status meanings across BizTalk, Azure, and custom applications

Note

Status codes are defined per Log Agent because different platforms use different numbering schemes. BizTalk's "0" means success, while your custom app might use "200".

Add Your First Status Codes

When first created, Log Agents have no status codes configured:

Empty Log Status Code list
No status codes configured - click Edit to add mappings.

Click the Edit button to open the status code management dialog:

Add Log Status Code dialog
Click Add to create a new status code mapping.

Edit Status Code Mappings

The status code editor allows you to map platform-specific codes to Nodinite's standard Status Types:

Edit Log Status Code for Log Agent
Configure status code mappings to translate platform codes to business-friendly descriptions.

Required and optional fields:

Required Property Description
Status Type Select one of the predefined Status Type values (None, Information, Success, Warning, Error). This controls the visual indicator color and filtering behavior. See Status Type explanations for details.
Log Status The numeric code logged by your integration platform or custom code. This is the "raw" value from BizTalk tracking, HTTP status codes, or your application's logging framework. Examples: 0, 200, 500, 1042
Description Human-readable text displayed in Log Views, dashboards, and reports. Be specific and business-friendly. Examples: "Payment processed successfully", "Customer validation failed - missing tax ID", "Temporary network timeout - will retry"
Web Site Link to documentation for this specific error code. Useful for complex errors requiring runbook procedures or vendor documentation.

Status Type dropdown selector
Select the appropriate Status Type from the dropdown menu.

Status Types

Nodinite provides five standard Status Types. Choose the one that best represents the outcome:

Status Type Color Use When Example Codes
None Gray Default/unclassified events, informational tracking Milestone markers, audit trails
Information Blue Normal processing steps, non-critical notifications "Order received", "Starting batch job"
Success Green Successful completion, positive outcomes HTTP 200, BizTalk 0, "Payment completed"
Warning Yellow/Orange Non-critical issues, degraded performance, retryable errors HTTP 429 (rate limit), "Database slow", "Retry attempt 2/3"
Error Red Critical failures, unrecoverable errors, data loss HTTP 500, BizTalk suspended, "Payment gateway unavailable"

Tip

For detailed explanations of each Status Type with business process examples, see What is a Log Status Code?

Common Status Code Examples

BizTalk Server:

Log Status Status Type Description
0 Success Message processed successfully
1 Error Message suspended - routing failure
2 Error Message suspended - serialization failure
3 Warning Message retrying - temporary adapter failure

HTTP-based integrations (Azure Logic Apps, REST APIs):

Log Status Status Type Description
200 Success Request completed successfully
201 Success Resource created successfully
400 Error Bad request - invalid input data
401 Error Authentication failed
404 Warning Resource not found - may be expected
429 Warning Rate limit exceeded - will retry
500 Error Server error - investigate immediately
503 Warning Service temporarily unavailable - retry

Custom application (.NET, Java, Python):

Log Status Status Type Description
0 Success Business process completed
1000 Information Process started
1001 Information Validation successful
2000 Warning Customer not found - created new record
2001 Warning Duplicate detected - using existing record
3000 Error Database connection failed
3001 Error External API unavailable
3002 Error Data validation failed - missing required fields

Tip

Start simple - Configure the most critical codes first (success, fatal errors). Add granular codes as monitoring matures.

Save Your Configuration

After configuring your Log Agent and Status Codes, you must save changes for them to take effect:

  • Click Save to persist changes and continue editing
  • Click Save and close to persist changes and return to the Log Agents Overview

Save and Close buttons
Save options - changes take effect on the next synchronization.

Note

New status code mappings and configuration updates are applied during the next synchronization cycle. Existing events in the database are not retroactively updated - only new events use the updated mappings.

Troubleshooting

My Log Agent shows as "Not Set"

Cause: Nodinite automatically creates Log Agent entries when it receives events with a new Log Agent Value Id. The default name is "Not Set".

Solution:

  1. Navigate to Log Agents Overview
  2. Find the "Not Set" entry (it will have the Log Agent Value Id from your application)
  3. Click to edit, rename it descriptively (e.g., "BizTalk 2016 - Prod")
  4. Save changes

Events are not showing the correct status description

Cause: Status code mapping is missing or incorrect.

Solution:

  1. Check your application logs - what numeric status code is being sent?
  2. Edit the Log Agent and verify a status code mapping exists for that number
  3. Ensure the Log Status field exactly matches the numeric code from your logs
  4. Save and wait for the next synchronization

Which Log Agent Value Id should I use?

Cause: Uncertainty about Id assignment strategy.

Solution:

  1. Check if your organization has an Id assignment policy documented
  2. Review existing Log Agents to see what Ids are already in use
  3. Choose a number that doesn't conflict with existing agents
  4. Document your choice in the Log Agent Description and your team wiki

Can I change the Log Agent Value Id after creating it?

Answer: No. Once events have been logged with a specific Log Agent Value Id, changing it will break historical queries and reporting. If you must use a different Id:

  1. Create a new Log Agent with the desired Id
  2. Update your integration code/configuration to use the new Id
  3. Keep the old Log Agent configured (do not delete) so historical events remain queryable
  4. Rename the old agent to "BizTalk 2016 - Prod (DEPRECATED - use Id 150)"

How do I delete a Log Agent?

Answer: You can soft-delete Log Agents from the Log Agents Overview. See Delete Log Agent for details. Deleted agents can be restored if needed.

Warning

Deleting a Log Agent does not delete historical events. Events remain in the database but may display with missing status descriptions until the agent is restored.

Next Steps

After configuring your Log Agent, enable logging in your integration platforms:

Integration Platforms

Custom Development

  • Log API - REST API for C#, Java, Python, Node.js applications
    • Full control over event structure and metadata
    • Recommended for custom business applications
  • Log4Net Appender - .NET applications using log4net framework
    • Add DLLs and configure appender in app.config
    • Minimal code changes required
  • VB6/COM/VBScript - Legacy application support via COM interfaces
    • Enable logging from older systems without rewriting

Advanced Options

Configuration Guides

Log Agents Overview - View, filter, and manage all Log Agents
What is a Log Agent? - End-to-end logging concepts and architecture
What is a Log Status Code? - Visual process tracking and business reporting

Core Services

Logging Service - How Nodinite processes and indexes logged events
Log Views - Control user access to events and messages
Log Databases - Event storage, retention, and archiving
User Management - Role-based access control for Log Views