Properties

The Logger module has the following configuration properties:

|Name|Description|ID|Flags| |-| |AutoDeleteDB|Set to TRUE if the database of this module shall be automatically deleted when the module itself is deleted.|1500|Persisted, ExpertPage| |AutoDeleteTrend|Specifies whether trends automatically will be deleted from the database when they are deleted from the namespace of Apis Hive and/or when their global log attribute is set to 'false'.|1475|Persisted, Enumerated, ExpertPage| |AutoLoggerItemIDFilters|A set of item ID wildchar filters that items must satisfy to be automatically logged when their logg attribute goes to true. Only applies when DefaultLogAttributeValue is true!|1610|Persisted, ExpertPage| |Cache size|The size of each cache in bytes, default value is 10040 bytes|1420|Persisted, ReadOnly, ExpertPage| |Database|The public name of the database into which this instance logs data.|1010|Persisted, ReadOnly| |Database pool recycle strategy|

Tells how to recycle the databases in the databasename pool, when Log-switch item triggers a change of active database.

  • None (no database pooling) - reuse existing database name.
    The current database is renamed by appending its creation date and time to its name, and a new database is created having same name as before, or named according to the value of Log-switch new database name item.
    When strategy is None, the Log-switch databasename pool is ignored.
  • Sliding (first always active) - means that the first database in the pool always is the active, a switch simply shifts the history of the first to second, second to third and last to nothing.
    When strategy is Sliding, the Log-switch databasename pool must contain at least one database name.
  • Circular (next in pool active) - means that the next database in the pool will set as the active when a switch is triggered.
    When strategy is Circular , the Log-switch databasename pool must contain at least one database name.
|1718|Persisted, Enumerated, ExpertPage| |DefaultLogAttributeValue|The default value of the global log attribute when added to items. Note! If you change this property, you need to restart the Hive instance to make it take effect.|1600|Persisted, ExpertPage| |FlushingStrategy|Determines the strategy to use when temporarily flushing the whole cache file to disk.|3010|Persisted, Enumerated, ExpertPage| |FreshestValue|When TRUE, all items will be read directly from their physical source to receive the freshest possible values.|2010|Persisted, ExpertPage| |Historylength_Unit|Total length of historical data in database is given by multiplying this property with the Historylength_X property.|1410|Persisted, Enumerated| |Historylength_X|Total length of historical data in database is given by multiplying this property with the Historylength_Unit property.|1400|Persisted| |Log timestamp-filter item|A reference to an item giving a maximum timestamp filter for item value imestamps. Items having timestamps newer than this filter value, will not be logged. Only applies when Recordtype is Eventbased.|1750|Persisted, ApisItem, ExpertPage| |Log-enable item|When the value of this item is 'true', the module is logging timeseries.
When value is 'false', logging is disabled.|1740|Persisted, ApisItem, ExpertPage| |LogOnStart|When 'true' and property RecordType is 'Eventbased...', a sample will be written to the database at every time the mode of the database changes to Online, every time a 'LogEnable' item goes true and everytime the module enters the 'Started' runningstate.|1650|Persisted, ExpertPage| |LogStateResolution|If using any of 'Log-switch item', 'Log-enable item', 'Log-trigger item' or 'Log-switch new database name item' properties, this is the internal polling period in Apis when checking for updated item states.|1690|Persisted, ExpertPage| |Log-switch databasename pool|A pool of databasenames that will be re-used when the Log-switch item toggled. If this pool is empty, the current database name (according to Database-property) will be re-used and the previous database will be set to read-only and renamed by appending the creation-date to its name.|1720|Persisted, ExpertPage| |Log-switch item|

Set to an item that will control when active log/database is switched.

If ie. the current database will be renamed, set in read-only mode and a new database will be started. If set to a boolean item; log switches when value toggles 'false' to 'true'. If set to a non-boolean item; log switches when value changes.

