### MetricsHub
MetricsHub 1.0.00

Home
- Installation

# Installation

## Enterprise Edition

### Download

From MetricsHub's Web site[1], download metricshub-enterprise-rhel-1.1.00-1.x86_64.rpm and copy into `/usr/local`.

### Install

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

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

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

### Configure

- In the ./lib/config/metricshub.yaml file, located under the `/opt/metricshub` installation directory, configure the resources to be monitored.[2]
- 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.[3]

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

This will start MetricsHub with the default MetricsHub Enterprise Agent configuration file, ./config/metricshub.yaml.

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 command below:

    sudo rpm -e metricshub-1.1.00-1.x86_64

### Upgrade

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

1. From MetricsHub's Web site[1], download metricshub-enterprise-rhel-1.1.00-1.x86_64.rpm and copy the file into the `/usr/local` directory.

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

       systemctl stop metricshub-enterprise-service

3. Run the following `rpm` command:

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

## Community Edition

### Download

Download the Linux package, `metricshub-linux-1.0.00.tar.gz`, from the MetricsHub Release v1.0.00[4] page using the following command:

    wget -P /tmp https://github.com/sentrysoftware/metricshub/releases/download/v1.0.00/metricshub-linux-1.0.00.tar.gz

### Install

Unzip and untar the content of `metricshub-linux-1.0.00.tar.gz` into a program directory, like `/opt`. There is no need to create a specific subdirectory for `metricshub` as the archive already contains a `metricshub` directory.

    cd /opt
    sudo tar xzf /tmp/metricshub-linux-1.0.00.tar.gz

### Configure

In the `./lib/config/metricshub.yaml` file, located under the `./metricshub` installation directory, configure:

- the resources to be monitored.[2]
- the OpenTelemetry Protocol endpoint[5] 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 with the default configuration file `./lib/config/metricshub.yaml`, run the command below:

    cd /opt/metricshub/bin
    ./service

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

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

Example:

    cd /opt/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=/opt/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., `/opt`) and remove the entire `metricshub` directory.

       rm -rf /opt/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

install enterprise community monitoring observability opentelemetry otel
Links:

- [1] https://metricshub.com/downloads
- [2] ../configuration/configure-monitoring.html#configure-resources
- [3] ../configuration/send-telemetry.html#configure-the-otel-collector-28enterprise-edition-29
- [4] https://github.com/sentrysoftware/metricshub/releases/tag/v1.0.00
- [5] ../configuration/send-telemetry.html#configure-the-otlp-exporter-28community-edition-29

## Search Results for {{siteSearch | truncate:'50'}}

{{resultArray.length}}
{{parent.title}} {{parent.title}}

{{result.title}}

{{result.body | truncate:'400'}}

{{parent.title}}
{{result.title}}
{{result.body | truncate:'100'}}

No results.