geneos gateway plugins technical reference v1.0 · 2018. 5. 9. · l trusted_api_hosts l...

Geneos Gateway Plugins TechnicalReference

Functional Area: Geneos Gateway Plugins

Geneos Release: v4.6.0.

Document Version: v1.0.0

Date Published: 16 March 2018

Copyright 2018. ITRSGroup Ltd. All rights reserved.

Information in this document is subject to change without notice. The software described in this document is furnished under a license agreement

or nondisclosure agreement. The softwaremaybe used or copied only in accordance with the termsof those agreements. No part of this

publicationmaybe reproduced, stored in a retrieval system, or transmitted in any form or anymeanselectronic or mechanical, including

photocopying and recording for anypurpose other than the purchaser's personal use without the written permission of ITRSGroup Ltd.

ITRSGroup Ltd

6th Floor, The Bonhill Building, 15 Bonhill Street,

London, EC2A4DN, UK

t: +44 (0)20 7638 6700

f: +44 (0)20 7256 5760

Table of Contents

Geneos Gateway Plug-Ins - Technical Reference 8

Introduction 8

Gateway Data Plug-In 9

Samplers > Sampler > Plugin > Gateway-gatewayData 9

Probe Data Plugin 12

Samplers > Sampler > Plugin > Gateway-probeData 12

Samplers > Sampler > Plugin > Gateway-probeData > ProcessAttributes 17

Samplers > Sampler > Plugin > Gateway-probeData > Attributes 17

Managed Entities Data Plugin 19

Samplers > Sampler > Plugin > Gateway-managedEntitiesData 19

Snooze Data Plugin 21

Samplers > Sampler > Plugin > Gateway-snoozeData 21

Samplers > Sampler > Plugin > Gateway-snoozeData > Filter 22

Samplers > Sampler > Plugin > Gateway-snoozeData > Filter >UseAncestorManagedEntity 22

Samplers > Sampler > Plugin > Gateway-snoozeData > Filter > FilterByAttribute 22

Samplers > Sampler > Plugin > Gateway-snoozeData > Filter > FilterByAttribute > Include 23

Samplers > Sampler > Plugin > Gateway-snoozeData > Filter > FilterByAttribute > Include >Name 23

Samplers > Sampler > Plugin > Gateway-snoozeData > Filter > FilterByAttribute > Include >Values 23

Samplers > Sampler > Plugin > Gateway-snoozeData > Filter > FilterByAttribute > Exclude 23

Samplers > Sampler > Plugin > Gateway-snoozeData > Filter > FilterByAttribute > Exclude> Name 23

Samplers > Sampler > Plugin > Gateway-snoozeData > Filter > FilterByAttribute > Exclude> Values 23

Samplers > Sampler > Plugin > Gateway-snoozeData > Filter > FilterAttributes 23

Samplers > Sampler > Plugin > Gateway-snoozeData > ExcludeSelfGenerated 24

Samplers > Sampler > Plugin > Gateway-snoozeData > AttributeColumns 24

Menu Items 24Unsnooze Absent Items 24

User Assignment Data Plugin 26

Samplers > Sampler > Plugin > Gateway-userAssignmentData 26

Samplers > Sampler > Plugin > Gateway-userAssignmentData > Filter 27

Samplers > Sampler > Plugin > Gateway-userAssignmentData > Filter >UseAncestorManagedEntity 27

Samplers > Sampler > Plugin > Gateway-userAssignmentData > Filter > FilterByAttribute 28

Samplers > Sampler > Plugin > Gateway-userAssignmentData > Filter > FilterByAttribute >Include 28

Samplers > Sampler > Plugin > Gateway-userAssignmentData > Filter > FilterByAttribute >Include > Name 28

Samplers > Sampler > Plugin > Gateway-userAssignmentData > Filter > FilterByAttribute >Include > Values 28

Samplers > Sampler > Plugin > Gateway-userAssignmentData > Filter > FilterByAttribute >Exclude 28

Samplers > Sampler > Plugin > Gateway-userAssignmentData > Filter > FilterByAttribute >Exclude > Name 28

Samplers > Sampler > Plugin > Gateway-userAssignmentData > Filter > FilterByAttribute >Exclude > Values 28

Samplers > Sampler > Plugin > Gateway-userAssignmentData > Filter > FilterAttributes 29

Samplers > Sampler > Plugin > Gateway-userAssignmentData > ExcludeSelfGenerated 29

Samplers > Sampler > Plugin > Gateway-userAssignmentData > AttributeColumns 29

Menu Items 29Unassigned Absent Items 29

Client Connection Data Plugin 31

Samplers > Sampler > Plugin > Gateway-clientConnectionData 31

Exported Data 33

Samplers > Sampler > Plugin > Gateway-exportedData 33

Imported Data 33

Samplers > Sampler > Plugin > Gateway-importedData 33

Severity Count Plugin 35

Samplers > Sampler > Plugin > Gateway-severityCount 35

Samplers > Sampler > Plugin > Gateway-severityCount > ViewPaths 35

Samplers > Sampler > Plugin > Gateway-severityCount > ViewPaths > ViewPath 36

Samplers > Sampler > Plugin > Gateway-severityCount > IncludeUserAssigned 36

Samplers > Sampler > Plugin > Gateway-severityCount > IncludeSnoozed 36

Samplers > Sampler > Plugin > Gateway-severityCount > IncludeInactive 36

Samplers > Sampler > Plugin > Gateway-severityCount > AppendManagedEntity 36

Samplers > Sampler > Plugin > Gateway-severityCount > FilterByAttribute 36

Samplers > Sampler > Plugin > Gateway-severityCount > FilterByAttribute > Include 37

Samplers > Sampler > Plugin > Gateway-severityCount > FilterByAttribute > Include >Name 37

Samplers > Sampler > Plugin > Gateway-severityCount > FilterByAttribute > Include >Values 37

Samplers > Sampler > Plugin > Gateway-severityCount > FilterByAttribute > Exclude 37

Samplers > Sampler > Plugin > Gateway-severityCount > FilterByAttribute > Exclude >Name 37

Samplers > Sampler > Plugin > Gateway-severityCount > FilterByAttribute > Exclude >Values 37

Samplers > Sampler > Plugin > Gateway-severityCount > FilterAttributes 37

Includes Data Plugin 39

Samplers > Sampler > Plugin > Gateway-includesData 39

Load Monitoring Plugin 40

Samplers > Sampler > Plugin > Gateway-gatewayLoad 40

Categories 40Component Statistics 40

DirectoryStatistics 42

Connection Statistics 44

XPath Statistics 45

ORBStatistics 46

Gateway-sqlStatistics 47

Commands 47

Configuration 49Samplers>Sampler >Plugin >Gateway-gatewayLoad >View >Category 49

Samplers>Sampler >Plugin >Gateway-gatewayLoad >View >Source >File 49

Samplers>Sampler >Plugin >Gateway-gatewayLoad >View >Source >GatewayInternals 49

Samplers>Sampler >Plugin >Gateway-gatewayLoad >View >Category>ComponentStats >Grouping 49

Samplers>Sampler >Plugin >Gateway-gatewayLoad >View >Category>ComponentStats >Statistics >ExpandType 49

Samplers>Sampler >Plugin >Gateway-gatewayLoad >View >Category>DirectoryStats >Filtering >Filter 50

Samplers>Sampler >Plugin >Gateway-gatewayLoad >View >Category>DirectoryStats >Grouping 50

Samplers>Sampler >Plugin >Gateway-gatewayLoad >View >Category>DirectoryStats >Statistics >PerType 50

Samplers>Sampler >Plugin >Gateway-gatewayLoad >View >Category>DirectoryStats >Statistics >ExpandType 50

Samplers>Sampler >Plugin >Gateway-gatewayLoad >View >Category>XpathStats >Filter >Method 51

Licence Usage Plugin 52

Samplers > Sampler > Plugin > Gateway-licenceUsage 52

Samplers > Sampler > Plugin > Gateway-licenceUsage > Groups 52

Samplers > Sampler > Plugin > Gateway-licenceUsage > Groups > Group 52

Samplers > Sampler > Plugin > Gateway-licenceUsage > ShowOverall 52

Samplers > Sampler > Plugin > Gateway-licenceUsage > ShowOther 52

Scheduled Command Data Plugin 53

Samplers > Sampler > Plugin > Gateway-scheduledCommandData 53

Dataview 53

Scheduled Commands History Data Plugin 56

Samplers > Sampler > Plugin > Gateway-scheduledCommandsHistoryData 56

Configuration 57Samplers>Sampler >Plugin >Gateway-scheduledCommandsHistoryData >ScheduledCommand 57

Samplers>Sampler >Plugin >Gateway-scheduledCommandsHistoryData >Run >Last 57

Dataview 57

Gateway SQL Plugin 59

Samplers > Sampler > Plugin > Gateway-sql 59

Introduction 59

Table Sources 61

Dataview Sources 61Setting Table Columns 62

Headline Sources 64

XPath Sources 65

Example 1 65

Example 2 67

Sampler Queries 68

Sampler Processing 68Sampler Setup 68

Sampler Sample 69

Debugging 69

Configuration 70Samplers>Sampler >Plugin >Gateway-sql > Tables 70

Samplers>Sampler >Plugin >Gateway-sql > Tables>Dataview 70

Samplers>Sampler >Plugin >Gateway-sql > Tables>Dataview >TableName 70

Samplers>Sampler >Plugin >Gateway-sql > Tables>Dataview >Xpath 70

Samplers>Sampler >Plugin >Gateway-sql > Tables>Dataview >Columns 70

Samplers>Sampler >Plugin >Gateway-sql > Tables>Headlines 70

Samplers>Sampler >Plugin >Gateway-sql > Tables>Headlines>TableName 70

Samplers>Sampler >Plugin >Gateway-sql > Tables>Headlines>Xpath 71

Samplers>Sampler >Plugin >Gateway-sql > Tables>Xpath 71

Samplers>Sampler >Plugin >Gateway-sql > Tables>Xpath >TableName 71

Samplers>Sampler >Plugin >Gateway-sql > Tables>Xpath >Xpaths 71

Samplers>Sampler >Plugin >Gateway-sql > Tables>Xpath >Columns 71

Samplers>Sampler >Plugin >Gateway-sql >Views 71

Samplers>Sampler >Plugin >Gateway-sql >Views>View >Name 71

Samplers>Sampler >Plugin >Gateway-sql >Views>View >Sql 71

Samplers>Sampler >Plugin >Gateway-sql >Views>View >ShowRowID 71

Samplers>Sampler >Plugin >Gateway-sql >Views>View >Disabled 72

Samplers>Sampler >Plugin >Gateway-sql >SetupSql 72

Samplers>Sampler >Plugin >Gateway-sql >SampleSql 72

Database Logging Plugin 73

Samplers > Sampler > Plugin > Gateway- DatabaseLogging 73

Summary View 73

Cache View 74

Items View 76

Severity Data Plugin 78

Samplers > Sampler > Plugin > Gateway-severityData 78