|1700|Persisted, ApisItem, ExpertPage| |Log-switch new database name item|When the database is switched using Log-switch item, and the Database pool recycle strategy is None, the value of this item holds the name of new database to switch to. If the Database pool recycle strategy is other than None, this property is ignored.|1710|Persisted, ApisItem, ExpertPage| |Log-trigger item|Set to an item that will control when data is sampled and stored to the database. If set to a boolean item; data is stored when value toggles 'false' to 'true'. If set to a non-boolean item; data is stored when value changes.|1730|Persisted, ApisItem, ExpertPage| |MaxItems|Maximum number of items (trends) in this database.|1050|Persisted, ReadOnly| |Path|The directory path of the database files.|1020|Persisted, ReadOnly, Folder| |PriorityLevel|Specifies the priority level for the working thread of this ApisLoggerBee instance.|3000|Persisted, Enumerated, ExpertPage| |Recordtype|

This property determines how data logged by this module, is stored to the database:

  • Sampled
    Stores data, without quality info, at a regular time interval given by Resolution
  • Sampled with quality
    Stores data, with quality info, at a regular time interval given by Resolution
  • Eventbased with quality
    Stores data, with quality and timestamp info, whenever data (Value, quality or timestamp) changes. The data is scanned for changes at a regular time interval, given by Resolution
|1210|Persisted, Enumerated| |Resolution|When 'Recordtype' is one of the sampled options, this is the sampling period in seconds. If 'Recordtype' is 'Eventbased with quality', this is the internal polling period in Apis when checking for updated item values.|1300|Persisted|

Informational properties:

|Name|Description|ID|Flags| |-| |CachePath|The path to the location of the cache-file of the database.|301015|InfoPage| |ConfigObserverCookie|The cookie identifying this module amongst the configuration aware clients of Apis Hive.|301400|InfoPage| |Database Handle|The internal handle of this database in Apis Honeystore.|301010|InfoPage| |Disk Usage max|The maximum usage of disk space given in giga bytes on the drive that the database of this module are configured to reside.|301052|InfoPage| |Enabled|When 'true', the module is logging timeseries, when 'false' logging is disabled|301000|InfoPage| |EnabledReason|An explanatory text for the 'Enabled' property.|301001|InfoPage| |LogAttributeID|The global log attribute ID assigned from Apis Hive.|301200|InfoPage| |LogExprAttributeID|The global log expression attribute ID assigned from ApisHive.|301201|InfoPage| |RAM Usage|The usage of physical memory (RAM) in mega bytes for the database of this module.|301050|InfoPage| |TimeSrvEventID - LogState|The time-server EventID assigned from the Apis time server for the LogState timer.|301150|InfoPage| |TimeSrvEventID - Sampler|The time-server EventID assigned from the Apis time server for data-sampling timer.|301100|InfoPage|

Performance properties:

|Name|Description|ID|Flags| |-| |AvgReadTime|The average time in milliseconds spent reading items from Apis Hive.|101010|PerformancePage| |AvgStoreTime|The average time in milliseconds spent storing items to Apis Database.|101020|PerformancePage| |AvgTotalTime|The average time in milliseconds spent in iterating loop.|101030|PerformancePage| |HiveLastUpdCount|The number of items reported as updated at the previous request.|101006|PerformancePage| |NumLogItems|Number of items this ApisLogger instance stores to its database.|101000|PerformancePage| |NumPendingItems|Number of pending items this ApisLogger instance is waiting to get correct meta info, to be able to create and store to its database.|101001|PerformancePage| |PeakReadTime|The maximum time in milliseconds spent reading items from Apis Hive.|101040|PerformancePage| |PeakStoreTime|The maximum time in milliseconds spent storing items to Apis Database.|101050|PerformancePage| |PeakTotalTime|The maximum time in milliseconds spent in iterating loop.|101060|PerformancePage| |UpdSinceQueryTime|The time used when requesting updated items from the Hive.|101005|PerformancePage|

See also Module Properties