Installing the ServiceWatch Agent

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

ServiceWatch Agent

The agents that must be installed on a Virtual Server to collect custom metrics and logs for ServiceWatch can be broadly divided into two types. Prometheus Exporter and Open Telemetry Collector.

Preconfiguration for Using the ServiceWatch Agent

To use the ServiceWatch Agent, prepare the prerequisites by referring to Prerequisites for the ServiceWatch Agent.

Installing the Prometheus Exporter for Virtual Server (for Linux)

Install the Prometheus Exporter on a Linux server by following the steps below.

Node Exporter is configured after creating a dedicated user.

Create a Node Exporter User

Create a dedicated user to securely 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 Configuration

1. Download it to install Node Exporter. This guide covers the following version.
   • Download path: /tmp
   • Installed version: 1.7.0
     • Tab 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 permissions to the executable file.

   • Tab 0

   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

   • Tab 0

   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. Creates a service file. 3. Configure Node Exporter to collect memory metrics (meminfo) or block storage metrics (filesystem).

   • –collector.disable-defaults: Disable default metrics
   • –collector.meminfo: Enable memory metrics
   • –collector.filesystem: Enable block storage filesystem metrics
     • Tab 0

     Sample Code Download

     Copy Code

     Color mode

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

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

     • Tab 0

     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 \
       --collector.meminfo \
       --collector.filesystem
     
     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 \
       --collector.meminfo \
       --collector.filesystem
     
     Restart=on-failure
     
     [Install]
     WantedBy=multi-user.target

4. Enable and Start the Service Register the Node Exporter service and verify the registered service and configured metrics.
   • Tab 0

   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

   • Tab 0

   Sample Code Download

   Copy Code

   Color mode

   sudo systemctl status node_exporter

   sudo systemctl status node_exporter

   • Tab 0

   Sample Code Download

   Copy Code

   Color mode

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

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

Installing the Prometheus Exporter for Virtual Server (for Windows)

To use the Prometheus Exporter on a Windows server, install it by following the steps below.

Windows Exporter Configuration

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

     Sample Code Download

     Copy Code

     Color mode

     New-Item -ItemType Directory -Force C:\Temp | Out-Null
     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"

     New-Item -ItemType Directory -Force C:\Temp | Out-Null
     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 By default, the Windows Exporter enables all collectors. To collect only the desired metrics, enable the following collectors. The following is an example of enabling the collector specified by the user.
   • Memory metrics: memory
   • Block storage metrics: logical_disk
   • Host name: os
     • Tab 0

     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 Verification Register the Windows Exporter service and verify the configured metrics.

   • Tab 0

   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

   • Tab 0

   Sample Code Download

   Copy Code

   Color mode

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

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

4. Configuration File Settings

   • You can enable the use of a YAML configuration file by using the –config.file option.
     • Tab 0

     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 using an absolute path, enclose the path in quotation marks.

     .\windows_exporter.exe --config.file=config.yml
     .\windows_exporter.exe --config.file="C:\Program Files\windows_exporter\config.yml" # If using an absolute path, enclose the path in quotation marks.

     • Tab 0

     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

   • See Windows Exporter > Configuration file official example file.
     • Tab 0

     Sample Code Download

     Copy Code

     Color mode

     ---
     #Note that 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 that 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

     To register a service using a configuration file, refer to the following.
     • Tab 0

     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 {

The following is the collector and metric information available through Node Exporter. You can configure it as a Collector or enable only specific metrics.

By default, Node Exporter enables most collectors, but you can enable or disable specific collectors as needed.

• 메모리, 파일 시스템 Collector만 사용하고 싶을 때:
  • Tab 0

  Sample Code Download

  Copy Code

  Color mode

  ./node_exporter \
    --collector.meminfo \
    --collector.filesystem

  ./node_exporter \
    --collector.meminfo \
    --collector.filesystem

• Default 설정은 모두 해제하고 메모리, 파일 시스템 Collector만 사용하고 싶을 때:
  • Tab 0

  Sample Code Download

  Copy Code

  Color mode

  ./node_exporter \
    --collector.disable-defaults \
    --collector.meminfo \
    --collector.filesystem

  ./node_exporter \
    --collector.disable-defaults \
    --collector.meminfo \
    --collector.filesystem

  Enable the file system Collector for a specific mount point
  • Tab 0

  Sample Code Download

  Copy Code

  Color mode

  ./node_exporter \
    --collector.disable-defaults \
    --collector.filesystem.mount-points-include="/|/data"

  ./node_exporter \
    --collector.disable-defaults \
    --collector.filesystem.mount-points-include="/|/data"

  Enable the file system Collector for all mount points except specific ones
  • Tab 0

  Sample Code Download

  Copy Code

  Color mode

  ./node_exporter \
    --collector.disable-defaults \
    --collector.filesystem.mount-points-exclude="/boot|/var/log"

  ./node_exporter \
    --collector.disable-defaults \
    --collector.filesystem.mount-points-exclude="/boot|/var/log"

파일 시스템 collector를 사용하고 싶지 않을때:

./node_exporter --no-collector.filesystem

./node_exporter --no-collector.filesystem

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

[Service]
User=nodeexp
ExecStart=/usr/local/bin/node_exporter \
  --collector.disable-defaults \
  --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 \
  --collector.meminfo \
  --collector.filesystem

[Install]
WantedBy=multi-user.target

You can configure the OpenTelemetry Collector to collect only the necessary metrics from the Node Exporter. When you want to collect only specific metrics from the metrics provided by a specific collector in Node Exporter, [Preconfiguration of Open Telemetry Collector for ServiceWatch](/userguide/management/service_watch/how_to_guides/service_watch_agent/

#Windows Exporter metrics {

The following is the Collector and metric information that can be viewed through the Windows Exporter. You can configure it as a Collector or enable only specific metrics.

By default, the Windows Exporter enables most collectors, but you can configure only the collectors you need.

CPU, 메모리, 논리 디스크만 사용하고 싶을 때:

#The --collectors.enabled option disables the default and enables only the specified Collectors.
.\windows_exporter.exe --collectors.enabled="memory,logical_disk"

#The --collectors.enabled option disables the default and enables only the specified Collectors.
.\windows_exporter.exe --collectors.enabled="memory,logical_disk"

#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
#Start Service
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
#Start Service
Start-Service windows_exporter

#Note that this is not an exhaustive list of all configuration values
collectors:
  enabled: logical_disk,memory
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 that this is not an exhaustive list of all configuration values
collectors:
  enabled: logical_disk,memory
collector:
  service:
    include: "windows_exporter"
  scheduled_task:
    include: /Microsoft/.+
log:
  level: debug
scrape:
  timeout-margin: 0.5
telemetry:
  path: /metrics
web:
  listen-address: :9182

You can configure the OpenTelemetry Collector to collect only the necessary metrics from the Windows Exporter. When you want to collect only specific metrics from the metrics provided by a specific collector in the Windows Exporter, refer to [Open Telemetry Collector Presets for ServiceWatch](/userguide/management/service_watch/how_to_guides/service_watch_agent/