Samplers > Sampler > Plugin > Gateway-severityData > Filter 79

Samplers > Sampler > Plugin > Gateway-severityData > Filter >UseAncestorManagedEntity 79

Samplers > Sampler > Plugin > Gateway-severityData > Filter > FilterByAttribute 79

Samplers > Sampler > Plugin > Gateway-severityData > Filter > FilterByAttribute > Include 79

Samplers > Sampler > Plugin > Gateway-severityData > Filter > FilterByAttribute > Include> Name 80

Samplers > Sampler > Plugin > Gateway-severityData > Filter > FilterByAttribute > Include> Values 80

Samplers > Sampler > Plugin > Gateway-severityData > Filter >filterByAttribute > Exclude 80

Samplers > Sampler > Plugin > Gateway-severityData > Filter >filterByAttribute > Exclude >Name 80

Samplers > Sampler > Plugin > Gateway-severityData > Filter >filterByAttribute > Exclude >Values 80

Samplers > Sampler > Plugin > Gateway-severityData > Filter > FilterAttributes 80

Samplers > Sampler > Plugin > Gateway-severityData > IncludeUserAssigned 80

Samplers > Sampler > Plugin > Gateway-severityData > IncludeSnoozed 81

Samplers > Sampler > Plugin > Gateway-severityData > IncludeInactive 81

Samplers > Sampler > Plugin > Gateway-severityData > ExcludeSelfGenerated 81

Samplers > Sampler > Plugin > Gateway-severityData > MaximumNumberOfRows 81

Samplers > Sampler > Plugin > Gateway-severityData > AttributeColumns 82

Geneos Gateway Plug-Ins - Technical Reference

IntroductionGateway plug-ins run on the gateway, instead of an external Netprobe processes. They typically provide amechanism for exposing Gateway specific parameters to themonitoring capabilities of Geneos. Thedifferent Gateway Plug-ins that are available are described below:

Note: Gateway RunTime Parameters

The following Gateway runtime parameters are available at the Sampler level for the plugins; SeverityCount, Severity Data, Snooze Data and User Assignment Data plugin.

GatewayName The name of the Gateway.

GatewayHost The hostname of Standalone or Primary Gateway (in case of HotStandby pair).

GatewayPort The port of Standalone or Primary Gateway (in case of HotStandby pair).

SecurePort Whether gateway is listening or secure port (true/false).

SecondaryHost The hostname of Secondary Gateway (in case of HotStandby pair).

SecondaryPort The port of Secondary Gateway (in case of HotStandby pair).

GeneosRelease v4.6.0. GeneosGatewayPlugins v1.0.0 - TechnicalReference Published Date 16/03/2018

of 82

Gateway Data Plug-In

samplers > sampler > plugin > Gateway-gatewayDataThe plug-in monitors the current configuration and state of this gateway. The plug-in provides the followingvariables:

List Variables:

Variable Name Description

gatewayName Configured unique name for the gateway.

gatewayId Unique identifier for the gateway.

release Release version of the gateway.

releaseAge The time in days since the gateway version wascreated.

hostname Hostname of the machine the gateway is running on.

ipAddress IpAddress of the machine the gateway is running on.

secureGatewayPort EMF2 port for the gateway that is used to listen forTSL connections.

insecureGatewayPort EMF2 port for the gateway that is used to listen forinsecure TCP connections.

sslCertificateDaysRemaining Number of days before the gateway's SSL certificate

expires.

l If negative, indicates number of days sinceit expired.

l If zero, indicates that no certificate existsor that it is not yet valid.

hotStandbyRole Current hot standby role of the gateway (Unknown,Stand Alone, Primary, Secondary).

hotStandbyEnabled Is hotstandby configuration enabled (true, false)


of 82


hotStandbyFailbackStrategy How does the Primary Gateway in a Hot-standby pair

behave on restart with an Active Secondary?

l Automatic - Gateway regains control

l Manual - command needs to be run on theSecondary to release control.

l Stand Alone - Not a Hot-standbyGateway.

secondaryGatewayHostname Hostname of the secondary gateway if hot standby isenabled and connected to a primary gateway.

secondaryGatewayPort Port of the secondary gateway if hot standby isenabled and connected to a primary gateway.

secondaryGatewayConnectionStatus Connection status to the secondary gateway if hotstandby is enabled and connected to a primarygateway.

primaryGatewayHostname Hostname of the primary gateway if hot standby isenabled and connected to a secondary gateway.

primaryGatewayPort Port of the primary gateway if hot standby is enabledand connected to a secondary gateway.

gatewaySetupFile Name of the primary setup file for this gateway.

setupIncludeFiles Names of all included setup files for this gateway

insecurePasswordLevel The level at which insecure passwords are beingreported in the setup (None, Warning, Error, Critical).

gatewayLogFile Name of the log file for this gateway.

gatewayProcessSize Size of the gateway process in Mb.

licenseFile Name of the temporary licence file.

licenseExpiryDate Expiry date of the licence file for this gateway

licenseDaysRemaining Number of days before the license expires.

severity The runtime severity of this gateway.

databaseLoggingEnabled Is database logging enabled (true, false)

databaseConnectionStatus Status of database connection if enabled (Pending,Connected, Not Connected).

databaseHost The configured host for the gateway's databaseconnection. (This will be blank for Oracle and Sybaseconnections).


of 82


databasePort The configured port for database connection. (Thiswill be blank for Oracle and Sybase connections).

databaseType Type of database (MySQL, SQLServer, Sybase,Oracle).

databaseSchemaVersion Version number of the database schema. This is readfrom the database at connection time.

gatewayDatabaseSchemaVersion Maximum version of the database schema that thegateway supports.

schemaVersion Version of the schema currently applied to thisgateway.

Points to Note:

l When theGateway connects to a database, the 'databaseConnectionStatus' will be 'Connected'.If the user then pauses the database connection (using Database Logging -> Connection -> pausecommand), the connection will be dropped from theGateway and the 'databaseConnectionStatus'will update to 'Not Connected'. If the user then resumes the connection, the'databaseConnectionStatus' will not update until there is something to log to the database at whichpoint the Gateway will re-establish connection to the database and the'databaseConnectionStatus' would reflect this as 'Connected'.

l If the Gateway is started in paused connectionmode, then the 'databaseConnectionStatus' wouldsit at 'Pending' state until the user resumes the database connection.


of 82

Probe Data plugin

samplers > sampler > plugin > Gateway-probeDataThe plug-in monitors the probes whose data is beingmonitored via this gateway. This may include normalprobes (configured in the setup), virtual probes (configured in the setup), floating probes (configured in thesetup), self-announcing probes (self-announced itself to the gateway) and imported probes (imported froman exporting gateway dataset).

This view also contains select data quality statistics applicable to probes. These statistics are generatedinternally to gateway and update approximately every 5 seconds. Therefore, depending upon the samplingrate configured youmay not see a different value every sample.

The data quality statistics will "freeze" for a probe which has been suspended by the data qualityalgorithm, so that the last known values for the probe are available for viewing. These values are ignoredfor statistical calculations, so figures in - for example - the gatewayLoad column are expected to sum togreater than 100% in this circumstance.

The plug-in provides the following variables:

Headline Variables:


probeCount Number of probes configured on this gateway.

probesUp Number of probes that have a connectionState UP.

probedDown Number of probes that have a connectionState otherthan up.

maxDataAge The age of the oldest (pending) data update inmilliseconds.

dataAgeLimit The configured maximum age. If maxDataAgereaches or exceeds this limit, the data qualityalgorithm may take steps to reduce gateway load toimprove data quality.

totalDataSize The estimated size of the unprocessed (pending)data in the data-queues. In megabytes.


of 82


readThrottlingStatus Status of the TCP read throttling algorithm that

protects the data-queues from unbounded growth

when the gateway is overloaded. Can be one of four

values:

l Not Throttling: Gateway is operatingnormally.

l Throttling Importing Connections:Gateway is throttling reads on netprobesbut will remain responsive to downstreamcomponents such as Active Console.

l Throttling All Connections: Gateway isthrottling all connections, andmay becomeunresponsive.

l Disabled: Read throttling algorithm isunable to operate (probably because oldernetprobes are connected) and no data-queuememory protection exists.

Row variables (Single row per probe):


name The unique name configured for this probe.

type Type of probe. This can be one of four values:

l Normal: A probe configured in thegateway setup file or imported froman exporting gateway dataset.

l Virtual: A virtual netprobeconfigured in the gateway setup file.

l Floating: A floating netprobeconfigured in the gateway setup file.

l Self Announced: A probe that hasannounced itself to the gateway andis not configured in the gatewaysetup file.

security Whether the probe has connected to its gatewayusing a secure or insecure connection.

virtual Whether the probe is virtual of not (true/false)


of 82


imported Whether the probe is imported from another gateway.

importedFrom The name of the exporting gateway from which thisprobe is imported (i.e. if it is imported, blankotherwise)

hostname The hostname configured for this probe.

ipaddress The ipaddress resolved from the hostname for thisprobe.

port The port configured for this probe.

release The release version of this probe.

releaseAge The time in days since the probe version wascreated.

schemaVersion The version number of the schema published by thisprobe.

severity The runtime severity of this probe.

connectionState The connectionState of this probe (Unknown, Up,

Down, Unreachable, Rejected, Removed,

Suspended).

Note: When the connection state of the probe is

shown as 'Unreachable', this means that the

probe is unreachable, not necessarily the server

hosting it. For example, the probe might be

unresponsive or its port might be in use.

OS The operating system type of the connectednetprobe.

managedEntityCount The number of ManagedEntities configured on thisprobe.

support Features supported by this probe version.

gatewayLoad The load on the gateway caused by processing datafrom the probe, as a percentage against all otherprobes. This figure can help to identify "busy"Netprobes.

busiestView The view which is contributing most to thegatewayLoad figure for that probe.

busiestViewLoad The load of the busiestView, as a percentage againstall other views on that probe.

Optional row variables:


of 82


user This column will be available if the setting

processAttributes has been set to "byName". This is

the default value for the setting.

The cell will contain the user name of the account that

is running the Netprobe.

The Netprobe must be at least version GA3.0.20-

140610 to support this feature. If the Netprobe does

not support this feature then the cell will be blank.

group This column will be available if the plugin setting

processAttributes is set to "byName". This is the

default for the setting.

The cell will contain the name of all groups that the

account that is running the Netprobe belongs to.



not support this feature then the cell will be blank

uid This column will be available if the plugin setting

processAttributes is set to "byID".

The cell will contain the user id of the account that is

running the Netprobe.




Windows probes do not support IDs for users so this

cell will be blank for windows probes.

gids This column will be available if the plugin setting

processAttributes is set to "byID".

The cell will contain the ids of all groups that the

account that is running the Netprobe belongs to.




Windows probes do not support IDs for groups so this

cell will be blank for windows probes.


of 82


TRUSTED_API_HOSTS This column will be available if "TRUSTED_API_

HOSTS" is selected under the plugin attributes

