### MetricsHub
MetricsHub 1.0.00

Home
- Installation

# Installation

## Enterprise Edition

### Download

From MetricsHub's Web site[1], download metricshub-enterprise-debian-1.1.00-docker.tar.gz and copy into `/tmp`.

### Install

First, unzip and untar the content of metricshub-enterprise-debian-1.1.00-docker.tar.gz into a docker directory, like /docker.

    sudo mkdir -p /docker
    sudo tar xzf /tmp/metricshub-enterprise-debian-1.1.00-docker.tar.gz -C /docker

Then, build the docker image using the following command:

    cd /docker/metricshub
    sudo docker build -t metricshub:latest .

### Configure

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

You can start MetricsHub with the command below:

    cd /docker/metricshub
    sudo docker run -d --name=metricshub -p 24375:24375 -p 13133:13133 -v /docker/metricshub/lib/config:/opt/metricshub/lib/config -v /docker/metricshub/lib/otel:/opt/metricshub/lib/otel -v /docker/metricshub/lib/logs:/opt/metricshub/lib/logs -v /docker/metricshub/lib/security:/opt/metricshub/lib/security metricshub:latest

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

Docker Compose Example

You can start MetricsHub with docker-compose:

    sudo docker-compose up -d --build

Example docker-compose.yaml

    version: "2.1"
    services:
      metricshub:
        build: .                                        # for image we will use ``image: sentrysoftware/metricshub:latest``
        container_name: metricshub
        ports:
          - 13133:13133                                   # OpenTelemetry Collector HealthCheck
          - 24375:24375                                   # OpenTelemetry Collector Prometheus Exporter
        volumes:
          - ./lib/logs:/opt/metricshub/lib/logs                # Mount the volume ./lib/logs into /opt/metricshub/lib/logs in the container
          - ./lib/config:/opt/metricshub/lib/config            # Mount the volume ./lib/config into /opt/metricshub/lib/config in the container
          - ./lib/otel:/opt/metricshub/lib/otel                # Mount the volume ./lib/otel into /opt/metricshub/lib/otel in the container
          - ./lib/security:/opt/metricshub/lib/security        # Mount the volume ./lib/security into /opt/metricshub/lib/security in the container
        restart: unless-stopped

### 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 website[1], download metricshub-enterprise-debian-1.1.00-docker.tar.gz and copy it into the `/tmp` directory.

2. Stop and remove the currently running MetricsHub container:

       sudo docker stop metricshub
       sudo docker rm metricshub

3. Before upgrading, rename the current metricshub directory to metricshub-previous to backup your configuration files and preserve any custom settings. Ensure that there isn't already a directory named metricshub-previous; if there is, you may need to choose a different name:

       sudo mv /docker/metricshub /docker/metricshub-previous

4. Unzip the new version into the same directory where the previous version was installed:

       sudo tar xzf /tmp/metricshub-enterprise-debian-1.1.00-docker.tar.gz -C /docker

5. Rebuild the MetricsHub Docker image with the latest version:

       cd /docker/metricshub
       sudo docker build -t metricshub:latest .

6. Restore the configuration files to the correct locations:

       sudo cp /docker/metricshub-previous/lib/config/metricshub.yaml /docker/metricshub/lib/config/metricshub.yaml
       sudo cp /docker/metricshub-previous/lib/otel/otel-config.yaml /docker/metricshub/lib/otel/otel-config.yaml

7. Start the MetricsHub container using the upgraded image:

       sudo docker run -d --name=metricshub -p 24375:24375 -p 13133:13133 -v /docker/metricshub/lib/config:/opt/metricshub/lib/config -v /docker/metricshub/lib/otel:/opt/metricshub/lib/otel -v /docker/metricshub/lib/logs:/opt/metricshub/lib/logs -v /docker/metricshub/lib/security:/opt/metricshub/lib/security metricshub:latest

## Community Edition

### Download

Download the Docker package, `metricshub-linux-1.0.00-docker.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-docker.tar.gz

### Install

Unzip and untar the content of `metricshub-linux-1.0.00-docker.tar.gz` into a directory, like `/docker`.

    sudo mkdir -p /docker
    sudo tar xzf /tmp/metricshub-linux-1.0.00-docker.tar.gz -C /docker

### Configure

In the `./lib/config/metricshub.yaml` file, locally 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`).

### Build the docker image

Run the following command to build the docker image:

    cd /docker/metricshub
    sudo docker build -t metricshub:latest .

### Start

Run the following command to start MetricsHub with the default configuration file, `./lib/config/metricshub.yaml`:

    cd /docker/metricshub
    sudo docker run -d --name=metricshub metricshub:latest

You can start MetricsHub with an alternate configuration file with the following command:

    cd /docker/metricshub
    sudo docker run -d --name=metricshub -v /docker/metricshub/lib/config:/opt/metricshub/lib/config -v /docker/metricshub/lib/logs:/opt/metricshub/lib/logs metricshub:latest

Docker Compose Example

You can start MetricsHub with docker compose:

    sudo docker compose up -d --build

Example (`docker-compose.yaml`):

    version: "2.1"
    services:
      metricshub:
        # for image we will use ``image: sentrysoftware/metricshub:latest``
        build: .
        container_name: metricshub
        volumes:
          # Mount the volume ./lib/logs into /opt/metricshub/lib/logs in the container
          - ./lib/logs:/opt/metricshub/lib/logs
          # Mount the volume ./lib/config into /opt/metricshub/lib/config in the container
          - ./lib/config:/opt/metricshub/lib/config
        restart: unless-stopped

### Stop

To stop MetricsHub started as a docker container, run the following command:

    sudo docker stop metricshub

Docker Compose:

If you are using docker compose from the `./metricshub` directory, run the following command to stop MetricsHub:

    sudo docker compose down

### Uninstall

To force-stop and remove the MetricsHub container, run the following commands:

    cd /docker/metricshub
    sudo docker stop -f metricshub
    sudo docker rm -f metricshub

Adjust the commands to meet your specific requirements for stopping and removing the Docker container running MetricsHub.

install upgrade firewalls 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.