### MetricsHub
MetricsHub 1.0.00

Home
- Installation

# Installation

## Enterprise Edition

### Download

From MetricsHub's Web site[1], download metricshub-enterprise-windows-1.1.00.msi.

### Install

Double-click the `.msi` file you previously downloaded. The Installation Wizard will automatically start and guide you through the installation process.

When complete, the MetricsHub's files are deployed to the destination folder (by default under `C:\Program Files\MetricsHub`) and the MetricsHubEnterprise Agent is started as a service and appears in services.msc.

MetricsHub operates using the configuration located in the `ProgramData\MetricsHub` directory

### Configure

- In the C:\ProgramData\MetricsHub\config\metricshub.yaml file, configure the resources to be monitored.[2]
- In the C:\ProgramData\MetricsHub\otel\otel-config.yaml file, 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 (`C:\Program Files\MetricsHub`):

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

### Start

To start the MetricsHub Enterprise service, open services.msc and start the MetricsHub Enterprise service.

### Uninstall

To uninstall MetricsHub Enterprise, double-click the metricshub-enterprise-windows-1.1.00.msi file and click Remove when prompted.

### 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-windows-1.1.00.msi.
2. Open services.msc and stop the MetricsHub Enterprise service.
3. Double-click the `.msi` file you previously downloaded. The Installation Wizard will automatically start and guide you through the upgrade process.

## Community Edition

### Download

Download the Windows package, `metricshub-windows-1.0.00.zip`, from the MetricsHub Release v1.0.00[4] page.

### Install

Unzip the content of `metricshub-windows-1.0.00.zip` into a program folder, like `C:\Program Files`. There is no need to create a specific subdirectory for `MetricsHub` as the zip archive already contains a `MetricsHub` directory.

> Note: You will need administrative privileges to unzip into `C:\Program Files`.

### Configure

In the `C:\ProgramData\MetricsHub\config\metricshub.yaml` file, 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 `.\config\metricshub-example.yaml` is provided for guidance in the installation directory (typically, `C:\Program Files\MetricsHub`).

### Start

To start MetricsHub Service in `CMD.EXE` or `Windows Terminal`[6], run the command below:

    cd "c:\Program Files\MetricsHub"
    MetricsHubServiceManager

> Note: Run `CMD.EXE` or `Windows Terminal` with elevated privileges (Run As Administrator).

This will start MetricsHub with the default configuration file `C:\ProgramData\MetricsHub\config\metricshub.yaml`.

Run the command below to start MetricsHub with an alternate configuration file:

    cd "c:\Program Files\MetricsHub"
    MetricsHubServiceManager --config <PATH>

Example:

    cd "c:\Program Files\MetricsHub"
    MetricsHubServiceManager --config C:\ProgramData\MetricsHub\config\my-metricshub.yaml

To start MetricsHub as a Windows service, run the following commands under the installation folder (assuming the product has been installed in `C:\Program Files`):

    cd "c:\Program Files\MetricsHub"
    service-installer install MetricsHub "c:\Program Files\MetricsHub\MetricsHubServiceManager.exe"
    service-installer set MetricsHub AppDirectory "c:\Program Files\MetricsHub"
    service-installer set MetricsHub DisplayName MetricsHub
    service-installer set MetricsHub Start SERVICE_AUTO_START

To check MetricsHub's status, run the following command:

    sc query MetricsHub

The service will appear as `MetricsHub` in the `services.msc` console.

### Stop

Interactive Terminal

To stop the MetricsHub Service manually, 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, execute the `taskkill` command as follows:

    taskkill /F /IM MetricsHubServiceManager.exe

Service

To stop the MetricsHub Service started as a Windows service:

1. Run `services.msc` to access all the Windows services.
2. In the Services window, locate the `MetricsHub`service you manually created.
3. Right-click the `MetricsHub` service and click Stop.

### Uninstall

1. Stop the MetricsHub Service.
2. Navigate to the folder where MetricsHub is installed (e.g., `C:\Program Files`) and delete the entire `MetricsHub` folder.

If the MetricsHub Service was set up as a Windows Service, run the following command to remove it:

    sc delete MetricsHub

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
- [6] https://www.microsoft.com/en-us/p/windows-terminal/9n0dx20hk701?activetab=pivot:overviewtab

## 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.