setting. The cell will contain the value of the

TRUSTED_API_HOSTS environment variable

provided to the Netprobe at start-up.


140610 to support this feature.

TRUSTED_DEBUG_HOSTS This column will be available if "TRUSTED_DEBUG_


setting".

The cell will contain the value of the TRUSTED_

DEBUG_HOSTS environment variable provided to

the Netprobe at start-up.



TRUSTED_HTTP_HOSTS This column will be available if "TRUSTED_HTTP_


setting".


HTTP_HOSTS environment variable provided to the

Netprobe at start-up.



TRUSTED_GATEWAY_HOSTS This column will be available if "TRUSTED_

GATEWAY_HOSTS" is selected under the plugin

attributes setting".


GATEWAY_HOSTS environment variable provided to

the Netprobe at start-up.




of 82


TRUSTED_GATEWAY_NAMES This column will be available if "TRUSTED_

GATEWAY_NAMES" is selected under the plugin

attributes setting".


GATEWAY_NAMES environment variable provided

to the Netprobe at start-up.



Note: The security value for an imported probe cannot be trusted to guarantee a secureconnection to the importing Gateway. The importing connection should also be checked. The`severity` value reported in this dataview reflects the severity of each probe, thus if a probe isimported, the value will be affected by severity and snooze data imported from probes' sourcegateway as well as any severity and snooze data generated by this gateway on the probe.

samplers > sampler > plugin > Gateway-probeData > pro-cessAttributesThis setting defines how the process context of the Netprobe should be shown. The process context is theaccount run the Netprobe process. The plugin displays the user and group information for this account. Ifthe value of this setting is "byName" then the user and group names of the account will be shown incolumns user and groups. If the value of this setting is "byID" then the user id and group ids will be shownin columns uid and gids.

Note: Windows probes do not support ids for groups and users, so the uid and gids cells willbe blank for windows probes.

These settings require a probe whose version is newer thanGA3.0.20-140610. If the Netprobe is older thecells will be blank.

Mandatory: NoDefault : byName

samplers > sampler > plugin > Gateway-probeData > attributesThis setting allows the administrator to add a set of environment variables used by the Netprobe to thesampler. Currently the following environment variables are supported:

l TRUSTED_API_HOSTS

l TRUSTED_DEBUG_HOSTS

l TRUSTED_HTTP_HOSTS

l TRUSTED_GATEWAY_HOSTS

l TRUSTED_GATEWAY_NAMES


of 82

New columns will be added to the sampler with the names of the environment variables selected. Thesesettings require a probe whose version is newer thanGA3.0.20-140610. If the Netprobe is older the cellswill be blank. If an environment variable is selected from the above list then the default value for theselected environment variable will be a "+" sign.

Mandatory: NoDefault : No environment variables selected


of 82

Managed Entities Data plugin

samplers > sampler > plugin > Gateway-managedEntitiesDataThe plug-in monitors the probes that are currently configured on this gateway. The plug-in provides thefollowing variables:

Headline Variables:


managedEntityCount Number of ManagedEntities configured on thisgateway.

undefinedCount Number of configured ManagedEntities that have aruntime severity of undefined.

okCount Number of configured ManagedEntities that have aruntime severity of ok.

warningCount Number of configured ManagedEntities that have aruntime severity of warning.

criticalCount Number of configured ManagedEntities that have aruntime severity of critical.

Row variables (Single row permanaged entity):


name The unique name configured for this managed entity.

severity The runtime severity of this managed entity.

probeName The name of the probe this managed entityreferences.

probeStatus The connectionState of the probe this managed entityreferences.

samplerCount The number of samplers configured on this managedentity.

samplerNames The name of the samplers configured on this entity.

Note: The `severity` value reported in this

dataview reflects the severity of each

manageEntity, thus if a manageEntity is imported,

the value will be affected by severity and snooze

data imported from manageEntity's source

gateway as well as any severity and snooze data

generated by this gateway on the manageEntity.


of 82


attributes The attribute name value pairs for this entity.


of 82

Snooze Data plugin

samplers > sampler > plugin > Gateway-snoozeDataThe plug-in monitors all data-items that are currently snoozed:

Headline Variables:


snoozedItemCount Number of snoozed data-items on this gateway.

snoozedButAbsentItems Number of data-items that are snoozed but notpresent on this gateway at this time.

filterIn Displays the inclusive attribute filters. See filtersetting.

filterOut Displays the exclusive attribute filters. See filtersetting.

Row variables (Single row per snoozed item):


cellId Unique identifier for this cell.

componentType The directory component type of this DataItem. One ofgateway, probe, managedEntity, sampler, DataView,cell.

probe The probe for this DataItem.

managedEntity The managed entity for this DataItem.

sampler The sampler for this DataItem.

dataView The dataview for this DataItem.

cell The cell for this DataItem.

type The configured type for this DataItem.

plugin The configured plugin type for this DataItem.

snoozeType The type of snooze applied to the cell (Manual,SeverityTo, SeverityFrom, Time, DateTime,ValueChanges)

user Name of the user that issued the snooze.

userFullName Full name of the user that issued the snooze.

timestamp Time the snooze was issued.


of 82


duration Number of minutes that the snooze has been active.

This view reports snooze information that was

created by the current Gateway and does not

reflect snooze data from imported Gateways. Thus

if a user snoozes a cell using command

delegation. The snooze information will appear in

the Gateway-snoozeData view on the exporting

gateway, but not on the importing gateway.

However if snooze is not imported but the data

items are, then the item snoozed will only be

snoozed on the importing gateway and the

snooze information will appear in the Gateway-

snoozeData view on the importing gateway.

timeTillAutoUnsnooze Number of seconds before the snooze is autocancelled (if appropriate).

comment User comment associated with this DataItem (ifpresent).

samplers > sampler > plugin > Gateway-snoozeData > filterThis setting is used to filter the cells listed in the plugin. The cells are filtered by ManagedEntity. If thesetting is not present then all snoozed cells on the gateway will be listed.

Mandatory: NoDefault : No filtering

samplers > sampler > plugin > Gateway-snoozeData > filter >useAncestorManagedEntityIf this setting is present then the sampler will only display snoozed items that are descendants of themanaged entity to which the sampler belongs.

samplers > sampler > plugin > Gateway-snoozeData > filter >filterByAttributeA set of one or more filters which can be used to limit the number of managed entities that contribute datato the sampler's dataview. Each filter is applied in order and amanaged entity needs to be accepted by allthe filters in order to contribute data.


of 82

samplers > sampler > plugin > Gateway-snoozeData > filter >filterByAttribute > includeThis setting defines a filter on an individual attribute. Any managed entities that have the specified attributedefined in the filter with a value that matches one of the values provided in the filter is accepted by thisfilter. Any other managed entity is rejected by this filter.

samplers > sampler > plugin > Gateway-snoozeData > filter >filterByAttribute > include > nameName of themanaged entity attribute tested by this filter.

samplers > sampler > plugin > Gateway-snoozeData > filter >filterByAttribute > include > valuesValues of themanaged entity attribute that is used by the filter to accept/reject managed entities fromcontributing data to the sampler's dataview. Managed entities whose specified attributematches one ofthe listed values will be accepted by the filter. If the attribute is not specified on themanaged entity or thespecified attribute does not match one of the values provided it will be rejected by the filter.

samplers > sampler > plugin > Gateway-snoozeData > filter >filterByAttribute > excludeThis setting defines a filter on an individual attribute. Any managed entities that have the specified attributedefined in the filter with a value that matches one of the values provided in the filter is rejected by this filter.Any other managed entity is accepted by this filter.

samplers > sampler > plugin > Gateway-snoozeData > filter >filterByAttribute > exclude > nameName of themanaged entity attribute tested by this filter.

samplers > sampler > plugin > Gateway-snoozeData > filter >filterByAttribute > exclude > valuesValues of themanaged entity attribute that is used by the filter to accept/reject managed entities fromcontributing data to the sampler's dataview. Managed entities whose specified attributematches one ofthe listed values will be rejected by the filter. If the attribute is not specified on themanaged entity or thespecified attribute does not match one of the values provided it will be accepted by the filter.

samplers > sampler > plugin > Gateway-snoozeData > filter >filterAttributesA set of one or more filters which excludemanaged entities if they contain attributes whose name andvaluematch any of the filters defined here. If a managed entity is excluded all snoozed items that aredescendants of themanaged entity will also be excluded.


of 82

Deprecated: See filterByAttribute setting.

samplers > sampler > plugin > Gateway-snoozeData >excludeSelfGeneratedWhether to exclude rows that represent data generated by the plugin dataview itself.

For example, if excludeSelfGenerated is set and headline 'managedEntity' is snoozed, no rows will begenerated.

Mandatory: NoDefault : True

samplers > sampler > plugin > Gateway-snoozeData > attrib-uteColumnsA list of attributes that will be added to the dataview as additional columns. If a row represents amanagedentity, the additional columns will be populated with the attribute values for the attributes defined. If a rowrepresents the descendant of amanaged entity, the additional columns will be populated with the attributevalues of the ancestor managed entity for the attributes defined. If a row represents a gateway or a probethen the cells will be blank.

Mandatory: No

Menu ItemsUnsnooze Absent Items

This command is available on the snoozedButAbsentItems headline if the Gateway-snoozeData plugin inenabled and on the gateway regardless.

This command requires confirmation from the user as on a busy gateway or gateway with many missingitems it may be processor intensive. This may lead to the gateway becoming temporarily unresponsive.

There is also the risk of removing items that may return when connecting to probe or reconfiguring asampler.


of 82


of 82

User Assignment Data plugin

samplers > sampler > plugin > Gateway-userAssignmentDataThe plug-in monitors all data-items that are currently user assigned:

Headline Variables:


assignedItemCount Number of data-items which have been assigned tousers on this gateway.

assignedButAbsentItemsCount Number of data-items which have been assigned tousers but are not present on this gateway at this time.


filterOut Displays the exclusive attribute filters. See filter

setting.

Note: The `warningItems` and `criticalItems`

values reported in this dataview reflects the

severity of the Gateway, thus it is affected by

severity and snooze data imported from other

gateways as well as severity and snooze data

generated on this gateway.

Row variables (Single row per user assigned cell):


cellId Unique identifier for this cell.

componentType The directory component type of this DataItem. One ofgateway, probe, managedEntity, sampler, DataView,cell.






type The configured type for this DataItem.



of 82


assigner The user that issued the assignment.

assignerFullName Full name of the user that issued the assignment.

assignee The user to which the DataItem is assigned.

assigneeFullName Full name of the user to which the DataItem isassigned.

timestamp Time the assignment was issued.

duration Number of minutes that the assignment has been

active.

Note: This view reports user assignment that was

created by **the current Gateway** and does not

reflect user assignment data from imported

Gateways. Thus if a user assigns a cell using

command delegation. The user assignment

information will appear in the Gateway-

userAssignmentData view on the exporting

gateway, but not on the importing gateway.

However if user assignment information is not

