Pular para o conteúdo principal
Página traduzida

Esta página foi traduzida do inglês com assistência de IA. Se houver diferenças entre as duas, a versão em inglês é a referência.

Monitor de atividade de projetos de código aberto baseado no StackQL

Neste guia, mostramos como hospedar por conta própria um sistema de monitoramento e alertas em tempo real para mantenedores de software de código aberto no GitHub.

stackql é uma ferramenta de código aberto que permite aos usuários consultar e interagir com recursos na nuvem e de SaaS usando a linguagem SQL e bibliotecas e ferramentas de visualização e análise de dados. Dê uma ⭐ para nós se você gostou!

Receba alertas como este no Slack e no Discord em tempo real:

Monitor de OSS

Testado com backend SQL incorporado docker linux

Visão geral​

Quando procurei ferramentas para monitorar o nosso projeto de código aberto, descobri que a maioria não funcionava como anunciado ou simplesmente não funcionava (no caso de aplicativos de terceiros no GitHub), então criei a nossa própria ferramenta, que você pode iniciar e usar no seu projeto de código aberto do GitHub...

O projeto oss-activity-monitor usa o stackql para monitorar em tempo real a atividade de projetos de código aberto, o que inclui notificações em tempo real de:

  • ⭐ novos stargazers de repositórios do GitHub
  • 👀 novos watchers de repositórios do GitHub
  • 🍴 novos forks de repositórios do GitHub
  • 📊 novas issues de repositórios do GitHub
  • 🙋 novos seguidores de organizações do GitHub
  • 📦 novos downloads de arquivos de versões do GitHub
  • 🍺 novos downloads do homebrew

Como funciona​

O projeto é implantado em um contêiner (com docker ou outra plataforma de implantação de contêineres) e é desenvolvido em python com o pacote pystackql, usando os providers github e homebrew do stackql. O projeto usa views materializadas e instruções SELECT para capturar e comparar o estado entre as métricas atuais e anteriores dos endpoints monitorados do GitHub e do Homebrew, como descreve o diagrama a seguir:

por exemplo, dada esta view materializada, criada e preenchida com o 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'

a consulta do stackql a seguir verifica periodicamente o GitHub em busca de novos 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'

em seguida, o estado é atualizado com...

REFRESH MATERIALIZED VIEW mvw_github_repo_stargazers

padrões semelhantes se repetem para watchers de repositórios, issues, seguidores de organizações, downloads de arquivos de versões e downloads do homebrew.

Executar o projeto​

Siga as etapas abaixo para colocar o projeto em execução localmente ou na sua plataforma de nuvem preferida.

1. Clonar o repositório​

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

2. Configurar as variáveis de ambiente​

As seguintes variáveis de ambiente são necessárias para configurar o projeto (fornecidas como variáveis de ambiente; no exemplo abaixo, em um arquivo .env):

VariávelDescriçãoValor de exemplo
LOG_LEVELNível de log (INFO para logs gerais; DEBUG para logs detalhados)INFO
SLEEP_INTERVALIntervalo em segundos entre os ciclos de solicitações5
GITHUB_REPONome do repositório do GitHubstackql
GITHUB_REPO_OWNERNome da organização ou do proprietário no GitHubstackql
HOMEBREW_FORMULA_NAMENome da fórmula do Homebrew, se houverstackql
STACKQL_GITHUB_USERNAMESeu nome de usuário do GitHubjeffreyaven
STACKQL_GITHUB_PASSWORDSeu token de acesso pessoal do GitHubghp_yourpersonalaccesstoken
SLACK_WEBHOOK_URLURL do webhook do Slack para enviar notificaçõeshttps://hooks.slack.com/services/...
DISCORD_WEBHOOK_URLURL do webhook do Discord para enviar notificaçõeshttps://discord.com/api/webhooks/...

3. Criar o contêiner​

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

4. Executar o contêiner​

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

Pronto! Agora você vai receber alertas em tempo real quando houver atividade no seu projeto de código aberto. Para parar o contêiner, use:

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

Dê uma ⭐ para nós no GitHub