Installation

Download

From MetricsHub's Web site^[1], download the appropriate RPM package for your system architecture and copy it into /usr/local:

• For x86_64 (amd64) systems: metricshub-enterprise-3.0.02-1.x86_64.rpm
• For aarch64 (arm64) systems: metricshub-enterprise-3.0.02-1.aarch64.rpm

Install

Once you have downloaded the RPM package, run the following rpm command:

For x86_64 systems:

cd /usr/local
sudo rpm -i metricshub-enterprise-3.0.02-1.x86_64.rpm

For aarch64 systems:

cd /usr/local
sudo rpm -i metricshub-enterprise-3.0.02-1.aarch64.rpm

When complete, the MetricsHub's files are deployed in /opt/metricshub and the MetricsHubEnterprise Agent is started as a service.

Configure

• Structure your configuration^[2] by creating either one single or multiple configuration file
• Configure your resource groups^[3] and [resources to be monitored.](../configuration/configure-monitoring.md#step-3-configure-resources
• In the ./lib/otel/otel-config.yaml file, located under the /opt/metricshub installation directory, specify where the OpenTelemetry Collector should send the collected data.^[4]

To assist with the setup process, two configuration examples are provided for guidance in the installation directory (./metricshub):

• ./lib/config/metricshub-config-example.yaml, a configuration example of the MetricsHub agent.
• ./lib/otel/otel-config-example.yaml, a configuration example of the OpenTelemetry Collector.

Start

To start the MetricsHub Enterprise service, run the command below:

systemctl start metricshub-enterprise-service

You can start MetricsHub in an interactive terminal with an alternate MetricsHub Agent's configuration file with the command below:

cd /opt/metricshub/bin
./enterprise-service --config=<PATH>

Example:

cd /opt/metricshub/bin
./enterprise-service --config=config/my-metricshub-config.yaml

Stop

To stop the MetricsHub Enterprise service, run the command below:

systemctl stop metricshub-enterprise-service

Uninstall

To uninstall MetricsHub Enterprise, run the appropriate command below based on your architecture:

For x86_64 systems:

sudo rpm -e metricshub-3.0.02-1.x86_64

For aarch64 systems:

sudo rpm -e metricshub-3.0.02-1.aarch64

Upgrade

If you have installed a previous version of MetricsHub Enterprise and want to upgrade to the latest version 3.0.02, follow these steps:

1. From MetricsHub's Web site^[1], download the appropriate RPM package for your system architecture and copy the file into the /usr/local directory:

   • For x86_64 systems: metricshub-enterprise-3.0.02-1.x86_64.rpm
   • For aarch64 systems: metricshub-enterprise-3.0.02-1.aarch64.rpm

2. Run the following command to stop the MetricsHub Enterprise service:

   systemctl stop metricshub-enterprise-service
   

3. Run the following rpm command with the appropriate package for your architecture:

   For x86_64 systems:

   cd /usr/local
   sudo rpm -U metricshub-enterprise-3.0.02-1.x86_64.rpm
   

   For aarch64 systems:

   cd /usr/local
   sudo rpm -U metricshub-enterprise-3.0.02-1.aarch64.rpm
   

Install

You can install MetricsHub Community Edition in two ways:

1. Automatically using the official installation script (recommended)
2. Manually by downloading and extracting the .tar.gz package

Note: Both methods that are outlined below will install MetricsHub to the $HOME/metricshub directory.

curl -fsSL https://get.metricshub.com | bash

$HOME/metricshub/bin/metricshub --version

wget -P /tmp https://github.com/metricshub/metricshub-community/releases/download/v1.0.11/metricshub-community-linux-1.0.11.tar.gz

cd $HOME
tar xzf /tmp/metricshub-community-linux-1.0.11.tar.gz

Configure

After installing MetricsHub, you need to:

• structure your configuration^[2] by creating either one single or multiple configuration file
• configure your resource groups^[3] and resources to be monitored.^[6]
• define the OpenTelemetry Protocol endpoint^[7] that will receive the MetricsHub signals.

To assist with the setup process, the configuration example ./lib/config/metricshub-example.yaml is provided for guidance in the installation directory (./metricshub).

Start

To start MetricsHub in an interactive terminal, run the command below:

cd $HOME/metricshub/bin
./service

To start MetricsHub with an alternate configuration file, run the command below:

cd $HOME/metricshub/bin
./service --config <PATH>

Example:

cd $HOME/metricshub/bin
./service --config config/my-metricshub.yaml

To start MetricsHub as a Linux service, follow the steps below:

• Create a systemd service file

  Create a file (for example: /etc/systemd/system/metricshub-service.service) and define the MetricsHub Service configuration as follows:

  [Unit]
  Description=MetricsHub Service
  
  [Service]
  ExecStart=$HOME/metricshub/bin/service
  Restart=on-failure
  
  [Install]
  WantedBy=multi-user.target
  

• Reload systemd

  After creating the Linux service file, reload systemd to recognize the new service.

  systemctl daemon-reload
  

• Start the MetricsHub Service

  systemctl start metricshub-service
  

  To enable the Linux service to start on boot, run the command below:

  systemctl enable metricshub-service
  

• Check status

  To verify that the MetricsHub Service is running without errors, run the command below:

  systemctl status metricshub-service
  

  This will give you information about the current status of your service.

Stop

Interactive Terminal

To manually stop the MetricsHub Service in an interactive terminal, use the keyboard shortcut CTRL+C. This will interrupt the running process and terminate the MetricsHub Service.

Background Process

If the MetricsHub Service is running in the background, follow these steps to stop it:

1. Run the ps command to get the MetricsHub Service PID:

   ps aux | grep service
   

2. Write down the PID associated with the MetricsHub Service.

3. Terminate the process using the kill command below:

   kill -9 <PID>
   

where <PID> should be replaced with the actual process ID.

Service

To stop the MetricsHub Service that is started as a Linux service, run the command below:

systemctl stop <metricshub-service>

where <metricshub-service> should be replaced with the actual service name. For example, metricshub-service if the systemd service file is /etc/systemd/system/metricshub-service.service

Uninstall

1. Stop the MetricsHub Service.

2. Navigate to the directory where MetricsHub is located (e.g., $HOME) and remove the entire metricshub directory.

   rm -rf $HOME/metricshub
   

If the MetricsHub Service was set up as a Linux Service, delete the file /etc/systemd/system/metricshub-service.service and run the below command to reload systemd:

systemctl daemon-reload