imported but the data items are, then the item

assigned will only be assigned on the importing

gateway and the assignment information will

appear in the Gateway-userAssignmentData view

on the importing gateway.

comment User comment associated with this DataItem (ifpresent).

samplers > sampler > plugin > Gateway-userAssignmentData> filterThis setting is used to filter the cells listed in the plugin. The cells are filtered by ManagedEntity. If thesetting is not present then all assigned cells on the gateway will be listed.

Mandatory: NoDefault : No filtering

samplers > sampler > plugin > Gateway-userAssignmentData> filter > useAncestorManagedEntityIf this setting is present then the sampler will only display assigned items that are descendants of themanaged entity to which the sampler belongs.


of 82

samplers > sampler > plugin > Gateway-userAssignmentData> filter > filterByAttributeA set of one or more filters which can be used to limit the number of managed entities that contribute datato the sampler's dataview. Each filter is applied in order and amanaged entity needs to be accepted by allthe filters in order to contribute data.

samplers > sampler > plugin > Gateway-userAssignmentData> filter > filterByAttribute > includeThis setting defines a filter on an individual attribute. Any managed entities that have the specified attributedefined in the filter with a value that matches one of the values provided in the filter is accepted by thisfilter. Any other managed entity is rejected by this filter.

samplers > sampler > plugin > Gateway-userAssignmentData> filter > filterByAttribute > include > nameName of themanaged entity attribute tested by this filter.

samplers > sampler > plugin > Gateway-userAssignmentData> filter > filterByAttribute > include > valuesValues of themanaged entity attribute that is used by the filter to accept/reject managed entities fromcontributing data to the sampler's dataview. Managed entities whose specified attributematches one ofthe listed values will be accepted by the filter. If the attribute is not specified on themanaged entity or thespecified attribute does not match one of the values provided it will be rejected by the filter.

samplers > sampler > plugin > Gateway-userAssignmentData> filter > filterByAttribute > excludeThis setting defines a filter on an individual attribute. Any managed entities that have the specified attributedefined in the filter with a value that matches one of the values provided in the filter is rejected by this filter.Any other managed entity is accepted by this filter.

samplers > sampler > plugin > Gateway-userAssignmentData> filter > filterByAttribute > exclude > nameName of themanaged entity attribute tested by this filter.

samplers > sampler > plugin > Gateway-userAssignmentData> filter > filterByAttribute > exclude > valuesValues of themanaged entity attribute that is used by the filter to accept/reject managed entities fromcontributing data to the sampler's dataview. Managed entities whose specified attributematches one ofthe listed values will be rejected by the filter. If the attribute is not specified on themanaged entity or thespecified attribute does not match one of the values provided it will be accepted by the filter.


of 82

samplers > sampler > plugin > Gateway-userAssignmentData> filter > filterAttributesA set of one or more filters which excludemanaged entities if they contain attributes whose name andvaluematch any of the filters defined here. If a managed entity is excluded all assigned items that aredescendants of themanaged entity will also be excluded.


samplers > sampler > plugin > Gateway-userAssignmentData> excludeSelfGeneratedWhether to exclude rows that represent data generated by the plugin dataview itself.

For examples of this flag, see the entries in the Gateway-snoozeData or Gateway-severityDataplugins.


samplers > sampler > plugin > Gateway-userAssignmentData> attributeColumnsA list of attributes that will be added to the dataview as additional columns. If a row represents amanagedentity, the additional columns will be populated with the attribute values for the attributes defined. If a rowrepresents the descendant of amanaged entity, the additional columns will be populated with the attributevalues of the ancestor managed entity for the attributes defined. It a row represents a gateway or a probethen the cells will be blank.

Mandatory: No

Menu ItemsUnassigned Absent Items


of 82

This command is available on the assignedButAbsentItemsCount headline if the Gateway-userAssignmentData plugin in enabled and on the gateway regardless.

This command requires confirmation from the user as on a busy gateway or gateway with many missingitems it may be processor intensive. This may lead to the gateway becoming temporarily unresponsive.

There is also the risk of removing items that may return when connecting to probe or reconfiguring asampler.


of 82

Client Connection Data plugin

samplers > sampler > plugin > Gateway-clientConnectionDataThe plug-in monitors currently connected client applications. This includes;

l Active Console

l Open Access Server

l Webslinger

l Gateway that import data from this gateway

Headline Variables:


clientConnectionCount Number of clients connected.

Row variables (Single row per client connection):


connectionId Connection identifier for this client.

component Component name of this client.

release The release version of this client.

releaseAge The time in days since the client version was created.

hostname The hostname that the client is connecting from.

ipaddress The ipaddress that the client is connecting from.

security Whether the client has connected to this gatewayusing a secure or insecure connection.

duration The number of minutes since the client connected.

expiresIn The time in minutes until the client SSO credentialswill expire. This will be blank if this is not an SSOconnection. In normal running the client will refreshthe credentials before they expire.

userName The user associated with this connection.

userFullName The full name of the user associated with thisconnection.

userDomain The domain of the user associated with thisconnection.

ssoUser Whether this is an SSO user (true, false).


of 82


genericUser Whether this is a generic user (true, false).

userGroups List of groups that this user belongs to.

connectionType This is one of

l Full Sync

l BDOSync

l Gateway Sharing

numFullySyncedDataviews The number of dataviews for which every cell is sentto the client every time it changes value.

The connectionType indicates how the system is transferring data to the client. Webslinger and very oldactive consoles use "Full Sync" where every data view is kept in sync between the client and thegateway.

Open Access Server and newer Active consoles use "BDOSync" where the only dataviews beingviewed/used are kept in sync between the client and the gateway. Other dataviews are kept in partial syncuntil such time as they are viewed/used by the client. At that time they are brought into full sync. Once adataview is no longer used, then the dataview is only kept in partial sync again.

Importing gateways useGateway Sharing where they only import the dataviews they have expressedinterest in. All imported dataviews are kept fully in sync.


of 82

Exported Data

samplers > sampler > plugin > Gateway-exportedDataRow variables (Single row per connection to an importing gateway):


connectionId Connection identifier for importing gateway.

gatewayName The name of importing gateway.

requestedDataSets The list of data sets that the importing gateway hasrequested.

providedDataSets The list of data sets that have actually been providedto the importing gateway

connectedUser The user name if available that was used toauthenticate the connection.

The connectionId column is the same as the connectionId column in the client connection plugin. Thisallows rules to be used that take data from both these plugins andmerged dataviews to be created usingthe gateway-sql plugin.

Note: Under normal circumstances, the requestedDataSets and the providedDataSets shouldbe the same. These will only differ if the importing gateway is requesting a data set that doesnot exist on the exporting gateway.

Imported Data

samplers > sampler > plugin > Gateway-importedDataRow variables (Single row per configured imported data connection):


name The name of this connection.

connectionStatus The status of the connection. This can be one of;

l Up

l Down

l Suspended

l Rejected

providedDataSets The release version of this client.


of 82


gatewayName The name of the exporting gateway

primaryHost The host of the gateway that data is being importedfrom. (This is the primary host if the gateways are in ahot standby pair).

primaryPort The port of the gateway that data is being importedfrom is listening on. (This is the primary host if thegateways are in a hot standby pair).

secondaryHost The host of the secondary gateway that data is beingimported from.

secondaryPort The port of the secondary gateway that data is beingimported from is listening on. (This is the primary hostif the gateways are in a hot standby pair).

security Whether the gateway has connected to the exportinggateway using a secure or insecure connection.

conflictingProbes A comma separated list of probes that have been

dropped from the imported data sets because they

conflict with existing probes in the importing gateway.

See Conflict Resolution


of 82

Severity Count plugin

samplers > sampler > plugin > Gateway-severityCountThe plug-in monitors the number of cells with OK, WARNING or CRITICAL severities.

Headline Variables:


viewpath Displays what viewpath elements need to bematched for a managed entity to be considered whengenerating the dataview



Note

This is an optional headline which only gets

displayed if one or more filter attributes

have been defined."

Row variables:


name Row identifier

okItems Number of ok items.

warningItems Number of warning items

criticalItems Number of critical items.

Note: The `okItems`, `warningItems` and

`criticalItems` variables can be affected by any

snooze or severity data that has been imported,

as well as any snooze or severity data locally

generated.

samplers > sampler > plugin > Gateway-severityCount >viewPathsA list of view paths.

Mandatory: No


of 82

Default : no path defined

samplers > sampler > plugin > Gateway-severityCount >viewPaths > viewPathThe view path configures the view in which the entities will be ordered in terms of attribute names.

Mandatory: NoDefault : no path defined

samplers > sampler > plugin > Gateway-severityCount >includeUserAssignedWhether to include user assigned cells in the count. Any item that has an assigned user counts for thisfilter, nomatter whether it was assigned on this gateway or the assignment was imported from anothergateway.

Mandatory: NoDefault : true

samplers > sampler > plugin > Gateway-severityCount >includeSnoozedWhether to include snoozed cells in the count. Any item that has been snoozed counts for this filter, nomatter whether it was assigned on this gateway or the assignment was imported from another gateway.

Mandatory: NoDefault : false

samplers > sampler > plugin > Gateway-severityCount >includeInactiveWhether to include inactive cells in the count.


samplers > sampler > plugin > Gateway-severityCount >appendManagedEntityWhether to drill down tomanaged entity level.


samplers > sampler > plugin > Gateway-severityCount > fil-terByAttributeA set of one or more filters which can be used to limit the number of managed entities that contribute datato the sampler's dataview. Each filter is applied in order and amanaged entity needs to be accepted by allthe filters in order to contribute data.

Mandatory: No


of 82

Default : no filters

samplers > sampler > plugin > Gateway-severityCount > fil-terByAttribute > includeThis setting defines a filter on an individual attribute. Any managed entities that have the specified attributedefined in the filter with a value that matches one of the values provided in the filter is accepted by thisfilter. Any other managed entity is rejected by this filter.

samplers > sampler > plugin > Gateway-severityCount > fil-terByAttribute > include > nameName of themanaged entity attribute tested by this filter.

samplers > sampler > plugin > Gateway-severityCount > fil-terByAttribute > include > valuesValues of themanaged entity attribute that is used by the filter to accept/reject managed entities fromcontributing data to the sampler's dataview. Managed entities whose specified attributematches one ofthe listed values will be accepted by the filter. If the attribute is not specified on themanaged entity or thespecified attribute does not match one of the values provided it will be rejected by the filter.

samplers > sampler > plugin > Gateway-severityCount > fil-terByAttribute > excludeThis setting defines a filter on an individual attribute. Any managed entities that have the specified attributedefined in the filter with a value that matches one of the values provided in the filter is rejected by this filter.Any other managed entity is accepted by this filter.

samplers > sampler > plugin > Gateway-severityCount > fil-terByAttribute > exclude > nameName of themanaged entity attribute tested by this filter.

