RBB Indicadores

As ferramentas presentes nesse repositório servem de apoio à equipe da Rede Blockchain Brasil (RBB) para acompanhamento da operação e níveis de serviço da rede e evolução de atividades dos projetos do ecossistema.

As ferramentas realizam consultas aos nós da RBB, para a coleta de índices de Produção de Blocos, e consultas à API do GitHub para acompanhamento de incidentes e progresso de atividades de projetos.

Requisitos

As ferramentas possuem os seguintes requisitos em comum:

• NodeJS na versão 22.11
• NPM na versão 10.9.0
• Arquivo config.json, que deve ser criado na pasta raiz deste projeto, com os seguintes parâmetros:
  • Não havendo proxy, pode-se criar o arquivo sem o parâmetro PROXY_URL

{   
    "GITHUB_RBB_TOKEN":"<github_api_token>",
    "PROXY_URL": "http://host:port",
    "ORG": "<organization_name>",
    "PROJECT_NUMBER": <project_number>
}

Ferramentas

• Blocks - Gera indicadores sobre a produção de blocos.
• Issues - Coleta dados sobre o tratamento de incidentes.
• Projects - Gera indicadores sobre o andamento das atividades do projeto de Maturação do Piloto.

Preparação do Ambiente

Para instalar as dependências desse projeto basta utilizar o seguinte comando na pasta raiz:

npm install

Execução das Ferramentas

Para facilitar a execução das ferramentas, você pode utilizar o script run.bat no Windows ou run.sh no Linux. Esses scripts fornecem um menu interativo para escolher e executar as diferentes ferramentas disponíveis.

Windows

Para executar o script no Windows, utilize o seguinte comando na pasta raiz do projeto:

run.bat

Linux

Para executar o script no Linux, utilize o seguinte comando na pasta raiz do projeto:

./run.sh

Menu de Ferramentas

O menu interativo permite escolher entre as seguintes opções:

1. Métricas de Produção de Blocos: Gera indicadores sobre a produção de blocos.
2. Acompanhamento das Iniciativas de Maturação do Piloto: Gera indicadores sobre o andamento das atividades do projeto de Maturação do Piloto.
3. Issues em Produção: Coleta dados sobre o tratamento de incidentes.
4. Sair: Encerra o script.

Siga as instruções no menu para fornecer os parâmetros necessários para cada ferramenta.