Logging, version and utilities examples

Miscellaneous examples, such as configuring logging, printing the current version and other utilities.

Miscellaneous examples, such as configuring logging, printing the current version and other utilities.

Sections:

• Getting the current RTI Connext version
• Configuring logging
• Tracking memory usage
• Network monitoring

Getting the current RTI Connext version

Example: print the current version

    Console.WriteLine(Rti.Dds.Core.ServiceEnvironment.Instance.Version);

Configuring logging

Example: change the logging verbosity to warnings

    Rti.Config.Logger.Instance.SetVerbosity(Rti.Config.Verbosity.Warning);

Example: redirect log messages to a file

    Logger.Instance.SetOutputFile("MyLogging.txt");

Example: capture logging messages to customize the output

    // After installing an event handler, all messages logged by RTI Connext
    // will be sent to this handler instead of being printed.
    Logger.Instance.MessageLogged += log =>
    {
        Console.WriteLine($"[RTI Connext Log: {log.Message}]");
        CustomLoggingSystem(log.Message);
    };

Tracking memory usage

Example: enable the heap monitoring utility to track the memory that the middleware uses internally

    // Before any other call to the Connext DDS API:
    var heapMonitor = Rti.Utility.HeapMonitor.Enable();
 
    // Use the API...
    var participant = DomainParticipantFactory.Instance.CreateParticipant(domainId: 0);
    // ...
 
    // TakeSnapshot creates a detailed file that allows tracking the
    // memory allocations performed by the middleware on the native heap
    var snapshot = heapMonitor.TakeSnapshot("heap01.txt", printDetails: true);
    Console.WriteLine($"Initial heap usage is: {snapshot.CurrentHeapUsage}");
 
    participant.Dispose();
 
    snapshot = heapMonitor.TakeSnapshot("heap02.txt", printDetails: true);
    Console.WriteLine($"Final heap usage is: {snapshot.CurrentHeapUsage}");

Network monitoring

Rti.Utility.NetworkCapture allows capturing network traffic that one or more DomainParticipants send or receive. This feature can be used to analyze and debug communication problems between DDS applications.

The Network Capture example in the rticonnextdds-examples GitHub repository shows how to use this feature.