RTFW_MONITOR_CONFIGURATION Structure

RTFW_MONITOR_CONFIGURATION represents the default configuration of the wRTOS Monitoring on Subsystem start.

Syntax

Copy

typedef struct _RTFW_MONITOR_CONFIGURATION(
    size_t Size;
    uint64_t MTBSize;
    bool AutoEnable;
    bool AutoStart;
    bool AutoRotateLogFiles;
    uint64_t MaximumSessionSize;
    TCHAR SessionFolder[MAX_PATH];
    uint32_t MaximumEventsInSession;
    uint32_t MaximumFolderSize;
    uint32_t PreTriggerEventsToSave;    
} RTFW_MONITOR_CONFIGURATION, * PRTFW_MONITOR_CONFIGURATION;

Members

Size

The size of this structure (in bytes). Client code must set this member to sizeof(RTFW_MONITOR_CONFIGURATION) before passing this structure to any function.

MTBSize

The size (in megabytes) of the Monitoring Transport Buffer (MTB), the internal buffer used to transport wRTOS Monitoring Framework events from real-time processors to Windows processors. This value must not exceed three-quarters of the amount of RAM in the machine. If this buffer fills up, monitoring events are lost, and a Data Lost monitoring event is generated. If Data Lost events occur, either enable fewer kinds of monitoring events or increase the size of this buffer (or both).

AutoEnable

Controls whether the wRTOS Monitoring Framework is automatically enabled when the wRTOS Subsystem starts. If this member is TRUE, monitoring is automatically enabled at Subsystem start, otherwise it is not automatically enabled.

AutoStart

Controls whether the wRTOS Monitoring Framework is automatically started when the wRTOS Subsystem starts. If this member is TRUE, monitoring is automatically started at Subsystem start, otherwise it is not automatically started.

IMPORTANT: The Monitoring Framework cannot be auto-started if member AutoEnable is FALSE. Member AutoStart is ignored when member AutoEnable is FALSE.

AutoRotateLogFiles

If TRUE, the wRTOS Monitoring Framework will delete the oldest monitoring session log file when the maximum session folder size is reached. If FALSE, monitoring will automatically stop once the MaximumSessionSize is reached.

MaximumEventsInSession

The number of events to save in a monitoring session.

MaximumFolderSize

The size limit for all monitoring data collected by the Subsystem.

MaximumSessionSize

The maximum size, in megabytes, that a monitoring session folder can occupy on disk. This value must be within the range of 0 MB up to the total free space on the partition. If this value is zero, monitoring events are not written to disk.

PreTriggerEventsToSave

The number of pre-start-trigger events to save in a monitor session. Pre-start-trigger events occur before the event type(s) that triggers the start of a monitoring session.

SessionFolder

The absolute path name of the folder where wRTOS Monitoring Framework session folders are stored. Immediately after product installation, this is %ProgramData%\IntervalZero\Monitor\.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtfwApi.h	RtfwApi.lib