Operations Control Management Console (OCMC) log flags

Warnings

When this flag is enabled, all Web API request warnings, data curation warnings, etc. are logged.

Info

When this flag is enabled:

• On startup, the system settings retrieved from the JSON file are logged. Information including database machine name, database name, type configuration information, etc. is logged.

• On shutdown, information about whether the MES Curator Host service was cleared from the database status table and other information, such as current shutdown status is logged.

Trace

When this flag and the db_status.curate_reference_data flag are enabled, the system logs when the reference data will be curated and, when the reference data is about to be curated, that the reference data is being curated.

In addition, when the service has finished curating reference data, the system logs that curation is complete and the db_status.curate_reference_data flag has been reset.

Note: This flag simply traces whether curation is occurring. This means that every minute it says the curation has started and curation has completed, but does not give details about what reference or event data is curated.

The TraceReferenceDataActivities or TraceEventDataActivities log specific messages related to data curation on reference or event data.

CurateStage-TraceAllActivities

When this flag is enabled, all curation activities are logged including skipped information. The purpose of this flag is to trace all system activities during debugging.

For example, if a Material Class is configured with a frequency of 60 minutes and the MES Curation service runs every minute, the service skips the Material Class if it is not due to be checked in the database. When the flag is enabled, the system will log the skipped curation activity in the logger.

Sample log message:

StagingTasks.CurateAndStageDataAsync. PeriodicDataCuration. Skipped - TypeId:'MaterialClass' (item_class.create) has not elapsed for this time interval for SiteName:Houston, CurrentTimeUtc:2023-08-13 16:07:05 < (earlier than) NextPollTimeUtc:2023-08-13 17:04:00

CurateStage-TraceDatabaseAccess

When this flag is enabled, the MES Curator Host service pings to the database to check whether it can run the curator service are logged.

The purpose of this flag is to trace activities that assess whether the service has access to curate data or not. While multiple MES Curator Host services can run at the same time, only one service is allowed to curate data at any time; however, all of the services can return data for load balancing.

CurateStage-TraceDataDeletions

When this flag is enabled, the hourly deletion of old data is logged.

The purpose of this flag is to trace the events that occur when cleaning up the old data in the staging tables. Currently, any data that is older than five days from the current time is deleted every hour.

CurateStage-TraceEventDataActsWhenDue

When this flag is enabled, and event data is due to be created,all event related activities are logged.

The purpose of this flag is to trace all events (util_history, item_prod, etc.) starting from data curation through to logging the curated information into staging tables.

Note: When this flag is turned on, only the event related activities as defined in the type_config.is_reference_data = false are logged.

CurateStage-TraceReferenceDataActsWhenDue

When this flag is enabled, and reference data is due to be created, all reference data activities, starting from data curation through to logging the curated information into staging tables are logged.

Note: When this flag is turned on, only the reference data related activities as defined in the type_config.is_reference_data = true are logged.

CurateStage-TraceLongRunningTransactions

When this flag is enabled, any curate staging activity that takes longer than the configured amount of time in the system application setting CurationTransactionTimeLimit is logged.

The purpose if the flag is to allow the detection of any curation or staging activity that is consistently taking a long time to complete. A log entry will be created only when an activity takes longer than the configured amount of time.

TraceDeadlockTimeoutRetries

When this flag is enabled, each transaction deadlock or timeout from a stored procedure execution and the corresponding request retries are logged.

The purpose of this flag is to trace any transaction deadlock or a timeout, and all the corresponding retries.

WebApi-EntryExitEventsDataDurations

When this flag is enabled, the entry and exit information for events being retrieved in Web API requests is logged.

This flag only applies to events where data is retrieved from the event data endpoint. The entry information will contain the endpoint and the supplied parameter. The exit information will contain the duration of the request.

The purpose of this flag is to trace the how long the Web API requests are taking.

WebApi-EntryExitReferenceDataDurations

When this flag is enabled, the entry and exit information for reference data being retrieved in Web API requests is logged.

This flag only applies to data retrieved from a reference data endpoint. The entry information will contain the endpoint and the supplied parameter. The exit information will contain the duration of the request.

WebApi-EntryExitMetaDataDurations

When this flag is enabled, the entry and exit information for metadata being retrieved in Web API requests is logged.

This flag only applies to data retrieved from a metadata endpoint. The entry information will contain the endpoint and the supplied parameter. The exit information will contain the duration of the request.

WebApi-LogErrors

When this flag is enabled, all Web API request errors are logged.

Note: In addition, the error information is returned to the requested client.

WebApi-TraceLongRunningTransactions

When this flag is enabled, any Web API request that takes longer than the configured amount of time in the system application setting WebApiTransactionTimeLimit is logged.

The purpose if the flag is to allow the detection of any Web API requests that are consistently taking a long time to complete. A log entry will be created only when an activity takes longer than the configured amount of time.

WebApi-TracePaging

When this flag is enabled, all paging activities in the Web API requests are logged.