Перейти до основного вмісту
Перекладена сторінка

Цю сторінку перекладено з англійської мови за допомогою ШІ. Якщо тексти відрізняються, еталоном є англійська версія.

Монітор активності проєкту з відкритим кодом на базі StackQL

У цьому посібнику ми покажемо, як самостійно розмістити систему моніторингу та оповіщень у реальному часі для супровідників програмного забезпечення з відкритим кодом на GitHub.

stackql - це інструмент із відкритим кодом, що дає змогу користувачам виконувати запити до хмарних ресурсів і ресурсів SaaS та взаємодіяти з ними за допомогою мови SQL, а також бібліотек та інструментів візуалізації й аналізу даних. Поставте нам ⭐, якщо вам це подобається!

Отримуйте такі оповіщення в Slack і Discord у реальному часі:

Монітор OSS

Перевірено з вбудований бекенд SQL docker linux

Огляд​

Коли я шукав інструменти для моніторингу нашого проєкту з відкритим кодом, то виявив, що більшість із них працює не так, як заявлено, або не працює взагалі (як у випадку зі сторонніми застосунками в GitHub), тож я створив власний, який ви можете запустити й використовувати для свого проєкту з відкритим кодом на GitHub...

Проєкт oss-activity-monitor використовує stackql для моніторингу активності проєкту з відкритим кодом у реальному часі, зокрема для сповіщень у реальному часі про:

  • ⭐ нових stargazers репозиторію GitHub
  • 👀 нових watchers репозиторію GitHub
  • 🍴 нові форки репозиторію GitHub
  • 📊 нові issues репозиторію GitHub
  • 🙋 нових підписників організації GitHub
  • 📦 нові завантаження файлів випусків GitHub
  • 🍺 нові завантаження з homebrew

Як це працює​

Проєкт розгортається в контейнері (за допомогою docker або іншої платформи розгортання контейнерів), його створено мовою python з використанням пакета pystackql і провайдерів github та homebrew для stackql. Матеріалізовані подання й інструкції 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 щодо нових stargazers...

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

аналогічні схеми застосовано для watchers репозиторію, issues, підписників організації, завантажень файлів випусків і завантажень з 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_REPOНазва репозиторію GitHubstackql
GITHUB_REPO_OWNERНазва організації або ім'я власника в GitHubstackql
HOMEBREW_FORMULA_NAMEНазва формули Homebrew, якщо єstackql
STACKQL_GITHUB_USERNAMEВаше ім'я користувача GitHubjeffreyaven
STACKQL_GITHUB_PASSWORDВаш персональний токен доступу GitHubghp_yourpersonalaccesstoken
SLACK_WEBHOOK_URLURL вебхука Slack для надсилання сповіщеньhttps://hooks.slack.com/services/...
DISCORD_WEBHOOK_URLURL вебхука Discord для надсилання сповіщеньhttps://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