Hướng Dẫn Sử Dụng Node Exporter Để Expose Custom Metrics

1. Tổng quan.

Node Exporter là một công cụ mạnh mẽ trong hệ sinh thái Prometheus, được thiết kế để thu thập các số liệu (metrics) liên quan đến hệ thống như CPU, RAM, Disk, Network, v.v. Tuy nhiên, ngoài các số liệu mặc định, bạn cũng có thể sử dụng Node Exporter để expose custom metrics thông qua tính năng Textfile Collector.

Trong bài viết này, chúng ta sẽ tìm hiểu cách sử dụng Node Exporter để expose các custom metrics, giúp bạn giám sát các thông số tùy chỉnh theo nhu cầu của mình.

2. Textfile Collector là gì?

Textfile Collector là một tính năng của Node Exporter cho phép bạn ghi các số liệu tùy chỉnh (custom metrics) vào một file .prom. Node Exporter sẽ đọc file này và expose các số liệu đó tại endpoint /metrics. Tính năng này rất hữu ích khi bạn muốn giám sát các thông số không có sẵn trong Node Exporter, chẳng hạn như:

– Số lượng người dùng đăng nhập vào hệ thống.

– Trạng thái của một dịch vụ cụ thể.

– Các số liệu từ ứng dụng của bạn.

3. Kiểm tra Textfile Collector

Textfile Collector thường được kích hoạt mặc định trong Node Exporter. Để kiểm tra, bạn có thể truy cập endpoint `/metrics` của Node Exporter (thường là `http://localhost:9100/metrics`) và tìm kiếm các số liệu liên quan đến `node_textfile`.

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

Nếu bạn thấy các số liệu như `node_textfile_scrape_error`, điều đó có nghĩa là Textfile Collector đã được kích hoạt.

4. Cài đặt Node Exporter.

Tóm tắt các bước cài đặt Node Exporter:

Tải xuống phiên bản mới nhất của Node Exporter:

Sử dụng API của GitHub để lấy URL tải xuống bản phát hành mới nhất cho Linux (linux-amd64).

Tải file .tar.gz và giải nén.

curl -s https://api.github.com/repos/prometheus/node_exporter/releases/latest| grep browser_download_url|grep linux-amd64|cut -d '"' -f 4|wget -qi -
tar -xvf node_exporter*.tar.gz

Cài đặt Node Exporter:

Sao chép file thực thi node_exporter vào bin để có thể chạy từ bất kỳ đâu.

cd node_exporter*/
cp node_exporter /usr/local/bin

Kiểm tra phiên bản Node Exporter:

Chạy lệnh node_exporter --version để xác nhận rằng Node Exporter đã được cài đặt thành công.

shell> node_exporter --version
node_exporter, version 1.8.2 (branch: HEAD, revision: f1e0e8360aa60b6cb5e5cc1560bed348fc2c1895)
  build user:       root@03d440803209
  build date:       20240714-11:53:45
  go version:       go1.22.5
  platform:         linux/amd64
  tags:             unknown

Tạo file service cho systemd:

• File /etc/systemd/system/node_exporter.service được tạo để quản lý Node Exporter như một service.
• Cấu hình service bao gồm:
  • User: Chạy Node Exporter dưới quyền root.
  • ExecStart: Chạy Node Exporter từ /usr/local/bin/node_exporter.

shell> tee /etc/systemd/system/node_exporter.service <<EOF
[Unit]
Description=Node Exporter
Wants=network-online.target
After=network-online.target

[Service]
User=root
ExecStart=/usr/local/bin/node_exporter

[Install]
WantedBy=default.target
EOF

Khởi động và kích hoạt Node Exporter:

• Reload lại daemon của systemd: systemctl daemon-reload.
• Khởi động Node Exporter: systemctl start node_exporter.
• Kích hoạt Node Exporter để tự động chạy khi khởi động hệ thống: systemctl enable node_exporter.

Kiểm tra Node Exporter:

Sử dụng netstat -tlnp | grep 9100 để kiểm tra xem Node Exporter có đang lắng nghe trên cổng 9100 hay không.

shell> netstat -tlnp | grep 9100
tcp6       0      0 :::9100                 :::*                    LISTEN      1064193/node_export

5. Kích hoạt Textfile Collector

Sau khi cài đặt xong Node Exporter bạn cần thực hiện thêm một số bước để kích hoạt Textfile Collector:

Tạo thư mục Textfile Collector

Thư mục mặc định của Textfile Collector không được tạo tự động. Bạn cần tạo thư mục này:

mkdir -p /var/lib/node_exporter/textfile_collector
chown root:root /var/lib/node_exporter/textfile_collector

Chỉnh sửa file service của Node Exporter

Bạn cần thêm cờ --collector.textfile.directory vào file /etc/systemd/system/node_exporter.service để chỉ định thư mục Textfile Collector. Mở file và chỉnh sửa như sau:

nano /etc/systemd/system/node_exporter.service

Thay đổi phần ExecStart thành:

