Overview

ConnGauge is a tool which facilitates testing network connections between ConnGauge agents and other devices.

It currently supports 3 types of tests:

Ping

This will perform a ping test from any selected ConnGauge agent to a target device. The target device can also be another ConnGauge agent.

Note: In order for ping to function for a ConnGauge agent on linux you must set network priviledges for the conngauge-agent executable.

sudo setcap cap_net_raw=+ep ./conngauge-agent. Alternatively you can run the agent as root, however this is not recommended.

Connect

This will perform a TCP Connect test from any selected ConnGauge agent to a target device on a specified TCP port. The target device can also be another ConnGauge agent.

Speed

This will perform a speed / throughput test between two ConnGauge agents. The test will be performed for a specified duration. The min and max durations are between 1 and 30 seconds.

ConnGauge Server

The server is a standalone cross platform executable. It can be run directly on a Linux or Windows OS. it can also be embedded in a docker container. It provides a web interface which runs only in https on the port specified at runtime, or if no port is specified it will run on port 443.

The server consists of the following files and folders:

conngauge.exe / conngauge

This is the Windows and Linux executable.

It supports a parameter to set the TCP port. If the parameter is not specified the default port (443) will be used.

conngauge -port 8443

The default credential is: admin / ConnGauge

config.json

This configuration file contains the settings for the server and also stores the user and agent details. It will be auto generated on first run if it does not exist. Any changes made to the config file do not take effect until the executable is stopped and started again. Note that not all the configuration items in the config.json file are being used at this time, it is for future use.

  • Agents

    • This is an array which stored the configuration details of the ConnGauge agents

  • Users

    • This stored the details of the users that can log into and use the ConnGauge Server

cert.pem

This is the TLS Certificate. If the file does not exist at execution time, the agent will generate a self-signed one.

key.pem

This is the TLS Private Key. If the file does not exist at execution time, the agent will generate one.

license.txt

This is the license file and must contain valid license code.

pages

This folder contains the web page templates used by the server.

jobs

Any jobs created inside the Jobs section of the server page will get items created here. This stores the results, which are also visible in the web interface.

ConnGauge Agent

The agent is a standalone cross platform executable. It can be run directly on a Linux or Windows OS. it can also be embedded in a docker container.

The agent consists of the following files:

conngauge-agent.exe / conngauge-agent

This is the Windows and Linux executable.

It supports a parameter to set the TCP port. If the parameter is not specified the default port (443) will be used.

conngauge-agent -port 8443

config.json

This configuration file contains the settings for the agent. It will be auto generated on first run if it does not exist. Any changes made to the config file do not take effect until the agent executable is stopped and started again. Note that not all the configuration items in the config.json file are being used at this time, it is for future use.

  • Name

    • This is the name to display on the ConnGauge server for the agent

  • Description

    • This is displayed in the Agent View. It can be used to describe the location of the agent

  • AuthToken

    • This is auto generated if the config.json file does not exist when the executable is run the first time.

cert.pem

This is the TLS Certificate. If the file does not exist at execution time, the agent will generate a self-signed one.

key.pem

This is the TLS Private Key. If the file does not exist at execution time, the agent will generate one.