Skip to main content

Quick Start - Enterprise Edition

This quick start guide provides step-by-step instructions for deploying MetricsHub Enterprise Edition in your environment. The Enterprise Edition includes a bundled OpenTelemetry Collector, making it easier to send metrics to your observability platform.

After completing this quick start, you will have:

  • MetricsHub Enterprise installed on your machine
  • The MetricsHub Agent configured to collect metrics from your local host
  • Metrics flowing to your chosen observability platform

Prerequisites​

  • Administrator/root access on the target system
  • Network access to the systems you want to monitor
  • A valid license key (or use the 30-day trial)

Step 1: Install MetricsHub Enterprise​

Download and install MetricsHub Enterprise for your platform:

PlatformInstallation
WindowsDownload the .msi installer and run the wizard
Debian/UbuntuDownload the .deb package and install via apt or dpkg
Red Hat/CentOSDownload the .rpm package and install via yum or rpm
DockerPull from docker.metricshub.com

Note: Registered customers have access to private package repositories. See Installation for detailed instructions.

After installation:

  • Windows: MetricsHub is installed to C:\Program Files\MetricsHub with configuration in C:\ProgramData\MetricsHub
  • Linux: MetricsHub is installed to /opt/metricshub

Step 2: Configure Your License​

Edit the license configuration file:

  • Windows: C:\ProgramData\MetricsHub\config\license.yaml
  • Linux: /opt/metricshub/lib/config/license.yaml
license:
  product: MetricsHub Enterprise
  organization: YOUR_ORGANIZATION
  expiresOn: EXPIRATION_DATE
  resources: NUMBER_OF_RESOURCES
  key: YOUR_LICENSE_KEY

Note: If you don't have a license key yet, MetricsHub Enterprise includes a 30-day trial. Contact sales@metricshub.com to obtain your license.

Run the following command to validate your license:

metricshub --validate-license

Step 3: Configure Your First Resource​

Create or edit the main configuration file:

  • Windows: C:\ProgramData\MetricsHub\config\metricshub.yaml
  • Linux: /opt/metricshub/lib/config/metricshub.yaml

Monitoring the Local Windows Host​

attributes:
  site: my-datacenter

resources:
  localhost:
    attributes:
      host.name: ${env::COMPUTERNAME:-localhost}
      host.type: win
    protocols:
      wmi:
        timeout: 120s

Monitoring the Local Linux Host​

attributes:
  site: my-datacenter

resources:
  localhost:
    attributes:
      host.name: ${env::HOSTNAME:-localhost}
      host.type: linux
    protocols:
      osCommand:
        timeout: 120s
        useSudo: true

These examples follow the default local-host configuration. The ${env::VARIABLE:-localhost} directive reads VARIABLE from the environment of the MetricsHub Agent process and uses localhost if it is unset or empty. The defaults use COMPUTERNAME on Windows and HOSTNAME on Linux. On Linux, if HOSTNAME is unset or empty (as is common when the agent runs as a service), MetricsHub reads the kernel hostname from /proc/sys/kernel/hostname before falling back to localhost. This helps distinguish local-host metrics when multiple agents report to the same observability platform. The localhost resource key remains a configuration identifier; the resolved host.name is reported in metrics.

Step 4: Configure the OpenTelemetry Exporter​

The Enterprise Edition includes a bundled OpenTelemetry Collector. Configure your destination in:

  • Windows: C:\ProgramData\MetricsHub\otel\otel-config.yaml
  • Linux: /opt/metricshub/lib/otel/otel-config.yaml

Example: Sending to Prometheus​

exporters:
  prometheus:
    endpoint: '0.0.0.0:9464'

service:
  pipelines:
    metrics:
      receivers: [otlp]
      processors: [memory_limiter, batch]
      exporters: [prometheus]

Example: Sending to Datadog​

exporters:
  datadog:
    api:
      key: ${DD_API_KEY}
      site: datadoghq.com

service:
  pipelines:
    metrics:
      receivers: [otlp]
      processors: [memory_limiter, batch]
      exporters: [datadog]

See Sending Telemetry Data for more exporter configurations.

Step 5: Start MetricsHub​

On Windows​

Start the service from the Services console or run:

Start-Service "MetricsHub Enterprise"

On Linux​

sudo systemctl start metricshub
sudo systemctl enable metricshub  # Start on boot

Verify It's Running​

Check the service status:

  • Windows: Open Services and verify "MetricsHub Enterprise" is running
  • Linux: sudo systemctl status metricshub

Check the health endpoint:

curl http://localhost:13133

Expected response:

{ "status": "Server available", "upSince": "...", "uptime": "..." }

Step 6: Access the Web Interface​

  1. Create a user account (see Operating the Web Interface)
  2. Log in to view your monitored resources and metrics
  3. Use the Web interface to add more resources or adjust configuration

Next Steps​

Getting Help​