Lewati ke konten utama
Halaman terjemahan

Halaman ini diterjemahkan dari bahasa Inggris dengan bantuan AI. Jika keduanya berbeda, versi bahasa Inggris menjadi acuannya.

Monitor aktivitas proyek sumber terbuka berbasis StackQL

Dalam panduan ini, kami akan menunjukkan cara meng-host sendiri sistem pemantauan dan peringatan waktu nyata untuk pengelola perangkat lunak sumber terbuka di GitHub.

stackql adalah alat sumber terbuka yang memungkinkan pengguna mengkueri dan berinteraksi dengan sumber daya cloud dan SaaS menggunakan bahasa SQL serta library dan alat visualisasi dan analisis data. Beri kami ⭐ jika Anda menyukai proyek ini!

Dapatkan peringatan seperti ini di Slack dan Discord dalam waktu nyata:

Monitor OSS

Diuji dengan backend SQL tersemat docker linux

Ringkasan​

Saat saya mencari alat untuk memantau proyek sumber terbuka kami, saya mendapati sebagian besar alat tersebut tidak berfungsi seperti yang dijanjikan atau tidak berfungsi sama sekali (dalam kasus aplikasi pihak ketiga di GitHub), jadi saya membuat alat kami sendiri yang dapat Anda jalankan dan gunakan di proyek GitHub sumber terbuka Anda...

Proyek oss-activity-monitor menggunakan stackql untuk melakukan pemantauan aktivitas proyek sumber terbuka dalam waktu nyata, termasuk notifikasi waktu nyata untuk:

  • ⭐ stargazer baru di repositori GitHub
  • 👀 watcher baru di repositori GitHub
  • 🍴 fork baru di repositori GitHub
  • 📊 issue baru di repositori GitHub
  • 🙋 pengikut baru organisasi GitHub
  • 📦 unduhan baru aset rilis GitHub
  • 🍺 unduhan baru homebrew

Cara kerja​

Proyek ini di-deploy dalam container (menggunakan docker atau platform deployment container lainnya), dibangun menggunakan python dan paket pystackql, dengan provider github dan homebrew untuk stackql. Tampilan terwujud dan pernyataan SELECT digunakan untuk menangkap dan membandingkan status antara metrik saat ini dan metrik sebelumnya untuk endpoint GitHub dan Homebrew yang dipantau, seperti yang dijelaskan dalam diagram berikut:

misalnya, dengan tampilan terwujud berikut yang dibuat dan diisi menggunakan 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'

kueri stackql berikut memeriksa GitHub secara berkala untuk mencari stargazer baru...

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'

kemudian status diperbarui menggunakan...

REFRESH MATERIALIZED VIEW mvw_github_repo_stargazers

pola serupa diulang untuk watcher repositori, issue, pengikut organisasi, unduhan aset rilis, dan unduhan homebrew.

Menjalankan proyek​

Ikuti langkah-langkah di bawah ini untuk menyiapkan dan menjalankan proyek secara lokal atau di platform cloud pilihan Anda.

1. Mengkloning repositori​

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

2. Mengonfigurasi variabel lingkungan​

Variabel lingkungan berikut diperlukan untuk mengonfigurasi proyek (diberikan melalui variabel lingkungan, yaitu file .env dalam contoh di bawah ini):

VariabelDeskripsiContoh nilai
LOG_LEVELTingkat log (INFO untuk log umum; DEBUG untuk log terperinci)INFO
SLEEP_INTERVALJeda waktu dalam detik di antara putaran permintaan5
GITHUB_REPONama repositori GitHubstackql
GITHUB_REPO_OWNERNama organisasi atau pemilik GitHubstackql
HOMEBREW_FORMULA_NAMENama formula Homebrew, jika tersediastackql
STACKQL_GITHUB_USERNAMENama pengguna GitHub Andajeffreyaven
STACKQL_GITHUB_PASSWORDToken akses pribadi GitHub Andaghp_yourpersonalaccesstoken
SLACK_WEBHOOK_URLURL webhook Slack untuk mengirim notifikasihttps://hooks.slack.com/services/...
DISCORD_WEBHOOK_URLURL webhook Discord untuk mengirim notifikasihttps://discord.com/api/webhooks/...

3. Membangun container​

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

4. Menjalankan container​

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

Selesai! Sekarang Anda akan menerima peringatan waktu nyata saat ada aktivitas di proyek sumber terbuka Anda. Untuk menghentikan container, gunakan:

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

Beri kami ⭐ di GitHub