Hello World Log Event sample (C#)

Get started quickly with Nodinite logging by following this hands-on C# tutorial. Learn how to create, validate, and write Log Events using the Log API, and discover how to integrate with the Pickup Service for robust, asynchronous logging.

What you'll find on this page:

✅ Step-by-step C# sample for logging with the Log API
✅ How to use NuGet to add Nodinite libraries
✅ Full code examples for creating and validating Log Events
✅ Integration with Pickup Service for asynchronous delivery
✅ Best practices for reusable, configurable logging

If you want to get started even faster, download the FileWriterSample to use with the Pickup Service

Illustration: Steps to create, configure, and write a Log Event in C# using the Nodinite Log API.

Please review the Asynchronous Logging user guide if you have not already read it.

If you are not a .NET developer, you can use any programming language. The goal is to produce a JSON based Log Event.

Step 1: Create a new Visual Studio Project

From Visual Studio, create a new Project (we recommend creating a library for reusable code)

Create New Project

Make sure to select .NET Framework 4.5 or later

Step 2: Add NuGet package reference

Nodinite provides multiple libraries and samples on GitHub and NuGet. For this sample, use Nodinite.Libraries.Contracts.LogRestApi from NuGet:

• Nodinite.Libraries.Contracts.LogRestApi
  • MIT License

1. In your project, right-click the solution and select Manage NuGet Packages...
   
2. Add a NuGet Reference to Nodinite.Libraries.Contracts.LogRestApi
   

Click the Install button to add the library to your selected project(s).

If you are using Nodinite, use version 5.x or later. For Integration Manager, use version 4.x.

Step 3: Add custom code

You will now create the Log Event.

The Log Event has three distinct parts:

1. Event details (some mandatory fields)
2. Payload (optional)
3. Context properties (optional)

Illustration: Log Event structure with details, payload, and context properties in Nodinite.

Now in Visual Studio, type LogEvent and add the appropriate using statement by pressing CTRL + . (dot).
![TypeLogEvent][6]
Using Statement for the Log Event.

Create the LogEvent

Let's create a method that creates and returns the Nodinite LogEvent:

private LogEvent CreateNodiniteLogEvent()
{
    return new LogEvent()
    {                
    };
}

Mandatory fields

You must provide the following mandatory fields (see the JSON Log Event user guide for details):

// Required values 
LogAgentValueId = 42,
EndPointName = "INT101: Receive Hello World Log Events",
EndPointUri = "C:\\temp\\in",
EndPointDirection = 0,
EndPointTypeId = LogEventEndPointType.File,
OriginalMessageTypeName = "Hello.World.File/1.0",
LogDateTime = DateTime.UtcNow

Optional Fields example

Below is a fully populated Log Event example:

// Required values 
LogAgentValueId = 42,
EndPointName = "INT101: Receive Hello World Log Events",
EndPointUri = "C:\\temp\\in",
EndPointDirection = 0,
EndPointTypeId = LogEventEndPointType.File,
OriginalMessageTypeName = "Hello.World.File/1.0",
LogDateTime = DateTime.UtcNow,

// Optional values
EventDirection = LogEventEventDirection.ExternalIncoming,
ProcessingUser = "DOMAIN\\user",
SequenceNo = 0,
EventNumber = 0,
LogText = "File OK",
ApplicationInterchangeId = "",
LocalInterchangeId = null,
LogStatus = 0,
ProcessName = "My Process",
ProcessingMachineName = "localhost",
ProcessingModuleName = "INT101-HelloWorld-Application",
ProcessingModuleType = "FilePickup",
ServiceInstanceActivityId = null,
ProcessingTime = 80,

// Add Body (payload)
Body = Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(new { orderid = "123", name = "John Doe" })),

// Add arbitrary Context
Context = new Dictionary<string, string> {
    { "CorrelationId", "064205E2-F7CF-43A6-B514-4B55536C2B67" },
    { DefaultContextProperties.Filename, "Hello.txt" }
}

How do I validate a Log Event?

Use this sample method to validate your Log Event:

private static void ValidateLogEvent(LogEvent logEvent)
{
    if (!logEvent.IsValid(out List<LogReceiptErrorMessage> errorMessages))
    {
        Console.WriteLine("Log Event is not valid!");
        foreach (var errorMessage in errorMessages)
        {
            Console.WriteLine("{0}\t\t{1}", errorMessage.Title, errorMessage.Message);
        }
    }
    else
    {
        Console.WriteLine("Log Event OK!");
    }
}

Create, Validate and write Log Event to file example

Below is the full example:

using Nodinite.Libraries.Contracts.LogRestApi;
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.IO;
using System.Text;

namespace Nodinite.Samples
{
    public class SampleLogEvent
    {
        private LogEvent CreateNodiniteLogEvent()
        {
            return new LogEvent()
            {
                // Required values 
                LogAgentValueId = 42,
                EndPointName = "INT101: Receive Hello World Log Events",
                EndPointUri = "C:\\temp\\in",
                EndPointDirection = 0,
                EndPointTypeId = LogEventEndPointType.File,
                OriginalMessageTypeName = "Hello.World.File/1.0",
                LogDateTime = DateTime.UtcNow,

                // Optional values
                EventDirection = LogEventEventDirection.ExternalIncoming,
                ProcessingUser = "DOMAIN\\user",
                SequenceNo = 0,
                EventNumber = 0,
                LogText = "File OK",
                ApplicationInterchangeId = "",
                LocalInterchangeId = null,
                LogStatus = 0,
                ProcessName = "My Process",
                ProcessingMachineName = "localhost",
                ProcessingModuleName = "INT101-HelloWorld-Application",
                ProcessingModuleType = "FilePickup",
                ServiceInstanceActivityId = null,
                ProcessingTime = 80,

                // Add Body (payload)
                Body = Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(new { orderid = "123", name = "John Doe" })),

                // Add arbitrary Context
                Context = new Dictionary<string, string> {
                    { "CorrelationId", "064205E2-F7CF-43A6-B514-4B55536C2B67" },
                    { DefaultContextProperties.Filename, "Hello.txt" }
                }

            };
        }

        private void ValidateLogEvent(LogEvent logEvent)
        {
            if (!logEvent.IsValid(out List<LogReceiptErrorMessage> errorMessages))
            {
                Console.WriteLine("Log Event is not valid!");
                foreach (var errorMessage in errorMessages)
                {
                    Console.WriteLine("{0}\t\t{1}", errorMessage.Title, errorMessage.Message);
                }
            }
            else
            {
                Console.WriteLine("Log Event OK!");
            }
        }

        public void CreateValidateAndWriteLogEventToFile()
        {
            LogEvent logEvent = CreateNodiniteLogEvent();
            ValidateLogEvent(logEvent);

            string jsonString = logEvent.ToJson();

            using (StreamWriter file = File.CreateText(string.Format("LogEvent_{0}.json", Guid.NewGuid())))
            {
                file.WriteLine(jsonString);
            }
        }        
    }
}

Make sure to customize the code snippet above according to your log needs. Avoid hard coding and use config files and/or parameters to dynamically set the properties.

The file written in the example above is intended to be consumed by the Pickup Service. Make sure to read more in the Asynchronous Logging user guide.

Next Step

• Log Api - Log from code (C# and Java)
• Log Event
  • Context Options
  • Log Status Codes
  • Event Directions
• Endpoints
  • Endpoint Types
  • Endpoint Directions

Related Topics

• Message Types
• Log Agents - Events and messages
• Logging Service - Processes (indexing) the messages
• Log Views - Manage User access to events and messages across platform
• Log Databases - Keep as much data as you like
• Repository Model