Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

This page presents information about historian diagnostics. This Historian Module relies on other modules when storing the data. For instance, for SQL targets, the final database insertion is executed by the Dataset Tag provider; for external database, such as Canary or Tag Provider Historian tools, the related third party system will perform the access. Therefore, many potential issues regrind data storage are not at the Historian Module level, but related to the external database repository, which requires diagnostics with other specific tools, according to the Target Database. The execution status of the Historian module itself, can be easily monitored using the Module Information diagnostic tools, and the Trace Window tool as described in this Section. When the solution is running and the Designer is connected with the runtime, the Historian Monitor page show basic status of its HistorianTable and an User Interface created using the Trend Chart Control, which allows to monitor historical data.

On this page:

Table of Contents
maxLevel3
stylenone


Image Added


Monitoring the Historian Module

You can access the monitor by navigating to Historian → Historian Monitor.

When the solution is runtime, the monitor will display a Trend Chart page, and a table with the runtime properties of the HistorianTables.

Trend Chart Page 

This TrendChart Page an out-of-box User Interface to monitor Historian Data, created using the same tools available to create displays and the Trend Chart Control.  When creating displays in your application there is template in Charts similar to this one embedded in the Designer. 

Tip

Using a Browser, with no installation required, you can verify the Historian Status of remote server. With the following URL.

http://localhost:3101/html5/?Monitor=Historian

Locahost: shall be replaced by the IP or Computer Network Name of the computer you want to access. The port 3101 shall reflect the Port the Runtime is using, typically it is 3101 for production profile, and 3201 for Development profile. The reaming for the URL remains the same.

Historian Monitor Table Columns

The information in this table is constructed from the runtime properties of the object: Historian.Table.<Name>.  

The properties shown in the monitor table can also be accessed in Displays or Scripts using the following syntax:

@Historian.Table.<Name>.<PropertyName>


HistorianTables Monitor Columns

Column

Description

Namespace

Specifies the namespace the item belongs to.

Name

HistorianTable's name

RowCount

The total number of rows of data stored in the HistorianTable.

SuccessCount

The total number of times the system successfully stored data in the table. 

ErrorCount

The number of times the system failed to save data into the table. 

LastStoredTimeStamp

The timestamp of the last data entry stored in the table.

LastStoredErrorMessage

The last error message encountered.



In this section:

Resolving Common Problems

Using the  Diagnostics Tools

Monitoring Execution Status Within the Application

Local Diagnostic Tools

Module Information: Historian properties

The diagnostic tool Module Information updates in real-time advanced information about the Execution of the Historian Module.

By running the ModuleInformation.exe tool, the section Historian updates the following properties:

Module Information - Historian properties

Property

Example Value

Tables

2

Items

6

OpenStatusMessage

OK

IsDeleting

False

StoreAndForward.IsEnabled

0

UseStoreAndForwardDatabaseAlways

False

HasPairRedudantStoreAndForwardPending

False

Redundancy.LastSyncMessage

Redundancy.LastSyncTimestamp

Redundancy.LastSyncErrorMessage

Redundancy.LastSyncErrorTimestamp

StoreAndForward.IsFixingDatabase

False

StoreAndForward.FixDatabaseMessage

StoreAndForward.FixDatabasePercent

0

StoreAndForward.FixDatabaseElapsedTime

00:00:00

The names of properties are self-explanatory, but in many cases, its exact meaning requires a deeper understanding of the implementation of the module. Contact technical support sending the contents of the table for specific analysis. 

When selecting one Specific HistorianTable in the Tree under Historian, the following information is available:

Module Information - Historian Table propertiesItemValue ExampleTable NameSystemMonitoringNumber of History Items6Number of Rows842InitializationMessageOKTargetDisableFalseTimeDeadband00:00:01LifeTime31SaveOnChangeTrueSaveQualityFalseNormalizedFalseDeletingFalseLastStoredTimeStamp7/29/2022 11:48:04 PM -03:00LastStoredErrorMessageLastDeletedTimeStampLastDeletedErrorMessageLastSamplesSavedID: 842, UTCTimestamp_Ticks: 637947460841150000[7/29/2022 11:48:04.115 PM],
LogType: 1, NotSync: False,
ServerMonitorInfo_TServer__Memory: 155.2265625,
ServerMonitorInfo_TServer__CPU: 0,
ServerMonitorInfo_TRichClient_Memory: 60.98046875,
ServerMonitorInfo_TRichClient_CPU: 0,
ServerMonitorInfo_AllModules_Memory: 69.78515625,
ServerMonitorInfo_AllModules_CPU: 0LastStepDuringSavingUpdate samples: OKErrorCount0SuccessCount603StoreAndForward.IsActiveFalseStoreAndForward.NumberOfRows0StoreAndForward.LastStartedTimeStampStoreAndForward.LastSyncTimeStamp

Historian TraceWindow

The TraceWindow diagnostic tool provides real-time logging of events connected with the Historian Module execution. 

Four level of message can be enabled.

Module Information - Historian properties

Diagnostic Level

Types of messages included

Info

<<<<. Brief description of the types of events captured by this level ========

Warning

Error

Debug

In this section...

Page Tree
root@parent
spacesV10