⚠️ Xitogent v1 is not supported anymore, please login to your Xitoring dashboard and install Xitogent v2. more information can be found on documents
What is Xitoring
Innovations that makes your daily routine easier
Xitoring is an innovative monitoring platform (SaaS) for servers. We bring data from your server using our agent Xitogent to make sure your server is doing fine and avoid any downtime, performance issues, and increasing your customer’s satisfaction.
Our global probing nodes are always monitoring your servers and as soon as a hiccup is detected, we’ll notify the right contact. We’re continuously working to make our software better and providing incredible features in the future.
Introduced in 2021 to make a revolution in the Server Monitoring industry for whom those are tired of those traditional ways and looking forward to Automation
Monitoring for Free
Monitor 5 Servers for free, no limited time, no credit cards, You just need to register
What is Xitogent
Xitogent is a python-based and open-source application that is the core of Xitoring, Xitogent can collect data from your servers in an efficient way. it’s very lightweight, easy to install, and configurable. We are always developing Xitogent to improve and add features, At this time Xitogent has been tested on all major Linux Distros which are the most used OSes in the market.
The Xitogent runs as a service on your server and automatically send your server statistics continuously to your nearest Xitoring’s Server and we use the data to generate graphs or find out if something’s wrong on your server (e.g. we’ll automatically notify you if your CPU or memory usage is above normal).
The Agent runs on a recurring interval and sends statistics to the nearest probe node, we’ll use the data to make sure everything is fine on your server and then use it to make useful graphs (Server Load, CPU Usage, Memory Usage, Disk IO, and Disk Usage).
What data will Xitogent collect from your Servers?
We only collect data that is necessary for generating Server Graphs and Server Statistics including CPU Usage, Server Load, Memory Usage, Disk IO, Disk Usage, Top processes, Installed Common Softwares, and general details including Hostname and IP Addresses.
Which OSes are supported?
We support major Linux distributions and we’ll release the Windows Server’s Agent soon.
Xitogent is successfully tested on the following distributions but it’s proofed to work on most major distributions.
- Centos 6/7/8
- Fedora 27/30/31/32
- Redhat 8
- Ubuntu 14.04/15.04/16.04/18.04/19.04/20.04
- Debian 5/6/7/8/9/10
- OpenSuse 15.1
- Rocky Linux 8.4
- CloudLinux 8.4
- AlmaLinux 8.4
Installation Manual
Xitogent can be installed using our Installer Script, it will automatically download and set up the environment for Xitogent to work, but the main difference between the automatic installation and manual installation is that when you Install Xitogent with our installer script you will get the binary version set up on your system, but say you want to use the non-binary version, in case of that you need to manually set up everything yourself step by step.
Installing Python
As we said before, Xitogent is a Python-Based tool so if you want to use the non-binary version you need to have Python installed first. As of version 1.0.0, Xitogent will require python 3.6 and higher.
On CentOS 7 and later
yum install python3 python3-pip
On Ubuntu 20.04
apt install python3 python3-pip
Install Python libraries
There are 3 main Python dependencies that Xitogent needs to run, requests, psutil, and localStoragePy. you can easily install them using pip.
pip install requests
pip install psutil
pip install localStoragePy
Creating config file
By default, Xitogent uses /etc/xitogent/xitogent.conf
as the config file so you need to create the directory and the config file within it.
mkdir /etc/xitogent
touch /etc/xitogent/xitogent.conf
But you can place the config file somewhere else and point Xitogent to it using -c
flag for more information check the Xitogent help list.
python xitogent.py -c /path/to/config start
Register your Server
After setting up everything for Xitogent on your Server, now it's for Xitogent to set up your server for monitoring. for registering your server to the Xitoring App some of the arguments are necessary required:
register
This argument is used only for the first time and will register/add your server to your Xitoring panel.
--key
You can find your key from the Xitoring panel > Servers > Add Server modal.
--auto_update=false
Make sure to disable auto-update because auto-update is not possible when you are using the non-binary version.
Find the Key
In Xitoring App go to the Account page from the sidebar panel, On the right side of that page you can see the API Access section there is a default API key generated for your account which is the one that is used in the default add server command in Servers page, you either can use that API key or you can create a new one and specify a expire date for it. using each one of those options is your choice.
Below is an example of a complete register command where 4 modules, auto triggers, auto discovery are enabled and auto update is disabled:
python xitogent.py register --key=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx --module_ftp=ture --module_dns=true --module_http=true --module_ping=true --auto_discovery=true --auto_trigger=true --auto_update=false
You can learn more about Xitogent arguments and params using xitogent help
Start Xitogent
After registering your Server to your panel, you need to start the Xitogent process to gather and send data, for starting Xitogent from the command line you can easily execute:
python xitogent.py start
Stop Xitogent
You can easily stop the Xitogent process using:
python xitogent.py stop
Xitogent Pause/Unpause
Using the python xitogent.py pause
argument will stop Xitogent from collecting and sending data for monitoring, you can use it for multiple purposes like maintenance, network configuration changes, etc. the most important feature of Xitogent pause is that you can determine how much time you need it to stay pause and after that xitogent will automatically start collecting and sending data. for example:
the following example will pause Xitogent for 2 hours.
python xitogent.py pause 2h
Obviously, you can unpause Xitogent with:
python xitogent.py unpause
Xitogent Status
You can get a brief report of Xitogent with python xitogent.py status
command it will output a report like below:
Status running
Uptime 07:45:36
Sent sequences 4689
Failed sequences 0
Creating Service for Xitogent
You can manage the Xitogent process with service managers like systemd and SysV or just run it as a daemon background process, you need to create a service file based on the service manager that your OS uses.
systemd Service
The default path for systemd services is:
/etc/systemd/system/
You can create a service file for Xitogent using:
vi /etc/systemd/system/xitogent.service
Here is an example of a Xitogent systemd service file content:
[Unit]
Description=Xitogent Service
After=network.target
[Service]
Type=forking
PIDFile=/var/run/xitogent.pid
ExecStart=/usr/bin/python /etc/xitogent/xitogent.py start -d -c /etc/xitogent/xitogent.conf
ExecStop=/usr/bin/python /etc/xitogent/xitogent.py stop
Restart=on-failure
RestartSec=10s
[Install]
WantedBy=multi-user.target
After creating a service file you need to run the following command to take effect.
systemctl daemon-reload
SysV
For older Linux distros like CentOS 6 there is no systemd so you have to stick with the old SysV service manager. you can use the example service file included in the project files called xitogent.bash
.
Make sure that you place the service file in the correct path which is:
/etc/init.d/
No service manager
If your OS doesn't have a service manager or you don't want to use it forever reason, you can run Xitogent with the -d
flag to run in in background:
python xitogent.py start -d
Conclusion
After all these steps depend on your OS your Server will be added to the Xitoring panel and you can monitor all of your resources and services easily If you have further questions about anything you can always contact our support team through support [at] xitoring .com or read more on Document.