samplers > sampler > plugin > Gateway-severityCount > fil-terByAttribute > exclude > valuesValues of themanaged entity attribute that is used by the filter to accept/reject managed entities fromcontributing data to the sampler's dataview. Managed entities whose specified attributematches one ofthe listed values will be rejected by the filter. If the attribute is not specified on themanaged entity or thespecified attribute does not match one of the values provided it will be accepted by the filter.

samplers > sampler > plugin > Gateway-severityCount > fil-terAttributesA set of one or more filters which excludemanaged entities from being considered if they contain attributeswhose name and valuematch any of the filters defined here.


of 82

Mandatory: NoDefault : no filtersDeprecated: See filterByAttribute setting.


of 82

Includes Data plugin

samplers > sampler > plugin > Gateway-includesDataThe plug-in monitors the include files that are currently configured on this gateway. The plug-in providesthe following variables:

Row variables (Single row per file):


priority The configured priority of the include file

file The location of the include file (or main setup file) asspecified on the gateway

applied The time when this file was read from disk and

applied by the gateway.

If the file could not be applied this is noted here along

with applicable error message.

changed The time when this file last changed on disk.

If the file cannot be reached to check the changed

time, a "path inaccessible" message is displayed.

activeMd5Sum This is the MD5 sum of the include file that is currently

active. This will be different from the MD5 sum of the

include file on disk in the following cases:

l The file on disk has been changed outsideof geneos and gateway has not reloadedthe setup

l The file on disk has been changed outsideof geneos and gateway refused to load thesetup

l The file on disk was changed (externally/orvia GSE) and is currently marked asinactive (See includes > reloading >activeTime)

activeVersion This is version number of the active include file asreturned by the post-validate hook. (See Post SetupApply).


of 82

Load Monitoring plugin

samplers > sampler > plugin > Gateway-gatewayLoadTheGateway LoadMonitoring feature provides various statistics about the runtime state of a Gateway.These statistics include processing times spent in various features, and can be viewed using configuredinstances of the loadmonitoring plug-in.

The loadmonitoring plugin has several different display modes, which allow users to obtain either a broadhigh-level overview of the current gateway state, or to drill down to examine statistics for a particular item.

The expected use for this plugin is primarily for troubleshooting, or to pinpoint specific components that arecausing or contributing to a problem. For amore detailed description on this, please see the "Gateway 2Performance Tuning Guide" document.

CategoriesLoadmonitoring statistics are broken down into several categories of statistic. Each of these categories isdisplayed by the loadmonitoring plug-in as a separate view mode, controlled by the category setting.

Component StatisticsThe component statistics is the default display mode for the loadmonitoring plug-in. These statisticssummarise how much time is being spent processing each gateway feature.


of 82

Headline Variables:


category The load monitoring statistics category beingdisplayed.

grouping The currently configured grouping mode, if any.

statistics The statistics being displayed. This will be "time" byfor the componentStats category.

filter The currently configured filter, if any.

lastUpdatedTime Time the underlying data being displayed was lastupdated.

Row Variables:


components Row identifier


of 82


time Total amount of CPU time spent on each component.Time units vary per platform, and should be used forrelative comparisons only.

The features reported on are as follows:

l Actions

l Active Times

l Alerting

l Auditing

l Commands

l Database Logging

l Directory

l Includes constructing andmodifying the state tree among other tasks.

l Effects

l Express Reports

l Knowledge Base

l Licencing

l ProbeManagement

l Includes establishing andmaintaining communication with Netprobes.

l Roles

l Includes the time spent on Hot-Standby functionality.

l Rules

l Schema

l Self-Announcing Netprobes

l SetupManagement

l Snooze

l Ticker Events

l Time Series

l User Assignment

l UserManagement

l Other user functionality not related to assignment.

Note: A high amount of time spent in some components relative to others is expected in anormal gateway configuration, as not all gateway features are used to the same degree.

Directory StatisticsSeveral gateway features operate on Data-items selected by a user-configured XPath. The directorystatistics category provides information about the items a feature is operating on, with correspondinglocation information from the directory, such as the Netprobe or Managed Entity that an item is associated


of 82

with. It is therefore possible to identify a particular probe or plug-in whose data is causing excessive loadon the gateway.

Headline Variables:




statistics The statistics being displayed. One of "time", "rules"or "dbLogging" depending on selected option.



Row Variables:


group Name of the group, the precise type being specifiedby the grouping mode.


of 82


dbLogging Total amount of CPU time spent for that grouped item(and all contained items in the group) on databaselogging.

rules Total amount of CPU time spent for that grouped item(and all contained items in the group) on rules.

matchingItems Displayed for some statistics modes. This columnshows the count of matchingItems (i.e. number ofcontained items in the group) for the selected feature,for that group.

time Displayed for some statistics modes. Shows the CPUtime spent for the selected feature, for that group.

updates Displayed for dbLogging statistics. The number oftimes a database logging target value changed,causing a check to see if the new value should belogged.

evaluations Displayed for rule statistics. The number of times aproperty change on a matched data-item caused arule evaluation.

At present two features are instrumented at this level: Rules and Database Logging. Statistics for thesecan be shown as a total time side-by-side, or in a view containing specific details for either of the features.

The directory statistics mode also allows users to group and filter items to help drill down to problem areas.Grouping allows statistics to be displayed (for example) at a Sampler or Managed Entity level. Values areaggregated at the grouping level, so an entity grouping would sum all values within a given entity.

Filtering items allows the views to be restricted to a particular entity or rule for example, and removes othercounts from the aggregate statistics of the grouping.

Connection StatisticsThe connection statistics category displays low-level details about the network traffic to and from thegateway. Connection data will include Netprobes, connected clients such as Active Console 2 orWebDashboards, as well as other components such as a hot-standby Gateway, Licence Daemon or web-based http connections.

Headline Variables:




statistics The statistics being displayed.


of 82




Row Variables:


connection The host and port of the remote side of theconnection.

WriteStreamLength Data in KB to be sent from the gateway.

ReadStreamLength Data in KB that have not yet been processed.

MessagesQueued For a Netprobe or ActiveConsole 2 connection, thenumber of messages waiting to be processed.

SendRate Rate of data sent in the last 10 seconds (KB/s)

ReceiveRate Rate of data received in the last 10 seconds (KB/s)

MemoryInUse Total amount of memory used for send and receivebuffers.

XPath StatisticsThis category displays information about XPath evaluations within the gateway. These paths are usedboth for user-configured items such as rule targets, as well as internally for tasks such as executingcommands. Due to the complexity of paths, it is recommended to use this category for debugging underthe instruction of ITRS support staff.

Headline Variables:







Row Variables:


of 82


path The full XPath text.

invocations Number of times this path was evaluated.

time Total time spent evaluating the path.

ORB StatisticsTheORB (Object Request Broker) is a central part of each geneos binary, and is used to transferinformation from the Netprobe to the Gateway and then on to the Active Console and other components inan efficient way. Almost all work passes through theORB (an example of an exception to this is the smallheartbeats used to ensure other components are up) so this statistics category is a good indicator the totalwork that the gateway is performing. The Component Statistics can then be used to see a higher levelview of the parts of the Gateway that are processing this data.

In addition, this view displays statistics relating to conflation which can be used to determine itseffectiveness and impact on the gateway.

Headline Variables:







Row Variables:


conflatedMessagesCreated The number of outgoing messages created byconflation. A message can contain multiple updates.

messagesConflated The number of incoming messages condensed intoconflated messages. A message can contain multipleupdates.

methodsConflated The number of individual updates discarded byconflation.

conflationTime The total time spent waiting for conflation to run. Thisvalue is included in the time statistic.

time Total time spent processing data.


of 82

Gateway-sql StatisticsTheGateway-sql plugin is a plugin that runs on the gateway and allows users to produce new dataviewsby combining data from existing dataviews on the gateway. The statistics in this category show how muchwork various instances of the plugin are doing.

Headline Variables:







Row Variables:


totalTime The total time spent in the plugin, this includes the

time taken to:

l Create the database and initialise it,

l populate the source tables,

l extract the data from the database into thesampler's dataviews, and

l publish the data.

searchTime The time taken to seach the gateway for the itemsprior to insertion in the database.

insertTime The time taken to insert data into the source tables.

queryTime The time taken to run SQL queries against the sourcetables

extractionTime The time taken to populate the sampler's dataviewsfrom the query result sets

publishTime The time taken to publish the extracted data into thegateway

CommandsThe underlying statistics for the gateway loadmonitoring plug-in can be controlled by a set of gatewaycommands. Using these commands, users can dynamically:


of 82

l Start statistics collection

l Stop statistics collection

l Reset all cumulative statistics

l Write statistics to file

These commands appear in Active Console 2 when right-clicking on a gateway:

Selecting the "for time period" command produces the following dialog, allowing users to gather statisticsover a specified period of time.

Starting and stopping statistics collection will start and stop the collection in memory, but will also startand stop the periodic logging of statistics to a file, if this has been configured. In addition, starting statisticscollection is only possible if a timed collection is not in progress. To cancel a timed collection, simply issuethe "stop collection" command first.


of 82

The "Reset Stats" commandwill clear any cumulative statistics frommemory, i.e. zero any times andnumber of executions etc. Stats such as the number of matching items will not be reset to zero as they willbe valid regardless of the time periodmonitoring occurs for (assuming no new samplers are (un)configured,or probes started/stopped).

The "Write Stats to File" commandwill write the statistics values frommemory to disk. This performs thesame operation as the regular stats file writing that can be configured, as well as the the "Write Stats to fileafter collection" option when gathering statistics over a period of time.

Configurationsamplers > sampler > plugin > Gateway-gatewayLoad > view > categorySpecifies the category of statistics to display:

l Component statistics

l Directory statistics

l Connection statistics

l XPath statistics

l ORB statistics

l Gateway-sql statistics

Mandatory: Yes

samplers > sampler > plugin > Gateway-gatewayLoad > view > source > fileThe file data source specifies that the plug-in should display load data as read from a file. This file shouldhave previously been logged by a gateway using the "Write stats to file" operating environment settings.

Mandatory: NoDefault: If not specified, the plug-in reads data from gatewayInternals source.

samplers > sampler > plugin > Gateway-gatewayLoad > view > source > gate-wayInternalsThis data source specifies the plug-in should display data currently being gathered by the gateway, andread from gateway memory.

Mandatory: No.Default: If not specified, the plug-in reads data from gatewayInternals source.

samplers > sampler > plugin > Gateway-gatewayLoad > view > category > com-ponentStats > groupingThe grouping level at which to view the statistics. Each row in the resulting view will be a group at thegrouping level. For example, grouping by ThreadID means that each row in the output view relates to aparticular thread.

Mandatory: NoDefault: Grouping by component

samplers > sampler > plugin > Gateway-gatewayLoad > view > category > com-ponentStats > statistics > expandTypeDisplaying statistics by expanded type will show only the stats values for that type. For example,selecting "Rules" will show all rule statistical values with a separate column for each value. Values forother types will not be displayed.


of 82

Mandatory: NoDefault: No expansion, time statistics will be shown.

