MiniGeneos
EOL
Effective 31 March 2022, MiniGeneos reached end of life. This documentation is archived and will no longer be updated.
Docker images for Gateway and Netprobe are now available. The Gateway can also be run in demo mode for limited use. For more information, see Geneos containers.
Overview Copied
MiniGeneos is a brand-new utility for Geneos. It includes a Gateway, a Netprobe and a slim version of the Gateway Hub, all packaged into a single Docker container. MiniGeneos deploys a MiniHub which consists of a single node and volatile storage only.
Caution
MiniGeneos is a fully supported utility for non-production use only. It must not be deployed in production environments, either to monitor your infrastructure or to monitor applications.
MiniGeneos serves a number of purposes:
- Enable a developer to validate their in-app monitoring without needing to know how to configure Geneos.
- Run a mini version of Gateway Hub as a POC in order to see its benefits.
- Quickly demo the Geneos stack.
Although it is an excellent tool for these purposes, it is not supported for production use for the following reasons:
- The mini version of the Gateway Hub is not designed for production load.
- The configuration is simplified.
- The components share a container for ease of use, so the processes are not isolated.
- Data is not persisted in MiniGeneos. Stopping or restarting the container will clear all existing data.
Note
MiniGeneos runs Gateway in demo mode. For more information, see Demo mode in Gateway Licensing.
Versions Copied
There are two types of versions of MiniGeneos:
- The GA versions which contain GA components and are considerably more stable.
- The SNAPSHOT versions which contain nightly build components which are more up to date but may include bugs and incomplete features.
Caution
Use the SNAPSHOT versions at your own risk.
Prerequisites Copied
To run the MiniGeneos image, you must have the following installed:
- Docker.
To access the data from the Gateway, you need to install Active Console.
Install Copied
To run MiniGeneos you must download the container image from the ITRS docker registry.
To access the ITRS docker registry, run:
docker login docker.itrsgroup.com
This prompts you to provide login details, these are the same as the credentials you have been provided to access the ITRS website.
If you do not have login credentials, you can request these from the ITRS Registration page.
Start MiniGeneos Copied
The simplest way to start MiniGeneos is to use the docker run command. Docker automatically downloads a specified image if a copy is not available locally.
To start a MiniGeneos container in interactive mode using the most recent GA image, run:
docker run --rm --init --name minigeneos --hostname minigeneos --interactive --tty -p 8080:8080 -p 8443:8443 -p 9092:9092 -p 7039:7039 -p 8081:8081 -p 8125:8125/udp docker.itrsgroup.com/minigeneos:latest
To start a MiniGeneos container in interactive mode using a specific version, run:
docker run --rm --init --name minigeneos --hostname minigeneos --interactive --tty -p 8080:8080 -p 8443:8443 -p 9092:9092 -p 7039:7039 -p 8081:8081 -p 8125:8125/udp docker.itrsgroup.com/<image-name>
Replace <image_name> with the name of MiniGeneos version you want to run. Image names use the format minigeneos:tag.
For more information, consult the Docker documentation.
The versions of MiniGeneos available for download are:
| MiniGeneos version tag | Geneos components |
|---|---|
| 1.2.0-SNAPSHOT | Latest snapshot images |
| 1.1.2 |
MiniHub 2.1.0 Gateway 5.2.2 Netprobe 5.2.2 Collection Agent 2.1.0 |
| 1.1.0 |
MiniHub 2.1.0 Gateway 5.2.0 Netprobe 5.2.0 Collection Agent 2.0.0 |
| 1.0.0 |
MiniHub 2.0.0 Gateway 5.1.0 Licence Daemon 5.1.0 Netprobe 5.1.0 Collection Agent 2.0.0 |
Configure Copied
You can mount directories on the host machine to provide configuration files for MiniGeneos components.
To start MiniGeneos and mount a directory on the host system, run:
docker run --rm --init --name minigeneos --hostname minigeneos --interactive --tty -v <host_path>:<container_path> -p 8080:8080 -p 8443:8443 -p 9092:9092 -p 7039:7039 -p 8081:8081 -p 8125:8125/udp docker.itrsgroup.com/<image-name>
You should replace <host_path> with the path to the directory on the host machine you want to share and <container_path> with a location in the MiniGeneos container. By default, MiniGeneos will check the /project directory in the container for configuration files.
The Gateway component will be started using the setup file located at /project/gateway/gateway.setup.xml. You can add include files relative to this file if required.
Connect to MiniGeneos Copied
You can connect to MiniGeneos to view data or add new data sources.
The MiniGeneos container exposes the following ports:
| Port | Usage |
|---|---|
| 7039 | Active Console. |
| 8080 | HTTP communication. Used by the Web Console and REST API. |
| 8443 | HTTPS communication. Used by the Web Console and REST API. |
| 9092 | Kafka. |
| 8081 | Collection Agent health status. |
| 8125 | Collection Agent StatsD. |
Connect with the Active Console Copied
To access MiniGeneos using Active Console, add localhost:7039 to your connections settings.
For more information, see Workspace Settings.
Connect with the Web Console Copied
To access the Web Console, navigate to http://localhost:8080.
For more information, see Monitoring in Gateway Hub .