ExecStart=/usr/local/bin/node_exporter --collector.textfile.directory=/var/lib/node_exporter/textfile_collector

Reload và khởi động lại Node Exporter

Sau khi chỉnh sửa, reload lại daemon và khởi động lại Node Exporter:

sudo systemctl daemon-reload
sudo systemctl restart node_exporter

6. Tạo file custom metrics

Bây giờ bạn có thể thêm custom metrics vào thư mục /var/lib/node_exporter/textfile_collector. Ví dụ:

cat > /var/lib/node_exporter/textfile_collector/custom_metrics.prom << 'OEF'
# HELP custom_metric_total A custom counter metric
# TYPE custom_metric_total counter
custom_metric_total 42

# HELP custom_metric_latency_seconds A custom gauge metric
# TYPE custom_metric_latency_seconds gauge
custom_metric_latency_seconds 0.123
OEF

7. Kiểm tra custom metrics

Truy cập endpoint /metrics của Node Exporter để kiểm tra xem các custom metrics đã được expose hay chưa:

shell> curl http://localhost:9100/metrics | grep custom_metric
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0# HELP custom_metric_latency_seconds A custom gauge metric
# TYPE custom_metric_latency_seconds gauge
custom_metric_latency_seconds 0.123
# HELP custom_metric_total A custom counter metric
# TYPE custom_metric_total counter
custom_metric_total 42
node_textfile_mtime_seconds{file="/var/lib/node_exporter/textfile_collector/custom_metrics.prom"} 1.743874764e+09
100  155k    0  155k    0     0  4276k      0 --:--:-- --:--:-- --:--:-- 4326k

Bạn sẽ thấy kết quả như sau nếu mọi thứ hoạt động đúng:

# HELP custom_metric_total A custom counter metric
# TYPE custom_metric_total counter
custom_metric_total 42

# HELP custom_metric_latency_seconds A custom gauge metric
# TYPE custom_metric_latency_seconds gauge
custom_metric_latency_seconds 0.123

8. Tự động cập nhật Custom Metrics

Bạn có thể sử dụng một script để tự động cập nhật các custom metrics. Ví dụ, sử dụng Python để ghi giá trị mới vào file .prom:

def write_metrics_to_file():
    metrics = """
# HELP custom_metric_total A custom counter metric
# TYPE custom_metric_total counter
custom_metric_total 100

# HELP custom_metric_latency_seconds A custom gauge metric
# TYPE custom_metric_latency_seconds gauge
custom_metric_latency_seconds 0.456
"""
    with open('/var/lib/node_exporter/textfile_collector/custom_metrics.prom', 'w') as f:
        f.write(metrics)

if __name__ == "__main__":
    write_metrics_to_file()

Chạy script này định kỳ bằng cron để cập nhật giá trị custom metrics:

crontab -e

Thêm dòng sau để chạy script mỗi phút:

* * * * * /usr/bin/python3 /usr/local/bin/update_metrics.py

8. Tích hợp với Prometheus

Đảm bảo rằng Prometheus đang scrape Node Exporter. Trong file config prometheus.yml, thêm cấu hình sau:

scrape_configs:
  - job_name: 'node_exporter'
    static_configs:
      - targets: ['localhost:9100']

Khởi động lại Prometheus để áp dụng cấu hình:

sudo systemctl restart prometheus

8. Hiển thị Custom Metrics trên Grafana

Sau khi Prometheus thu thập được các custom metrics, bạn có thể sử dụng Grafana để hiển thị chúng. Thực hiện các bước sau:

• Truy cập Grafana và thêm Prometheus làm Data Source.
• Tạo một dashboard mới.
• Thêm một panel và sử dụng truy vấn PromQL để hiển thị custom metrics. Ví dụ:

custom_metric_total

Lưu dashboard và theo dõi các số liệu tùy chỉnh.

9. Tóm tắt lại quy trình

• Sau khi cài đặt Node Exporter thành công.
• Để kích hoạt Textfile Collector, bạn cần tạo thư mục /var/lib/node_exporter/textfile_collector, chỉnh sửa file service để thêm cờ --collector.textfile.directory và khởi động lại Node Exporter.
• Sau đó, bạn có thể thêm custom metrics vào thư mục này và kiểm tra chúng qua endpoint /metrics.

10. Kết luận.

Với Textfile Collector, Node Exporter không chỉ giới hạn ở việc thu thập các số liệu hệ thống mặc định mà còn có thể được mở rộng để giám sát các số liệu tùy chỉnh. Điều này giúp bạn linh hoạt hơn trong việc giám sát các thông số quan trọng đối với hệ thống và ứng dụng của mình.

Nếu bạn đang tìm kiếm một giải pháp giám sát mạnh mẽ và dễ dàng mở rộng, Node Exporter kết hợp với Prometheus và Grafana là một lựa chọn tuyệt vời. Hãy thử áp dụng ngay hôm nay và chia sẻ trải nghiệm của bạn!