跳至主要內容
翻譯頁面

本頁面由英文在 AI 協助下翻譯而成。若兩者有出入,請以英文版本為準。

由 StackQL 驅動的開源專案活動監控器

在本指南中,我們將示範如何為 GitHub 開源軟體維護者自行託管即時監控與警示系統。

stackql 是一款開源工具,可讓使用者透過 SQL 語言以及資料視覺化與分析程式庫和工具,查詢雲端與 SaaS 資源並與之互動。如果您喜歡,請給我們一顆 ⭐!

在 Slack 與 Discord 中即時收到像這樣的警示:

OSS 監控器

測試環境:內嵌式 SQL 後端 docker linux

概觀​

當我在尋找監控我們開源專案的工具時,發現大多數工具不是無法如宣傳般運作,就是根本無法運作(GitHub 中的第三方應用程式就是如此),因此我自己打造了一套,您可以在自己的 GitHub 開源專案上啟動並使用。

oss-activity-monitor 專案使用 stackql 執行即時的開源專案活動監控,包括下列項目的即時通知:

  • ⭐ GitHub 存放庫的新 stargazer
  • 👀 GitHub 存放庫的新 watcher
  • 🍴 GitHub 存放庫的新 fork
  • 📊 GitHub 存放庫的新 issue
  • 🙋 GitHub 組織的新追蹤者
  • 📦 GitHub 發行版本資產的新下載
  • 🍺 homebrew 的新下載

運作方式​

此專案部署在容器中(使用 docker 或其他容器部署平台),以 python 和 pystackql 套件建置,並使用 stackql 的 github 與 homebrew Provider。具體化檢視與 SELECT 陳述式用於擷取並比較 GitHub 與 Homebrew 受監控端點目前與先前指標之間的狀態,如下圖所示:

例如,假設已使用 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'

下列 stackql 查詢會輪詢 GitHub 以取得新的 stargazer:

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'

接著使用下列陳述式重新整理狀態:

REFRESH MATERIALIZED VIEW mvw_github_repo_stargazers

存放庫 watcher、issue、組織追蹤者、發行版本資產下載與 homebrew 下載也重複採用類似的模式。

執行專案​

依照下列步驟,在本機或您偏好的雲端平台上啟動並執行此專案。

1. 複製存放庫​

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

2. 設定環境變數​

設定此專案需要下列環境變數(以環境變數提供,下方範例中使用 .env 檔案):

變數描述範例值
LOG_LEVEL記錄層級(INFO 用於一般記錄;DEBUG 用於詳細記錄)INFO
SLEEP_INTERVAL每次要求迴圈之間的延遲時間(秒)5
GITHUB_REPOGitHub 存放庫名稱stackql
GITHUB_REPO_OWNERGitHub 組織或擁有者名稱stackql
HOMEBREW_FORMULA_NAMEHomebrew formula 名稱(如果有的話)stackql
STACKQL_GITHUB_USERNAME您的 GitHub 使用者名稱jeffreyaven
STACKQL_GITHUB_PASSWORD您的 GitHub 個人存取權杖ghp_yourpersonalaccesstoken
SLACK_WEBHOOK_URL用於傳送通知的 Slack webhook URLhttps://hooks.slack.com/services/...
DISCORD_WEBHOOK_URL用於傳送通知的 Discord webhook URLhttps://discord.com/api/webhooks/...

3. 建置容器​

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

4. 執行容器​

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

就這樣!現在,當您的開源專案有任何活動時,您都會收到即時警示。若要停止容器,請使用:

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

在 GitHub 上給我們一顆 ⭐