ServiceWatch Agent Installation

Users can install the ServiceWatch Agent on a Virtual Server to collect custom metrics and logs.

ServiceWatch Agent

The agents that need to be installed on the Virtual Server for collecting ServiceWatch’s custom metrics and logs can be divided into two main types. It is Prometheus Exporter and Open Telemetry Collector.

Installation of Prometheus Exporter for Virtual Server (for Linux)

Install the Prometheus Exporter according to the steps below for use on a Linux server.

Node Exporter Installation

Install Node Exporter according to the following steps.

1. Node Exporter User Creation
2. Node Exporter Settings

Node Exporter User Creation

Create a dedicated user to safely isolate the Node Exporter process.

sudo useradd --no-create-home --shell /bin/false node_exporter

sudo useradd --no-create-home --shell /bin/false node_exporter

Node Exporter Settings

1. Download to install Node Exporter. This guide provides the version below.
   • Download path: /tmp
   • Installation version: 1.7.0
     Sample Code Download

     Copy Code

     Color mode

     cd /tmp
     wget https://github.com/prometheus/node_exporter/releases/download/v1.7.0/node_exporter-1.7.0.linux-amd64.tar.gz

     cd /tmp
     wget https://github.com/prometheus/node_exporter/releases/download/v1.7.0/node_exporter-1.7.0.linux-amd64.tar.gz

2. Install the downloaded Node Exporter and grant permission to the executable file.

   Sample Code Download

   Copy Code

   Color mode

   cd /tmp
   sudo tar -xvf node_exporter-1.7.0.linux-amd64.tar.gz -C /usr/local/bin --strip-components=1 node_exporter-1.7.0.linux-amd64/node_exporter

   cd /tmp
   sudo tar -xvf node_exporter-1.7.0.linux-amd64.tar.gz -C /usr/local/bin --strip-components=1 node_exporter-1.7.0.linux-amd64/node_exporter

   Sample Code Download

   Copy Code

   Color mode

   sudo chown node_exporter:node_exporter /usr/local/bin/node_exporter

   sudo chown node_exporter:node_exporter /usr/local/bin/node_exporter

3. Service file creation Set Node Exporter to collect memory metrics (meminfo) or block storage metrics (filesystem).

   Sample Code Download

   Copy Code

   Color mode

   sudo vi /etc/systemd/system/node_exporter.service

   sudo vi /etc/systemd/system/node_exporter.service

   Sample Code Download

   Copy Code

   Color mode

   [Unit]
   Description=Prometheus Node Exporter (meminfo only)
   Wants=network-online.target
   After=network-online.target
     
   [Service]
   User=node_exporter
   Group=node_exporter
   Type=simple
   ExecStart=/usr/local/bin/node_exporter \
     --collector.disable-defaults \    # Disable default metrics
     --collector.meminfo \             # Enable memory metrics
     --collector.filesystem            # Block Storage Enable filesystem metrics
     
   Restart=on-failure
     
   [Install]
   WantedBy=multi-user.target

   [Unit]
   Description=Prometheus Node Exporter (meminfo only)
   Wants=network-online.target
   After=network-online.target
     
   [Service]
   User=node_exporter
   Group=node_exporter
   Type=simple
   ExecStart=/usr/local/bin/node_exporter \
     --collector.disable-defaults \    # Disable default metrics
     --collector.meminfo \             # Enable memory metrics
     --collector.filesystem            # Block Storage Enable filesystem metrics
     
   Restart=on-failure
     
   [Install]
   WantedBy=multi-user.target

4. Service activation and start Register the Node Exporter service and check the registered service and configured metrics.
   Sample Code Download

   Copy Code

   Color mode

   sudo systemctl daemon-reload
   sudo systemctl enable --now node_exporter

   sudo systemctl daemon-reload
   sudo systemctl enable --now node_exporter

   Sample Code Download

   Copy Code

   Color mode

   sudo systemctl status node_exporter

   sudo systemctl status node_exporter

   Sample Code Download

   Copy Code

   Color mode

   curl http://localhost:9100/metrics | grep node_memory

   curl http://localhost:9100/metrics | grep node_memory

Installation of Prometheus Exporter for Virtual Server (for Windows)

Install according to the steps below to use Prometheus Exporter on a Windows server.

Windows Exporter Installation

Install the Windows Exporter according to the steps below.

1. Windows Exporter Settings

Windows Exporter Settings

1. Download the installation file to install Windows Exporter.
   • Download path: C:\Temp
   • Test version: 0.31.3
     Sample Code Download

     Copy Code

     Color mode

     $ mkdir /Temp
     $ Invoke-WebRequest -Uri "https://github.com/prometheus-community/windows_exporter/releases/download/v0.31.3/windows_exporter-0.31.3-amd64.exe" -OutFile "C:\Temp\windows_exporter-0.31.3-amd64.exe"

     $ mkdir /Temp
     $ Invoke-WebRequest -Uri "https://github.com/prometheus-community/windows_exporter/releases/download/v0.31.3/windows_exporter-0.31.3-amd64.exe" -OutFile "C:\Temp\windows_exporter-0.31.3-amd64.exe"

