Hostmetrics Dashboard

Overview of Hostmetrics Dashboard in SigNoz

Overview

The Host Metrics dashboard consists of charts for monitoring instance metrics and is designed as a generic dashboard with a hostname variable. You can access detailed information on common host system metrics such as:

• CPU Usage
• Memory Usage
• Disk I/O
• Filesystem Usage
• Network I/O

A full list of supported hostmetrics can be found here.

Setup

You can choose from the two options below.

SigNoz Cloud

A receiver serves as the entry point for data into the OpenTelemetry Collector. The Host Metrics receiver collects metrics about the host system from various sources, such as files located in paths like /sys/block/sda/size and /proc/... on the host machine. It reads and formats the data from these sources into an OTLP-compatible format. This receiver is intended to be used when the OpenTelemetry Collector is deployed as an agent.

HostMetrics collection process for SigNoz Cloud

Follow the below steps to set up the HostMetrics Dashboard on the SigNoz UI.

Step 1 : Setup OTel Collector as an agent

Follow the steps in SigNoz Cloud section of this tutorial to get your Otel Collector agent up and running.

Step 2 : Download/Copy the hostmetrics JSON file

Hostmetric JSON file will help you create a pre-built dashboard about all the categories of host metrics provided by hostmetrics receiver.

Use this GitHub Link to download/copy the hostmetrics-with-variable.json file. The structure of the JSON file is shown below.

Structure of hostmetrics-with-variable.json

Step 3 : Import hostmetrics JSON file to SigNoz Cloud

Open your SigNoz Cloud UI and go to the Dashboards section. In the top right corner, click on the + New Dashboard button and select the Import JSON option from the dropdown menu.

Create a New Dashboard by importing JSON

Upload/paste your hostmetrics-with-variable.json data and click on Load JSON button

Load the Hostmetrics JSON file

After loading the JSON, you can find your hostname in the $hostname dropdown menu. Select it, and you'll access the Hostmetrics Dashboard for the VM where you've configured the OTel collector.

Select hostname from the dropdown

Self-Host

A receiver serves as the entry point for data into the OpenTelemetry Collector. The Host Metrics receiver collects metrics about the host system from various sources, such as files located in paths like /sys/block/sda/size and /proc/... on the host machine. It reads and formats the data from these sources into an OTLP-compatible format. This receiver is intended to be used when the OpenTelemetry Collector is deployed as an agent.

There are two ways in which the Self-Host version of SigNoz can be configured:

• SigNoz is installed on the same VM as your application
• SigNoz is installed on a different VM

On Same VM

When SigNoz is running on the same VM as the Host, it automatically starts collecting the Hostmetrics data because the hostmetrics receiver is enabled by default in the OTel collector that comes bundeled with SigNoz.

HostMetrics collection process for Self-Host SigNoz on same VM

On Different VM

When SigNoz runs on a different VM, you must configure the OTel Collector with the hostmetrics receiver enabled on each VM where you want to collect Hostmetrics data. This data is subsequently sent to SigNoz.

HostMetrics collection for Self-Host SigNoz on different VM

Follow the below steps to set up the HostMetrics Dashboard on SigNoz UI.

Step 1 : Setup OTel Collector as an agent

note

If SigNoz is installed on Same VM as host, you don't need to do this step.

Follow the steps in Self-Host section of this tutorial to get your Otel Collector agent up and running.

Step 2 : Download/Copy the hostmetrics JSON file

Hostmetric JSON file will help you create a pre-built dashboard about all the categories of host metrics provided by hostmetrics receiver.

Use this GitHub Link to download/copy the hostmetrics-with-variable.json file. The structure of the JSON file is shown below.

Structure of hostmetrics-with-variable.json

Step 3 : Import hostmetrics JSON file to SigNoz UI

Open your SigNoz UI and go to the Dashboards section. In the top right corner, click on the + New Dashboard button and select the Import JSON option from the dropdown menu.

Create a New Dashboard by importing JSON

Upload/paste your hostmetrics-with-variable.json data and click on Load JSON button

Load the Hostmetrics JSON file

After loading the JSON, you can find your hostname in the $hostname dropdown menu. Select it, and you'll access the Hostmetrics Dashboard for the VM where you've configured the OTel collector.

Select hostname from the dropdown

Dashboard Configurations

Click on Configure button at top right corner to change the name, add/remove tags, edit description, and add more variables to your dashboard.

Hostmetrics General Settings

Hostmetrics Variables Settings

To explore more dashboard functionalities, check out the Dashboard Section.