samplers > sampler > plugin > Gateway-gatewayLoad > view > category > dir-ectoryStats > filtering > filterThis setting applies an inclusive filter to the statistics before display. Only items matching the filter will beshown in the resulting view.

Filtering can be performed on:

l Managed Entity

l Plug-in

l Probe

l Rule

l Sampler

l Type

l Database Item

Mandatory: NoDefault: No filtering

samplers > sampler > plugin > Gateway-gatewayLoad > view > category > dir-ectoryStats > groupingThe grouping level at which to view the statistics. Each row in the resulting view will be a group at thegrouping level. For example, grouping by Managed Entity will means that each row in the output viewrelates to an entity.

Up to two levels of grouping can be applied, to display a top-level grouping with sub-groups of the secondconfigured level.

Mandatory: NoDefault: Managed Entity

samplers > sampler > plugin > Gateway-gatewayLoad > view > category > dir-ectoryStats > statistics > perTypeThis setting controls which statistics to display. Statistics from a featurematching the selected type willbe shown, with the column as the name of the type.

For example, displaying perType with "matchingItems" will show columns where the values are counts ofmatching items. The names of these columns will be the feature names, i.e. rules and dbLogging.

Mandatory: NoDefault: Time

samplers > sampler > plugin > Gateway-gatewayLoad > view > category > dir-ectoryStats > statistics > expandTypeDisplaying statistics by expanded type will show only the stats values for that type. For example,selecting "Rules" will show all rule statistical values with a separate column for each value. Values forother types will not be displayed.

Mandatory: NoDefault: If not specified, the plug-in will display a "perType Time" statistic.


of 82

samplers > sampler > plugin > Gateway-gatewayLoad > view > category > xpathStats> filter > methodFilters the XPath statistics output to view, by the internal gateway method-call used to evaluate the path.

Value Meaning

getItems Called by the gateway to resolve a path to a set ofitems.

getRelativeItems Called to resolve a relative path against a specificitem, to a set of items.

nameAppliesToDataItem Called to reverse-resolve an item against a path (e.g.during rule lookups on initial item creation).

Mandatory: NoDefault: All methods are summarised into a single figure


of 82

Licence Usage plugin

samplers > sampler > plugin > Gateway-licenceUsageThe Licence Usage plugin monitors the licence daemon currently connected to the gateway. It shows howthe licence is in use and how much of the licence is still available as well as the connection status andlicence expiry time.

By default, a view will be shown for all licensing groups configured on the gateway

See the Licence Daemon Technical Reference Guide for more information about how to use the plugintomonitor licence usage.

samplers > sampler > plugin > Gateway-licenceUsage >groupsSpecifies which licensing groups configured on the daemon the plug-in should display views for. Bydefault, a view will be shown for all licensing groups configured on the gateway.

Mandatory: No

samplers > sampler > plugin > Gateway-licenceUsage >groups > groupThe name of a licensing group configured on the daemon that the plug-in should display a view for.

Mandatory: No

samplers > sampler > plugin > Gateway-licenceUsage >showOverallDisplay a view showing the overall ITRS issued licence and how it is being used.

Mandatory: NoDefault: false

samplers > sampler > plugin > Gateway-licenceUsage >showOtherDisplay a view showing how any tokens not allocated to a licensing group are being used.



of 82

Scheduled Command Data plugin

samplers > sampler > plugin > Gateway-sched-uledCommandDataThe plug-in monitors currently configured Scheduled Commands and present information about theirconfiguration, current, past and future scheduled runs. The plugin has no configuration settings.

DataviewBelow is a snapshot of how the plugin dataview might look:

Headline Variables:


configuredCommandsCount Number of Scheduled Commands that are currentlyconfigured.

runningCommandsCount Number of Scheduled Commands that are currentlyrunning.

scheduledCommandsCount Number of Scheduled Commands which arescheduled for future run.

Row variables (Single row per scheduled command):


command The name of Scheduled Command.

recurrenceInterval How often the Scheduled Command is run? This datawill make sense in conjunction with'recurrencePeriod'


of 82


recurrencePeriod The recurrence period for the Scheduled Command.It will have values - minutes, hours, days, weeks,weekdays, months.

activeTime The Active Time (if any) associated with theScheduled Command.

running Whether the Scheduled Command is currentlyrunning. Possible values: 'YES', 'NO'

runningTimestamp Start time of currently running instance (if any),<blank> otherwise.

runningTargetCount The number of targets against which the ScheduledCommand is running (if it is currently running),<blank> otherwise

scheduled Whether the Scheduled Command is scheduled torun in future. Possible values: 'YES', 'NO'

scheduledState Whether the next scheduled run will be inside oroutside the Active Time. Possible values: 'Active', 'NotActive'

scheduledTimestamp Start time of next run (if scheduled), <blank>otherwise.

scheduledTargetCount The number of targets against which the ScheduledCommand is scheduled to run next. This count will beif the command was run at the time the data view issampled.

lastRunTimestamp Start time of last run instance of ScheduledCommand (if any).

lastRunTargetCount The number of targets against which the ScheduledCommand ran last time.

lastRunFailedTargetCount The number of targets against which the ScheduledCommand failed to run last time.

Points to Note:

l Column scheduledState'Not Active' value denotes that the scheduled run will not occur as it will beoutside the active time (as the Active Time state at that scheduled time will be Not Active orOverride). Similarly, 'Active' value denotes that the scheduled run will occur as it will be insideactive time. Scheduled Commands with no configured 'Active Time' but a scheduled run willalways display 'Active' for this column.

l 'weekDays' recurrencePeriod will denote that user has configured everyWeekday days recurrencepattern in the setup.


of 82

l If the Scheduled Command is not scheduled, it will mean the Scheduled Command had'endByDate' or 'endAfterXOccurances' configured and either the time is past 'endByDate' or thecommand has already run X times in the past.

l If the Scheduled Command is not running, it will simply mean the Scheduled Command is notrunning at that point of time. One cannot infer if it is scheduled to run in future. For that, one willrefer to 'scheduled' column.

l The timestamps will be displayed in Gateway time zone irrespective of the time zones configuredin the individual Scheduled Commands. All the timestamps would be displayed in the formatYYYY-MM-DD HH:MM:SS for easy sorting of columns.


of 82

Scheduled Commands History Data plugin

samplers > sampler > plugin > Gateway-sched-uledCommandsHistoryDataThe plug-in monitors the past runs of currently configured Scheduled Commands.

Below is a snapshot of how the plugin dataview might look:


of 82

Configuration

samplers > sampler > plugin > Gateway-scheduledCommandsHistoryData > sched-uledCommandThe Scheduled Command for which past runs need to bemonitored. By default, all configured ScheduledCommands past runs are displayed.

Mandatory: No

samplers > sampler > plugin > Gateway-scheduledCommandsHistoryData > run >lastThe number of most recent past runs which need to be displayed. This number if always limited by thehistory count configured in the Scheduled Command Advanced tab. Refer to this section.

Mandatory: No

DataviewHeadline Variables:


lastRunsPerScheduledCommandsCount Number of most recent past runs displayed perScheduled Command.

Row variables (Single row per scheduled command past run):


lastRunInstance The last run instance of the Scheduled Command.Format: YYYY-MM-DD HH:MM:SS_<commandName>


of 82


command The Scheduled Command name (for easy sorting)

status The status of the past run instance. Possible values:'SUCCESS', 'FAIL'.

totalTargets The number of targets against which the ScheduledCommand instance ran.

failedTargets The number of targets against which the ScheduledCommand instance failed to run.

Points to Note:

l 'FAIL' status of the last run instancemeans the command failed to run on 1 or more expectedtargets. 'SUCCESS' status implies the command ran fine on all targets.

l The timestamps would be displayed in Gateway time zone irrespective of the time zonesconfigured on the individual Scheduled Command. All the timestamps would be displayed in theformat YYYY-MM-DD HH:MM:SS for easy sorting of columns.


of 82

Gateway SQL plugin

samplers > sampler > plugin > Gateway-sql