2. Windows Exporter execution test
   Windows Exporter enables all collectors by default, but to collect only the metrics you want, you need to enable the following collectors. Below is an example of enabling user-specified collectors.
   • Memory Metric: memory
   • Block Storage Metric: local_disk
   • Host name: os
     Sample Code Download

     Copy Code

     Color mode

     $ cd C:\Temp
     $ .\windows_exporter-0.31.3-amd64.exe --collectors.enabled memory,logical_disk,os

     $ cd C:\Temp
     $ .\windows_exporter-0.31.3-amd64.exe --collectors.enabled memory,logical_disk,os

3. Service Registration and Confirmation Register the Windows Exporter service and check the configured metrics.

   Sample Code Download

   Copy Code

   Color mode

   $ sc.exe create windows_exporter binPath= "C:\Temp\windows_exporter-0.31.3-amd64.exe --collectors.enabled memory,logical_disk,os" DisplayName= "Prometheus Windows Exporter" start= auto
   $ Start-Service windows_exporter

   $ sc.exe create windows_exporter binPath= "C:\Temp\windows_exporter-0.31.3-amd64.exe --collectors.enabled memory,logical_disk,os" DisplayName= "Prometheus Windows Exporter" start= auto
   $ Start-Service windows_exporter

   Sample Code Download

   Copy Code

   Color mode

   # Service Check
   $ Get-Service windows_exporter
     
   # Metric Check
   $ Invoke-WebRequest -Uri "http://localhost:9182/metrics" | Select-String memory

   # Service Check
   $ Get-Service windows_exporter
     
   # Metric Check
   $ Invoke-WebRequest -Uri "http://localhost:9182/metrics" | Select-String memory

4. Configuration File Settings

   • You can set it to use a YAML configuration file using the –config.file option.
     Sample Code Download

     Copy Code

     Color mode

     $ .\windows_exporter.exe --config.file=config.yml
     $ .\windows_exporter.exe --config.file="C:\Program Files\windows_exporter\config.yml" # If you use an absolute path, you must enclose the path in quotes.

     $ .\windows_exporter.exe --config.file=config.yml
     $ .\windows_exporter.exe --config.file="C:\Program Files\windows_exporter\config.yml" # If you use an absolute path, you must enclose the path in quotes.

     Sample Code Download

     Copy Code

     Color mode

     collectors:
       enabled: cpu,net,service
     collector:
       service:
         include: windows_exporter
     log:
       level: warn

     collectors:
       enabled: cpu,net,service
     collector:
       service:
         include: windows_exporter
     log:
       level: warn

• Windows Exporter > official example configuration file please refer.
  Sample Code Download

  Copy Code

  Color mode

  ---
  # Note this is not an exhaustive list of all configuration values
  collectors:
    enabled: cpu,logical_disk,net,os,service,system
  collector:
    service:
      include: "windows_exporter"
    scheduled_task:
      include: /Microsoft/.+
  log:
    level: debug
  scrape:
    timeout-margin: 0.5
  telemetry:
    path: /metrics
  web:
    listen-address: ":9182"

  ---
  # Note this is not an exhaustive list of all configuration values
  collectors:
    enabled: cpu,logical_disk,net,os,service,system
  collector:
    service:
      include: "windows_exporter"
    scheduled_task:
      include: /Microsoft/.+
  log:
    level: debug
  scrape:
    timeout-margin: 0.5
  telemetry:
    path: /metrics
  web:
    listen-address: ":9182"

  • Refer to the below to register a service using a configuration file.
    Sample Code Download

    Copy Code

    Color mode

    $ sc.exe create windows_exporter binPath= "C:\Temp\windows_exporter-0.31.3-amd64.exe --config.file=C:\Temp\config.yml" DisplayName= "Prometheus Windows Exporter" start= auto
    $ Start-Service windows_exporter

    $ sc.exe create windows_exporter binPath= "C:\Temp\windows_exporter-0.31.3-amd64.exe --config.file=C:\Temp\config.yml" DisplayName= "Prometheus Windows Exporter" start= auto
    $ Start-Service windows_exporter

Node Exporter metrics

Node Exporter Main Metrics

Below is the collector and metric information that can be checked through Node Exporter. You can set it as a Collector, or you can enable only specific metrics.

Node Exporter Collector and metric collection settings

Node Exporter enables most collectors by default, but you can enable/disable only the collectors you want.

Activate only specific Collector

• When you only want to use the memory and file system collectors:
  Sample Code Download

  Copy Code

  Color mode

  ./node_exporter
    --collector.meminfo            # Memory Collector activation
    --collector.filesystem         # File system Collector activation

  ./node_exporter
    --collector.meminfo            # Memory Collector activation
    --collector.filesystem         # File system Collector activation

