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

Diagnostics Quick start

Step 1: Run a single node cluster

The diagnostics tool connects to a single cluster node. You can find out how to do this on the /get_started/installation page.

Note: You do not need to configure any gateway connections for the node; the diagnostics tool will manage this for you.

Step 2: Download and extract the diagnostics tool

Download the Open Access Diagnostics zip file from our Downloads Page. Extract the downloaded package into an installation directory of your choice.

Step 3: Create a gateways file

Create a text file called gateways.conf and add some gateways to it:

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

The format is the same as the cluster: /cluster/gateway_connections. You can specify usernames and passwords if required.

Step 4: Run it

From the shell, invoke the oadiagnostics.sh or oadiagnostics.bat depending on your platform. Assuming the open access is running on localhost:2551:

$ ./oadiagnostics.sh -Dname=MyReport -Doa=localhost:2551 -Dgws=gateways.conf

Alternatively you can specify all the settings in config/application.conf (See Configuration) and simply run the script with no arguments:

$ ./oadiagnostics.sh

You should see output like this (some detail omitted):

user@localhost:~/$ ./oadiagnostics.sh
---------------------------------Interrogating---------------------------------
Connecting to Open Access @ geneos.cluster://my-node-host:2551...
1 gateway(s) configured. Reading cluster configuration...
Got configurations, saved 0 gateway(s)
Processing 1 gateway(s)...
100% [██████████████████████████████████████████████████████] 1 of 1 (my-gateway:7041)
...
Success, Data wrote to /home/user/openaccess-diagnostics/out/data/MyReport
-----------------------------------Reporting-----------------------------------
Creating Report using data in /home/user/openaccess-diagnostics/out/data/MyReport
Parsing data from 1 file(s)...
Aggregating data from 1 file(s)...
...
Success, report wrote to /home/user/openaccess-diagnostics/out/report/MyReport
------------------------------------Zipping------------------------------------
Created zip file /home/user/openaccess-diagnostics/MyReport.zip

Once complete, open index.html in the report directory using a web browser.