IntroductionThis plug-in is part of the Compute Engine functionality of the gateway; unlike the other Gateway plug-ins,it provides a way to summarise and reformat dataviews rather than tomonitor the gateway. It uses an in-memory SQLite database to take data frommultiple dataviews and combine them to provide a set of newdataviews. Note that the database is used within the plug-in to manipulate the dataviews, not to store anyhistorical data. The version of SQLite used in this plug-in is sqlite-3.9.2 (Seehttp://www.sqlite.org/releaselog/3_9_2.html).

A user can configure the plugin to take data from a pair of specified dataviews and combine them using akey column in each dataview.

So if the first dataview was;

And the second dataview was;


of 82

http://www.sqlite.org/releaselog/3_9_2.html

We can combine the two dataview using the following SQL statement (where T1 is the first dataview tableand T2 is the second dataview table) to get a human readable state value. Below is how it would beconfigured in the Gateway Setup Editor.

The resulting dataview is


of 82

More complex SQL is available including OUTER JOINS, LEFT JOINS, GROUP BY. For amore in-depthlist of queries that can be used, please look at http://www.sqlite.org/lang.html.

The sampler has a sample time. Every time that it samples, all the tables associated with the sources arewiped clean and the data is rescanned into the databases. The SQL is then run to extract the specifiedviews and theGeneos datamodel is updated.

Note: The severity, snooze state and user assignment data reported in this dataview reflects theseverity snooze state and user assignment of the data items, thus it is affected by severity, snoozestate and snooze data imported from other gateways as well as severity snooze state and snooze datagenerated on this gateway.

Table SourcesThere are 3 different gateway sources that can be used to populate tables in the sampler database;

l A Dataview table (data from a single dataview)

l A Dataview's headlines (data from a single dataview)

l A set of XPaths (data frommultiple dataviews)

Dataview sourcesA single dataview can be used a source for a database table. If the columns are not specified in the setup,then the dataview columns will be the same as the columns in the source dataview. (This will include therowname column). If the columns are specified in the setup, then just those columns present in thedataview that are specified in the setup will be copied into the sampler's database. It is recomented thatcolumns are specified where possible as this allows the table to be created before the dataview ispopulated. If the columns are not created and the source dataview is missing, the plugin will be unable tocreate a table and subsequent SQL queries will fail.


of 82

http://www.sqlite.org/lang.html

If the XPath providedmatches multiple dataviews, then only the first dataview found will be used. Theother dataviews will be ignored.

Below is the setup to obtain the dataview row data from aCPU dataview:

Setting Table ColumnsThis section of the setup allows users to define the schema of the SQLite table created for each dataview.If this section is omitted, the table will have a column for each column in the dataview. If this section ispresent, any columnwhose name does not match a column in the dataview will be populated with NULLvalues and any columns present in the dataview but not specified will be omitted from the SQLite databasetable.

This section also allows the datatype of each column to be specified as TEXT, INTEGER or REAL. Thedefault value if unspecified is TEXT. See http://www.sqlite.org/datatype3.html for more details abouthow types affect tables in SQLite.

Choosing whether or not to specify the columns for a dataview source involves a trade-off betweenefficiency and adaptability.

Explicitly specifying the columns has the advantages that:

l Columns that are not used in the queries need not be copied, savingmemory and CPUresources in the Gateway.

l Queries will not fail if dataviews aremissing as the tables will still exist in the database(though they will be empty).

On the other hand, with a fixed set of columns:

l The resultant query cannot adapt to new columns being added to the source dataview.

l The resultant dataview will not show an error if the source dataview is absent.

Below is the setup to obtain the dataview row data from a subset of the columns in a CPU dataview:


of 82

http://www.sqlite.org/datatype3.html

Below is an example of extracting the data using the previous settings:


of 82

Headline sourcesThe headlines from a single dataview can used a source for a database table. The table has a predefinedstructure: two columns of type TEXT, called "name" and "value". There is a single row for each headline inthe dataview. ('samplingStatus' is one of the dataview headlines and so will be one of the row namesreturned.)

If the XPath providedmatches multiple dataviews, then only the first dataview found will be used. Theother dataviews will be ignored.

Below is the setup to obtain the headlines from aCPU dataview:

Below is an example of extracting using the previous settings:


of 82

XPath sourcesA set of XPaths can be used to define the source for a database table. These XPaths are separated intotwo groups: row XPaths and column XPaths.

The row XPaths define target items for the rows in the table. On each sample, the Gateway directory issearched for items that match the row XPaths and each item found is used to create a row in the databasetable. If an itemmatches more than one row XPath, it will only generate one row in the database table.

Each column in the database table is defined by a column XPath. This XPath selects a value for thecolumn. Normally this is a relative XPath evaluated relative to the target item used to create the row.

This section also allows the datatype of each column to be specified as TEXT, INTEGER or REAL. Thedefault value if unspecified is TEXT. See http://www.sqlite.org/datatype3.html for more details abouthow types affect tables in SQLite.

Below are two examples of XPath sources.

Example 1

The Setup above selects all the rows from CPU dataviews inManaged Entities with an AttributeOWNER=ITRS. We are extracting the following information:

l Entity Name

l CPU Name


of 82

http://www.sqlite.org/datatype3.html

l Utilisation

l WaitTime

This is set up by targeting one cell from each row of the relevant dataviews. The XPath filters thedataviews using attribute name. The cell use here is the percentUtilisation column. (Note that you cannotuse the cpu column as it is the rowname column and cannot be selected as a cell by the XPath). TheXPath for each column is specified relative to the target cell.

l Entity Name: The Entity name is obtained from the entity that owns the target cell [ ancestor-or-self::managedEntity ]

l CPU Name: The CPU name is obtained from rowname of the target cell [ @rowname ]

l Utilisation: The utilisation is obtained from the value of the target cell [ @value ]

l WaitTime: The wait time is obtained from the percentWaitTime cell in the same row as the targetcell [ ../cell[(@column="percentWaitTime")]/@value ]

The setup dialog above also shows how the data type can be set for each column if required (the default isTEXT).

The XPath source table defined above can be used to populate a dataview as follows:


of 82

Example 2

The Setup above selects a basic summary for eachManaged Entity with an Attribute OWNER=ITRS. Weare extracting the following information:

l Entity Name: The Entity name is obtained from the entity [ . ]

l cpus: The numOnlineCpus headline in the CPU sampler [ ./sampler[(@name="CPU")]/dataview[(@name="CPU")]/headlines/cell[(@name="numOnlineCpus")] ]

l mem: ThememoryUse from the Hardware sampler [ ./sampler[(@name="HW")]/dataview[(@name="HW")]/rows/row[(@name="memoryUse")]/cell[(@column="Value")]]

These column XPaths utilise a short cut provided by gateway-sql. If a column XPath refers to a cell, thenits value will be used as the column value. If the XPath refers to a data item that is not a cell (such as adirectory, probe, managed entity or sampler), then the name of the data item will be used as the columnvalue.

The XPath source table defined above can be used to populate a dataview as follows:


of 82

Sampler queriesThe examples above have shown the use of simple queries to populate the dataviews generated by theplug-in.

Multiple views can be defined, each with its own query. Each view can combine tables from anycombination of the data sources described in the previous section.

Queries are written in the dialect of SQL supported by SQLite, which is described athttp://www.sqlite.org/lang.html.

The sampler performs SQL queries at three different times.

l Setup SQL: This query is performed every time the sampler is created. (e.g. at gateway startup andwhen the setup changes).

l Sampler SQL: This query is performed once per sample. It is performed after the tables have beenpopulated

l View SQL: These queries (one for each view) are performed after the 'Sampler SQL' again once persample.

Sampler processingThe steps that the sampler goes through to generate its views are:

Sampler SetupThis occurs when the sampler is first created. It also occurs when any sampler parameters are changed,as the sampler is destroyed and recreated at this time.

l Create a private in-memory database accessible only by this sampler

l Create the dataviews that will be populated by the sampler


of 82

http://www.sqlite.org/lang.html

l Run the setup SQL statements if defined

If there is an error on running the setup SQL then an error will be displayed in the sampling status on all theviews and further changes will not occur to the views until the error is corrected.

Sampler SampleThis occurs at a regular interval specified in the sampler setting.

l For each source table defined on the sampler

l Find the source dataview (does not apply to XPath sources)

l Drop the table from the database

l Recreate the table

l Populate the table from the source dataview (or row XPaths)

l Run the sampleSQL statements if defined

l For each output view defined on the sampler

l Empty the dataview

l Use the view's SQL statement to extract data from the database

l Push the changes into the gateway

If an error occurs in stage 1 or stage 2 an error will be displayed in the sampling status on all the views. Theprocessing will then stop for that sample. The next sample will start again and continue if the error nolonger occurs.

If an error occurs in stage 3 then an error will be displayed in the sampling status of the view the erroroccurred upon. No further processing will occur on that view but the other views will still be processed.

When looking for a dataview in stage 1a, if the dataview is not found, or if the dataview is unpopulated (norow or column names defined) then an error will result. If multiple dataviews are found then the first onefound will be used.

DebuggingThe plugin provides debug settings to help to configure the sampler. These are set in the debug settings ofthe sampler. The following settings are available;

l statusDetails: This debug setting provides additional information to the log file if an error occursduring sampling.

l showQueries: This debug setting outputs all the SQL queries passed to the sampler's database.This includes those defined in the configuration and those used by the sampler to create andpopulate source tables.

l debugSQLCommands: This debug setting enables a debug gateway command that allows theuser to perform SQL commands on the in-memory databasemaintained by the sampler. Pleasenote that this database is transitory and can be reset by setup changes/re-sampling.

l showSampleTimes: This debug setting will log time spent during each sample, which can beuseful when profiling the setup. The times givenmirror the times that are reported by the Gateway-load plugin whenmonitoring Gateway-sql.


of 82

In order to understand how much time is being spent processing these plugins, a new section has beenadded to the Gateway-gatewayLoad configuration tomonitor the time spent in Gateway-sql plugins. Thiscan be grouped and filtered by entity or sampler name, allowing a detailed breakdown by individualsampler.

Configurationsamplers > sampler > plugin > gateway-sql > tablesThis section is used to specify the source data for a table in the sampler's in-memory database.

samplers > sampler > plugin > gateway-sql > tables > dataviewThis allows the specification of a dataview table as the source of the data for the table. See Dataviewsources

samplers > sampler > plugin > gateway-sql > tables > dataview > tableNameThe name of the table to create in the sampler's in-memory database. This table is destroyed andrecreated each sample.

samplers > sampler > plugin > gateway-sql > tables > dataview > xpathThe path to a dataview used to populate a table in the sampler's in-memory database. If this path points tomore than one dataview then only the first matching dataview will be used. This path can be an absolutepath or a relative path. If a relative path is used then the path will be relative to the instance of the sampler.So to get a specific dataview in the samemanaged entity you would use a path similar to the one below;

../sampler[@name="cpu"]/dataview[@name="cpu"]

samplers > sampler > plugin > gateway-sql > tables > dataview > columnsThe optional column names of the table.

If not specified then the table is destroyed and recreated each sample with columns that match thecolumns in the dataview.

If specified then the table is created at sampler start/setup change. The columns created are thosespecified in this section. If the optional affinities are set then those are used when creating the table. In thecase when the columns are specified the table will be truncated rather than re-created each sample.

samplers > sampler > plugin > gateway-sql > tables > headlinesThis allows the specification of a dataview's headline variables as the source of the data for an sql table.See Headline sources

samplers > sampler > plugin > gateway-sql > tables > headlines > tableNameThe name of the table to create in the sampler's in-memory database. This table is destroyed andrecreated each sample.


of 82

samplers > sampler > plugin > gateway-sql > tables > headlines > xpathThe path to a dataview used to populate a table in the sampler's in-memory database. If this path points tomore than one dataview then only the first matching dataview will be used. This path can be an absolutepath or a relative path. If a relative path is used then the path will be relative to the instance of the sampler.So to get a specific dataview in the samemanaged entity you would use a path similar to the one below;

../sampler[@name="cpu"]/dataview[@name="cpu"]

samplers > sampler > plugin > gateway-sql > tables > xpathThis allows the specification of a subset of the geneos data as the source of the data for an sql table. SeeXPath sources for more details.

samplers > sampler > plugin > gateway-sql > tables > xpath > tableNameThe name of the table to create in the sampler's in-memory database. This table is destroyed andrecreated each sample.

samplers > sampler > plugin > gateway-sql > tables > xpath > xpathsA list of XPaths used to obtain a set of dataitems. Each dataitem will be used to generate a row in thetable. The column XPaths (samplers > sampler > plugin > gateway-sql > tables > xpath > columns)will be used relative to these items to define the values to put in column of the row. See XPath sources formore details.

samplers > sampler > plugin > gateway-sql > tables > xpath > columnsThis specifies the columns of the table. The column definition is composed of:

l Name: This is the name of the column created in the database table

l XPath: This is path is used in conjunction with the table XPath to populate the table cells in thecolumn. See XPath sources for more details.

l Type: This is the type of the database column. If not specified then it defaults to TEXT.

samplers > sampler > plugin > gateway-sql > viewsThis section defines the views that will be created by the sampler. The sampler can createmultiple viewspulling data from the same set of dataviews.

samplers > sampler > plugin > gateway-sql > views > view > nameThis is the name of the dataview that is to be created.

samplers > sampler > plugin > gateway-sql > views > view > sqlThis is the sql query that will be run to produce the data for the dataview. The dataview is cleared eachsample and then populated with the results from this query.

samplers > sampler > plugin > gateway-sql > views > view > showRowIDThis flag controls the way that view's SQL query result is mapped into a Geneos dataview. If this flag isset then the row namewill be column called RowID, that will contain an incrementing row number startingat 1. If the flag is missing or false then the row namewill be the first column extracted from the database,as defined by the view's SQL.


of 82


samplers > sampler > plugin > gateway-sql > views > view > disabledThis is the flag can be used to disable individual views in the sampler. If the flag is set the the views willnot be generated, and the dataviews will not be added to the sampler.


samplers > sampler > plugin > gateway-sql > setupSqlThis defines a piece of SQL that is run when the in-memory database is created. This is run only once. (Atgateway start up or when the sampler parameters are changed). This SQL can contain more than onestatement (separated by semi-colons).

samplers > sampler > plugin > gateway-sql > sampleSqlThis defines a piece of SQL that is run after all the source tables have been populated, but before the viewextraction queries are run. This SQL can contain more than one statement (separated by semi-colons) andis run on every sample of the sampler.


of 82

Database Logging plugin

samplers > sampler > plugin > Gateway- databaseLoggingThe plug-in monitors the database logging configuration and status of everything that is logged fromGateway to a database.

The plugin has 3 views: Summary View, Cache view and Items view.

Summary viewSummary view shows the overall database settings and connection status. Below is a snapshot of howthe Summary view might look:

List Variables:


host The configured host for the gateway's databaseconnection. (This will be blank for Oracle and Sybaseconnections).


of 82


port The configured port for the gateway's databaseconnection. (This will be blank for Oracle and Sybaseconnections).

database Database name

type Type of database (MySQL, SQLServer, Sybase,Oracle)

version Version of the database (if connected).

enabled Is database logging enabled (true, false)

connectionStatus Status of database connection if enabled (Pending,Connected, Not Connected)

connectionPaused Is database connection paused (using DatabaseLogging -> Connection -> pause command)

discardingItemValues Is discarding item values (using Database Logging ->Item values -> discard command)

timeSinceLastSuccess Time in seconds since last successful log to thedatabase. This is updated every sample interval.

Points to Note:

l When theGateway connects to a database, the 'connectionStatus' will be 'Connected'. If the userthen pauses the database connection (using Database Logging -> Connection -> pause command),the connection will be dropped from theGateway and the 'connectionStatus' will update to 'NotConnected'. If the user then resumes the connection, the 'connectionStatus' will not update untilthere is something to log to the database at which point the Gateway will re-establish connection tothe database and the 'connectionStatus' would reflect this as 'Connected'.

l The `severity` value reported in this dataview reflects the severity of the Gateway, thus it isaffected by severity and snooze data imported from other gateways as well as severity and snoozedata generated on this gateway.

l If the Gateway is started in paused connectionmode, then the 'connectionStatus' would sit at'Pending' state until the user resumes the database connection.

Cache viewCache view gives details about the internal queue and cache (dump) files statistics. Below is a snapshotof how the Cache view might look:


of 82

List Variables:


autoReload Is auto reloading of dump files enabled (true/ false)

cacheFiles No of dump files on disk

cacheLocation The directory where dump files are created/stored

cachePeriod The maximum duration for which dump files will bestored before the oldest file is discarded

cacheSize Total size of the dump files on disk

maxCacheSize The upper limit for the total size of the dump files asconfigured in the setup

queueSize Current internal queue size (Internal queue holds thelog requests which are yet to make into database)

maxQueueSize The upper limit for the internal queue size asconfigured in the setup. When this limit is hit, the logrequests are dumped to disk (if dump files creation isenabled)


of 82


oldestCacheData The oldest dump file on disk (in days)

writingNewFiles Is creation of new dump files enabled (true/false)

Items viewItems view gives details about the DB items configured in the setup such as which table are theyconfigured to log to, the number of live data cells matching their target paths, and how many of those havebeen logged or failed to log.

Below is a snapshot of how the Items view might look:

Headline Variables:


successfullyLogging Total number of data items from all DB items targetXPaths that were successfully logged to the databaseon their last value update.

failingLogging Total number of data items from all DB items targetXPaths that failed to log to the database on their lastvalue update.

loggingNotAttempted Total number of data items from all DB items targetXPaths that were not attempted to log to the databaseon their last value update.

Row variables (Single row per configured DB item):


of 82


name Name of the DB item configured in the setup

table The database table it is configured to log to

active Whether active when active time is configured.(active/inactive). If active time not configured, it isalways active.

matchingDataItems The number of live data cells that match all the targetXPaths configured per this DB item.

successfullyLogging The number of data items that were successfullylogged on their last value update.

failingLogging The number of data items that failed to log on theirlast value update.

loggingNotAttempted The number of data items that were not attempted tolog on their last value update.

Points to Note:

l The 'matchingDataItems' reflects count of all data items that match the target XPaths in the DBitem. A dataitemmay matchmore than one target XPaths in the DB item, hence, this value is not acount of unique data items. Same is true for 'successfullyLogging', 'failingLogging','loggingNotAttempted' counts.

l A dataitemmay matchmultiple target XPaths across different DB items. Hence, the headlinevariables 'successfullyLogging', 'failingLogging' and 'loggingNotAttempted' is not a count of uniquedata items in the system.

l The 'successfullyLogging', 'failingLogging', 'loggingNotAttempted' count are not updated when aconfigured active time enters inactive period.

l The 'failingLogging' count will go up when the database connection is paused and there are dataitem value updates.


of 82

Severity Data plugin

samplers > sampler > plugin > Gateway-severityDataThe plug-in monitors and displays details of all cells withWARNING or higher severity. The plugin can beconfigured tomonitor a subset of the cells by filtering the output by Managed Entity.

Headline Variables:


warningItems Number of warning items

criticalItems Number of critical items



Row variables:


id Unique identifier for this cell.

componentType The directory component type of this DataItem.Example: Cell.






type The configured sampler type for this DataItem.


severity The severity for this DataItem (Warning/Critical).

snoozed Whether this DataItem is snoozed (true/false).

userassigned Whether this DataItem is assigned to a user(true/false).


of 82


active Whether this DataItem is active (true/false).

Note: The `severity`, `snoozed`, `userassigned`

and `active` values reported in this dataview

reflects the values currently on the cell, thus it is

affected by data imported from other gateways as

well as data generated on this gateway.

timestamp The time the most recent severity change(Warning/Critical) for this DataItem occurred.

Note: For the timestamp variable, time is updated when severity is first logged by the gatewayand when severity changes betweenWarning/Critical states. Active and snooze statechanges do not affect the timestamp. Timestamp values for imported severities are created atthe time they are imported, not when they occurred on the originating gateway.

samplers > sampler > plugin > Gateway-severityData > filterThis setting is used to filter the cells listed in the plugin. The cells are filtered by ManagedEntity. If thesetting is not present then all assigned cells on the gateway will be listed, unless they are filtered by one ofother filter setting [includeUserAssigned, includeSnoozed or includeInactive]

Mandatory: No

samplers > sampler > plugin > Gateway-severityData > filter >useAncestorManagedEntityIf this setting is present then the sampler will only display critical and warning labelled cells that aredescendants of themanaged entity to which the sampler belongs.

samplers > sampler > plugin > Gateway-severityData > filter >filterByAttributeA set of one or more filters which can be used to limit the number of managed entities that contribute datato the sampler's dataview. Each filter is applied in order and amanaged entity needs to be accepted by allthe filters in order to contribute data.

samplers > sampler > plugin > Gateway-severityData > filter >filterByAttribute > includeThis setting defines a filter on an individual attribute. Any managed entities that have the specified attributedefined in the filter with a value that matches one of the values provided in the filter is accepted by thisfilter. Any other managed entity is rejected by this filter.


of 82

samplers > sampler > plugin > Gateway-severityData > filter >filterByAttribute > include > nameName of themanaged entity attribute tested by this filter.

samplers > sampler > plugin > Gateway-severityData > filter >filterByAttribute > include > valuesValues of themanaged entity attribute that is used by the filter to accept/reject managed entities fromcontributing data to the sampler's dataview. Managed entities whose specified attributematches one ofthe listed values will be accepted by the filter. If the attribute is not specified on themanaged entity or thespecified attribute does not match one of the values provided it will be rejected by the filter.

samplers > sampler > plugin > Gateway-severityData > filter>filterByAttribute > excludeThis setting defines a filter on an individual attribute. Any managed entities that have the specified attributedefined in the filter with a value that matches one of the values provided in the filter is rejected by this filter.Any other managed entity is accepted by this filter.

samplers > sampler > plugin > Gateway-severityData > filter>filterByAttribute > exclude > nameName of themanaged entity attribute tested by this filter.

samplers > sampler > plugin > Gateway-severityData > filter>filterByAttribute > exclude > valuesValues of themanaged entity attribute that is used by the filter to accept/reject managed entities fromcontributing data to the sampler's dataview. Managed entities whose specified attributematches one ofthe listed values will be rejected by the filter. If the attribute is not specified on themanaged entity or thespecified attribute does not match one of the values provided it will be accepted by the filter.

samplers > sampler > plugin > Gateway-severityData > filter >filterAttributesA set of one or more filters which excludes managed entities if they contain attributes whose name andvaluematch any of the filters defined here. If a managed entity is excluded all critical and warning labelledcell that are descendants of themanaged entity will be excluded.


samplers > sampler > plugin > Gateway-severityData >includeUserAssignedWhether to include user assigned cells in the dataview.

Mandatory: No


of 82

Default : true

samplers > sampler > plugin > Gateway-severityData >includeSnoozedWhether to include snoozed cells in the dataview.


samplers > sampler > plugin > Gateway-severityData >includeInactiveWhether to include inactive cells in the dataview.


samplers > sampler > plugin > Gateway-severityData >excludeSelfGeneratedWhether to exclude rows that represent data generated by the plugin dataview itself.

As an example, a rule is placed on the timestamp column that causes cells to change to critical severity ifthe cell the row is monitoring has been at critical severity for more than 24 hours. If excludeSelfGeneratedis set, then a new row will not be created if a cell in the timestamp column changes to critical severity after1 day, because this is data generated by the plugin dataview itself.


samplers > sampler > plugin > Gateway-severityData > max-imumNumberOfRowsMaximum number of rows that the dataview will display. If the number of Warning and Critical cells thatshould be displayed in the dataview is greater than themaximum number of rows, but the number ofCritical cells is less than themaximum number of rows then only the critical cells will be displayed in thedataview. If the number of Critical cells that should be displayed in the dataview is greater than themaximum number of rows then no rows will be displayed in the dataview. Whenever cells are notdisplayed because displaying them would cause themaximum number of rows in the dataview to bebreached, an error will be displayed in the sampling status.

The headline variables "warningItems" and "criticalItems" will always display the number of cells thatmatch the filters provided by the sampler. They are not affected by this setting.

Mandatory: NoDefault : 100


of 82

samplers > sampler > plugin > Gateway-severityData > attrib-uteColumnsA list of attributes that will be added to the dataview as additional columns. If a row represents amanagedentity, the additional columns will be populated with the attribute values for the attributes defined. If a rowrepresents the descendant of amanaged entity, the additional columns will be populated with the attributevalues of the ancestor managed entity for the attributes defined. If a row represents a gateway or a probethen the cells will be blank.


of 82

geneos gateway plugins technical reference v1.0 · 2018. 5. 9. · l trusted_api_hosts l...

Documents