• When you want to disable all Default settings and use only the memory and file system Collectors:
  Sample Code Download

  Copy Code

  Color mode

  ./node_exporter
    --collector.disable-defaults    # Disable default metrics
    --collector.meminfo             # Memory Collector activation
    --collector.filesystem          # File system Collector activation

  ./node_exporter
    --collector.disable-defaults    # Disable default metrics
    --collector.meminfo             # Memory Collector activation
    --collector.filesystem          # File system Collector activation

• Enable file system Collector for a specific mount point
  Sample Code Download

  Copy Code

  Color mode

  ./node_exporter
    --collector.disable-defaults    # disable default metrics
    --collector.filesystem.mount-points-include="/|/data"          # Activate file system Collector for /(Root) and /data mount points

  ./node_exporter
    --collector.disable-defaults    # disable default metrics
    --collector.filesystem.mount-points-include="/|/data"          # Activate file system Collector for /(Root) and /data mount points

• Enable file system Collector excluding specific mount points
  Sample Code Download

  Copy Code

  Color mode

  ./node_exporter
    --collector.disable-defaults    # disable default metrics
    --collector.filesystem.mount-points-exclude="/boot|/var/log"    # Enable file system Collector for /boot and /var/log mount points

  ./node_exporter
    --collector.disable-defaults    # disable default metrics
    --collector.filesystem.mount-points-exclude="/boot|/var/log"    # Enable file system Collector for /boot and /var/log mount points

Disable specific Collector (no-collector)

When you don’t want to use the file system collector:

./node_exporter --no-collector.filesystem

./node_exporter --no-collector.filesystem

Configure Collector with Systemd service (recommended)

[Unit]
Description=Node Exporter
After=network-online.target

[Service]
User=nodeexp
ExecStart=/usr/local/bin/node_exporter
  --collector.disable-defaults # Disable all default metric collectors
  --collector.meminfo
  --collector.filesystem

[Install]
WantedBy=multi-user.target

[Unit]
Description=Node Exporter
After=network-online.target

[Service]
User=nodeexp
ExecStart=/usr/local/bin/node_exporter
  --collector.disable-defaults # Disable all default metric collectors
  --collector.meminfo
  --collector.filesystem

[Install]
WantedBy=multi-user.target

How to filter only specific metrics

Through the Open Telemetry Collector configuration, you can set it to collect only the necessary metrics gathered from the Node Exporter. When you want to collect only specific metrics among those provided by a particular collector of Node Exporter, you can refer to Preconfiguration of Open Telemetry Collector for ServiceWatch.

Windows Exporter Metrics

Windows Exporter Main Metrics

Below is the collector and metric information that can be checked through Windows Exporter. You can set it as a Collector, or you can enable only specific metrics.

Windows Exporter Collector and metric collection settings

Windows Exporter enables most collectors by default, but you can configure only the collectors you want.

Activate only specific Collector

CPU, memory, when you want to use only logical disks:

# --collector.enabled option disables the default and activates only the specified Collector
.\windows_exporter.exe --collectors.enabled="memory,logical_disk"

# --collector.enabled option disables the default and activates only the specified Collector
.\windows_exporter.exe --collectors.enabled="memory,logical_disk"

Configure Collector as a service (recommended)

# Register windows_exporter as a service
sc.exe create windows_exporter binPath= "C:\Temp\windows_exporter-0.31.3-amd64.exe --config.file=C:\Temp\config.yml" DisplayName= "Prometheus Windows Exporter" start= auto
# Service Start
Start-Service windows_exporter

# Register windows_exporter as a service
sc.exe create windows_exporter binPath= "C:\Temp\windows_exporter-0.31.3-amd64.exe --config.file=C:\Temp\config.yml" DisplayName= "Prometheus Windows Exporter" start= auto
# Service Start
Start-Service windows_exporter

# Note this is not an exhaustive list of all configuration values
collectors:
  enabled: logical_disk,memory # collector settings to enable
collector:
  service:
    include: "windows_exporter"
  scheduled_task:
    include: /Microsoft/.+
log:
  level: debug
scrape:
  timeout-margin: 0.5
telemetry:
  path: /metrics
web:
  listen-address: ":9182"

# Note this is not an exhaustive list of all configuration values
collectors:
  enabled: logical_disk,memory # collector settings to enable
collector:
  service:
    include: "windows_exporter"
  scheduled_task:
    include: /Microsoft/.+
log:
  level: debug
scrape:
  timeout-margin: 0.5
telemetry:
  path: /metrics
web:
  listen-address: ":9182"

How to filter only specific metrics

Through the Open Telemetry Collector configuration, you can set it to collect only the necessary metrics collected from the Windows Exporter. When you want to collect only specific metrics among those provided by a particular collector of the Windows Exporter, you can refer to the Open Telemetry Collector pre‑configuration for ServiceWatch.