Chuyển tới nội dung chính
Trang được dịch

Trang này được dịch từ tiếng Anh với sự hỗ trợ của AI. Nếu hai bản có chỗ khác nhau, hãy lấy phiên bản tiếng Anh làm chuẩn.

Trình giám sát hoạt động dự án mã nguồn mở chạy bằng StackQL

Trong hướng dẫn này, chúng tôi sẽ minh họa cách tự lưu trữ một hệ thống giám sát và cảnh báo theo thời gian thực dành cho người bảo trì phần mềm mã nguồn mở trên GitHub.

stackql là một công cụ mã nguồn mở cho phép người dùng truy vấn và tương tác với tài nguyên đám mây và SaaS bằng ngôn ngữ SQL cùng các thư viện và công cụ trực quan hóa và phân tích dữ liệu. Hãy tặng chúng tôi một ⭐ nếu bạn thấy dự án này hữu ích!

Nhận cảnh báo như thế này trong Slack và Discord theo thời gian thực:

Trình giám sát OSS

Đã kiểm thử với backend SQL nhúng docker linux

Tổng quan​

Khi tìm công cụ để giám sát dự án mã nguồn mở của chúng tôi, tôi nhận thấy hầu hết chúng không hoạt động như được giới thiệu hoặc hoàn toàn không hoạt động (trong trường hợp các ứng dụng bên thứ ba trên GitHub), vì vậy tôi đã tự tạo công cụ của riêng chúng tôi mà bạn có thể khởi chạy và sử dụng cho dự án GitHub mã nguồn mở của mình...

Dự án oss-activity-monitor sử dụng stackql để giám sát hoạt động của dự án mã nguồn mở theo thời gian thực, bao gồm thông báo theo thời gian thực về:

  • ⭐ stargazer mới của kho lưu trữ GitHub
  • 👀 watcher mới của kho lưu trữ GitHub
  • 🍴 fork mới của kho lưu trữ GitHub
  • 📊 issue mới của kho lưu trữ GitHub
  • 🙋 follower mới của tổ chức GitHub
  • 📦 lượt tải xuống mới của asset trong bản phát hành GitHub
  • 🍺 lượt tải xuống mới trên homebrew

Cách hoạt động​

Dự án được triển khai trong một container (dùng docker hoặc nền tảng triển khai container khác), được viết bằng python và gói pystackql, sử dụng provider github và homebrew cho stackql. Dạng xem vật chất hóa và câu lệnh SELECT được dùng để ghi nhận và so sánh trạng thái giữa số liệu hiện tại và số liệu trước đó của các điểm cuối GitHub và Homebrew được giám sát, như mô tả trong sơ đồ dưới đây:

ví dụ, với dạng xem vật chất hóa sau được tạo và nạp dữ liệu bằng stackql:

CREATE OR REPLACE MATERIALIZED VIEW mvw_github_repo_stargazers AS
SELECT login FROM github.activity.repo_stargazers
WHERE owner = 'your-org' and repo = 'your-repo'

truy vấn stackql sau sẽ thăm dò GitHub để tìm stargazer mới...

SELECT c.login
FROM github.activity.repo_stargazers c
LEFT JOIN mvw_github_repo_stargazers mvw
ON c.login = mvw.login
WHERE mvw.login IS NULL
AND c.owner = 'your-org' AND c.repo = 'your-repo'

sau đó trạng thái được làm mới bằng...

REFRESH MATERIALIZED VIEW mvw_github_repo_stargazers

cách làm tương tự được lặp lại cho watcher của kho lưu trữ, issue, follower của tổ chức, lượt tải xuống asset trong bản phát hành và lượt tải xuống homebrew.

Chạy dự án​

Làm theo các bước dưới đây để chạy dự án trên máy cục bộ hoặc trên nền tảng đám mây bạn chọn.

1. Clone kho lưu trữ​

git clone https://github.com/stackql/oss-activity-monitor.git
# or
git clone git@github.com:stackql/oss-activity-monitor.git

2. Cấu hình biến môi trường​

Dự án cần các biến môi trường sau để cấu hình (được cung cấp bằng biến môi trường, trong ví dụ dưới đây là tệp .env):

BiếnMô tảGiá trị ví dụ
LOG_LEVELMức nhật ký (INFO cho nhật ký chung; DEBUG cho nhật ký chi tiết)INFO
SLEEP_INTERVALThời gian chờ tính bằng giây giữa các vòng lặp yêu cầu5
GITHUB_REPOTên kho lưu trữ GitHubstackql
GITHUB_REPO_OWNERTên tổ chức hoặc chủ sở hữu GitHubstackql
HOMEBREW_FORMULA_NAMETên formula Homebrew, nếu cóstackql
STACKQL_GITHUB_USERNAMETên người dùng GitHub của bạnjeffreyaven
STACKQL_GITHUB_PASSWORDToken truy cập cá nhân GitHub của bạnghp_yourpersonalaccesstoken
SLACK_WEBHOOK_URLURL webhook Slack để gửi thông báohttps://hooks.slack.com/services/...
DISCORD_WEBHOOK_URLURL webhook Discord để gửi thông báohttps://discord.com/api/webhooks/...

3. Dựng container​

docker build --no-cache -t oss-activity-monitor .

4. Chạy container​

docker run --env-file .env oss-activity-monitor

Vậy là xong! Giờ đây bạn sẽ nhận được cảnh báo theo thời gian thực khi có hoạt động trên dự án mã nguồn mở của mình. Để dừng container, hãy dùng:

docker stop $(docker ps -a -q --filter ancestor=oss-activity-monitor)

Hãy tặng chúng tôi một ⭐ trên GitHub