Getting Started¶
Installing AxonOps Unified Monitoring on your own premises as a self-managed cluster gives you full control over every aspect of your AxonOps deployment.
AxonOps components run on a wide array of operating systems including (but not limited to):
- Ubuntu
- Debian
- RedHat Enterprise Linux (RHEL)
- Amazon Linux
AxonOps Unified Monitoring consists of 4 main components:
- axon-server
- backend that collects cluster information and interacts with your clusters.
- axon-dash
- web UI to display and interact with your clusters.
- axon-agent
- called from within the JVM to send metrics to axon-server.
- storage engine
- stores metrics, logs, configurations, and metadata about your cluster.
Below are the steps to install and configure an on-premise AxonOps Unified Monitoring installation.
Setup Storage Engine¶
Elasticsearch is always required and the default data storage for all Cassandra and Kafka metrics as well as application logs, AxonOps configuration and metrics metadata.
You can choose to use Cassandra as a metrics store instead of Elasticsearch for better performance when monitoring larger numbers of nodes.
Elasticsearch is still required in conjunction with the dedicated AxonOps Cassandra cluster.
Elasticsearch (Required)¶
AxonOps is currently compatible with Elasticsearch 7.x and 8.x.
We recommend installing the latest available Elasticsearch release.
Cassandra (Optional)¶
For more information please read more on setting up Cassandra as a Metrics Database.
Setup AxonOps Server¶
Install and configure AxonOps Server (axon-server).
Setup AxonOps Dashboard¶
Install and configure AxonOps Dashboard (axon-dash).
Setup AxonOps Agent¶
Install and configure AxonOps Agent (axon-agent) for Cassandra or Kafka.
Alternative Installation Options¶
Below are different options for on-premise installations of the AxonOps platform, depending on your environment and preferences.
Docker or Podman¶
For quick evaluations or smaller clusters, our Docker and Podman Compose setup is the fastest way to get everything running.
Instructions and files can be found here.
Ansible¶
For an automated and repeatable approach, the Ansible collection can install both the AxonOps Server and Agents across Cassandra or Kafka clusters.
Instructions and files can be found here.
Kubernetes¶
For deployments into Kubernetes environments, a Helm chart is available.
Instructions and files can be found here.
Offline Installations¶
If you need to download packages for offline installation due to security requirements, you can use our package downloader script.
Instructions and files can be found here.
Configuration Automation¶
To easily setup alerts, dashboards, backups, integrations, and other configurations, use this repository of Ansible playbooks to automate AxonOps configuration.
Instructions and files can be found here.