The end of life (EOL) date for this module is on 31 January, 2020.

Configuration

Settings

The configuration file is config/application.conf. The root settings key is geneos.diagnostics. All settings below are prepended with this.

Main settings

Key	Type	Description
openaccess	URL	The URL of the open access node
name	String	The name of the data/report
timeout	Duration	The timeout for configuring and connecting to a gateway If the timeout is exceeded, the gateway connection will be considered a failure
root	Path	The output directory for interrogation data and reporting
interrogate	Boolean	If true, the interrogators examine the system and record data
report	Boolean	If true, the data will be read and a report will be generated
report.sources	String List	List of data sources for an aggregated report
gatewaysFiles	File List	List of gateways files - the lists will be merged
gateways	Gateways	The gateways to which to connect, with host, port and optional username and password
zip	Boolean	If true, the output directory will be zipped

System Interrogator

Local system level information information

Key	Type	Description
interrogators.system.config	Boolean	If true, record the configuration
interrogators.system.sysprops	Boolean	If true, record the java system properties
interrogators.system.environment	Boolean	If true, record the local environment variables

Directory Interrogator

Gets directory level information

Key	Type	Description
interrogators.directory.enabled	Boolean	If true, the directory interrogator will be run
interrogators.directory.types	Set Enum(PROBE, ENTITY, SAMPLER, DATAVIEW)	The types of data for which to query
interrogators.directory.recordItems	Boolean	If true, the properties of each data item will be stored. If false, only the counts will be stored.

DataView Interrogator

Queries every data view to gather size and update rate information

Key	Type	Description
interrogators.dataview.enabled	Boolean	If true, the dataview interrogator will be run
interrogators.dataview.timeout	Duration	The timeout for each dataview query. If the timeout occurs the dataview is considered a failure.
interrogators.dataview.threads	Integer	The number of concurrent dataview queries
interrogators.dataview.sample.time **	Duration	The maximum time to sample a dataview
interrogators.dataview.sample.factor **	Double	Used to determine the sample time based on the sample interval of the dataview: SampleInterval x Factor = SampleTime

Note: ** Sampling will record the number of Open Access updates that occur for a sample period. On a large estate this will take a long time! You can disable this by omitting the interrogators.statistics.sample section.

Gateways

There are two ways of specifying the gateways to which to connect: Inline and Gateway files. To list the gateways inline, use the same format as the node Gateway Connections:

geneos.diagnostics {
    ...
    gateways {
        first-gateway {
            host = "my-gateway"            port = 7041
        }
        second-gateway {
            host = "other-gateway"            port = 7042
        }
    }
    ...

Alternatively you can seperate large numbers of gateways into files. If you create a file called /data/gateways.conf that contains:

{
    first-gateway {
        host = "my-gateway"        port = 7041
    }
    second-gateway {
        host = "other-gateway"        port = 7042
    }
}

Then you can reference the file in the main configuration file like this:

...
gatewaysFiles = ["/data/gateways.conf"]
...

Or mulitple files can be specified:

...
gatewaysFiles = [
  "/data/gateways1.conf",
  "/data/gateways2.conf",
  "/data/gateways3.conf"]
...

oadiagnostics.sh

The oadiagnostics.sh (or oadiagnostics.bat) script can be used to configure settings directly from the command prompt.

The following is equivalent to setting geneos.diagnostics.oa in config/application.conf:

$ ./oadiagnostics.sh -Doa=localhost:2551

Here is a full list of the aliases:

Alias	Description	Setting (In application.conf)	Example
-Dname	The name used for the data/report	geneos.diagnostics.name	-Doa=My-Report
-Doa	Host and port of the Open Access Node	geneos.diagnostics.oa	-Doa=localhost:2551
-Dgws	Comma seperated list of gateway files	geneos.diagnostics.gatewaysFiles	-Dgws=gws1.conf,gws2.conf
-Dreport	Generate a report based on mulitple data sources. When this flag is set, geneos.diagnostics.interrogate is set to ‘false’.	geneos.diagnostics.report.sources	-Dreport=data1,data2