Giới thiệu

Trong thế giới phát triển phần mềm ngày nay, việc theo dõi và thu thập dữ liệu là rất quan trọng. OpenTelemetry nổi lên như một tiêu chuẩn mở cho việc thu thập và truyền thông tin từ các ứng dụng. Trong bài viết này, chúng ta sẽ tìm hiểu cách xây dựng và quản lý bộ thu OpenTelemetry tùy chỉnh một cách hiệu quả.

Tại sao nên xây dựng bộ thu OpenTelemetry tùy chỉnh?

Khi triển khai các ứng dụng trong môi trường phức tạp như Kubernetes, việc sử dụng bộ thu OpenTelemetry tùy chỉnh trở nên cần thiết. Điều này giúp giảm kích thước của tệp nhị phân và tăng cường bảo mật. Một bộ thu tùy chỉnh cho phép bạn:

• Chỉ bao gồm các thành phần cần thiết như receivers, processors, exporters.
• Giảm thiểu phụ thuộc không cần thiết.
• Tăng cường hiệu suất và khả năng bảo trì.

Giới thiệu về OpenTelemetry Distribution Builder (ODB)

OpenTelemetry Distribution Builder (ODB) là công cụ mã nguồn mở từ Bindplane giúp bạn tạo ra các bộ thu tùy chỉnh. Bạn chỉ cần cung cấp một tệp manifest.yaml, và ODB sẽ tạo ra các gói nhị phân cho các nền tảng khác nhau như Linux, Windows, và macOS.

Các tính năng nổi bật của ODB

• Hỗ trợ đa nền tảng: Tạo ra các gói cho Linux, Windows, macOS với định dạng như .tar.gz, .zip, .deb, .rpm.
• Không cần lập trình Go: Giúp bạn dễ dàng tạo ra bộ thu mà không cần có kiến thức sâu về lập trình Go.
• Hỗ trợ OpAMP: Tích hợp sẵn hỗ trợ OpAMP để quản lý từ xa.

Các bước xây dựng bộ thu OpenTelemetry tùy chỉnh

Bước 1: Tạo kho lưu trữ trên GitHub

Bắt đầu bằng cách tạo một kho lưu trữ trên GitHub để lưu trữ tệp manifest.yaml và chạy các workflow của GitHub Actions. Sử dụng các lệnh sau để khởi tạo kho lưu trữ:

echo "# otel-distro-builder-github-action" >> README.md
git init
git add README.md
git commit -m "first commit"
git branch -M main
git remote add origin git@github.com:<TÊN_TÀI_KHOẢN_CỦA_BẠN>/otel-distro-builder-github-action.git
git push -u origin main

Bước 2: Viết tệp manifest.yaml

Tệp manifest.yaml là nơi bạn xác định các thành phần cần thiết cho bộ thu của mình. Dưới đây là một ví dụ:

dist:
  module: github.com/<TÊN_TÀI_KHOẢN_CỦA_BẠN>/my-custom-opentelemetry-distro
  name: my-custom-opentelemetry-distro
  description: Bộ thu OpenTelemetry tùy chỉnh.
  output_path: ./_build
  version: v0.0.1
conf_resolver:
  default_uri_scheme: "env"
receivers:
  - gomod: go.opentelemetry.io/collector/receiver/nopreceiver v0.128.0
  - gomod: go.opentelemetry.io/collector/receiver/otlpreceiver v0.128.0
exporters:
  - gomod: go.opentelemetry.io/collector/exporter/debugexporter v0.128.0
  - gomod: go.opentelemetry.io/collector/exporter/otlpexporter v0.128.0
extensions:
  - gomod: go.opentelemetry.io/collector/extension/zpagesextension v0.128.0
processors:
  - gomod: go.opentelemetry.io/collector/processor/batchprocessor v0.128.0

Bước 3: Tự động hóa quá trình xây dựng với GitHub Actions

Sử dụng GitHub Actions để tự động hóa quá trình xây dựng bộ thu. Thêm tệp .github/workflows/multi.yaml vào kho lưu trữ của bạn:

name: Matrixed OpenTelemetry Distribution Build

on:
  push:
    tags:
      - "v*"
  workflow_dispatch:

jobs:
  build:
    strategy:
      matrix:
        platform: [linux/amd64, windows/amd64]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Build and Package
        uses: observiq/otel-distro-builder@main
        with:
          os: ${{ matrix.os }}
          arch: ${{ matrix.arch }}
      - name: Upload Artifacts
        uses: actions/upload-artifact@v4
        with:
          name: distribution-artifacts-${{ matrix.artifact_name }}
          path: .

Bước 4: Tải xuống và chạy bộ thu của bạn

Sau khi bộ thu được xây dựng, bạn có thể tải xuống và chạy nó trong môi trường Linux. Sử dụng các lệnh sau:

wget https://github.com/adnanrahic/otel-distro-builder-github-action/releases/download/v0.0.1/my-custom-opentelemetry-distro_otelcol_v0.0.1_linux_amd64.tar.gz
tar -xvzf my-custom-opentelemetry-distro_otelcol_v0.0.1_linux_amd64.tar.gz
./my-custom-opentelemetry-distro --config collector_config.yaml

Bước 5: Quản lý bộ thu từ xa với OpAMP

Để quản lý bộ thu từ xa, bạn cần thêm bộ thu tùy chỉnh như một loại Agent trong Bindplane. Tạo tệp cấu hình cho Agent Type:

apiVersion: bindplane.observiq.com/v1
kind: AgentType
metadata:
  name: my-custom-opentelemetry-distro
  displayName: My Custom OpenTelemetry Distro
spec:
  repositoryLink: https://github.com/<TÊN_TÀI_KHOẢN_CỦA_BẠN>/otel-distro-builder-github-action

Sau đó, sử dụng lệnh để áp dụng và đồng bộ hóa Agent Type trong Bindplane:

bindplane apply -f /path/to/agent/type/file.yaml
bindplane sync agent-versions --agent-type my-custom-opentelemetry-distro --version v0.0.1

Thực hành tốt nhất

• Luôn kiểm tra cấu hình: Trước khi chạy bộ thu, hãy chắc chắn rằng cấu hình của bạn đã được kiểm tra và đúng.
• Giảm thiểu kích thước nhị phân: Chỉ bao gồm các thành phần cần thiết để giảm dung lượng bộ thu.
• Theo dõi hiệu suất: Sử dụng các công cụ giám sát để theo dõi hiệu suất của bộ thu.

Những cạm bẫy thường gặp

• Không xác định đúng các dependencies có thể dẫn đến lỗi trong quá trình xây dựng.
• Thiếu bước cấu hình OpAMP có thể làm mất đi khả năng quản lý từ xa.

Lời kết

Việc xây dựng và quản lý bộ thu OpenTelemetry tùy chỉnh không còn là điều khó khăn nữa. Với ODB và GitHub Actions, bạn có thể dễ dàng tạo ra bộ thu phù hợp với nhu cầu của mình. Bắt đầu ngay hôm nay để tối ưu hóa quy trình giám sát của bạn!

Câu hỏi thường gặp

1. Tôi có thể sử dụng bộ thu OpenTelemetry tùy chỉnh cho môi trường nào?
Có, bạn có thể sử dụng bộ thu OpenTelemetry tùy chỉnh cho nhiều môi trường khác nhau như Kubernetes, Docker, và máy chủ vật lý.

2. Làm thế nào để kiểm tra bộ thu của tôi có hoạt động không?
Bạn có thể kiểm tra logs từ bộ thu để xác định xem nó có hoạt động như mong đợi hay không.

3. Có cách nào để tự động hóa quá trình phát hành bộ thu không?
Có, bạn có thể sử dụng GitHub Actions để tự động hóa quá trình phát hành.

Liên kết hữu ích

• Tài liệu OpenTelemetry
• GitHub Actions

Với hướng dẫn này, bạn đã được trang bị đầy đủ kiến thức để xây dựng và quản lý bộ thu OpenTelemetry tùy chỉnh của riêng mình. Bắt tay vào thực hiện ngay hôm nay!