CscTrackerPyCore
CscTrackerPyCore é uma biblioteca Python base desenvolvida para padronizar e acelerar o desenvolvimento de microserviços. Ela oferece integração nativa com Flask, fornecendo recursos essenciais como logging estruturado em JSON, telemetria com Prometheus, documentação automática via Swagger e gerenciamento de tarefas agendadas.
Principais Funcionalidades
- Starter Facilitado: Inicialização rápida de aplicações Flask com suporte a CORS e tratamento de variáveis de ambiente.
- Logging Estruturado: Formatação automática de logs em JSON com inclusão de
requestId,appNameeappVersionpara melhor rastreabilidade. - Observabilidade:
- Integração nativa com Prometheus para coleta de métricas de endpoints.
- Interceptor de Requisições: Registro detalhado de chamadas HTTP (método, path, status, duração) com opção de persistência remota para auditoria.
- Documentação Automática: Geração de especificação Swagger (OpenAPI) simplificada.
- Processamento em Background: Integração com
csctracker-queue-schedulerpara execução de tarefas assíncronas e agendadas. - Repositórios Remotos: Abstração para comunicação entre serviços via HTTP com tratamento de headers e correlação.
Requisitos
- Python 3.9+
- Flask
- Flask-CORS
- Prometheus Flask Exporter
- Flask Swagger Generator
- Python JSON Logger
- Python Dotenv
Instalação
As dependências podem ser instaladas via pip:
pip install csctracker-py-core
Ou via requirements.txt:
pip install -r requirements.txt
Configuração
A biblioteca é configurada principalmente via variáveis de ambiente, suportando arquivos .env localizados na pasta config/ (ex: config/dev.env).
Variáveis de Ambiente Suportadas
| Variável | Descrição | Exemplo |
|---|---|---|
PROFILE |
Perfil de configuração (define o arquivo .env) | dev |
PORT |
Porta de execução do servidor Flask | 5000 |
LOG_LEVEL |
Nível de detalhamento do log | INFO, DEBUG |
LOG_REQUEST_BODY |
Se True, inclui o corpo da requisição nos logs |
True |
LOG_RESPONSE_BODY |
Se True, inclui o corpo da resposta nos logs |
False |
URL_BFF |
URL base para persistência de logs de requisição | http://api-gateway/ |
API_TOKEN |
Token de autorização para chamadas externas | seu_token_aqui |
DEBUG |
Ativa o modo debug do Flask se definido como 1 |
0 |
Uso Didático
1. Inicialização do Starter
A classe Starter centraliza a configuração do Flask.
from csctracker_py_core.starter import Starter
# Inicializa o starter (static_folder define a pasta de arquivos estáticos)
# save_request=True ativa a persistência remota de logs de requisição
starter = Starter(save_request=False)
# Obtém a instância do Flask configurada
app = starter.get_app()
@app.route('/')
def hello():
return {"message": "CscTrackerPyCore is running!"}
if __name__ == '__main__':
starter.start()
2. Logging e Interceptação
Uma vez iniciado o Starter, todos os logs do sistema usarão o formato JSON e as requisições serão interceptadas automaticamente para gerar telemetria.
3. Acesso aos Repositórios
# Acesso ao repositório HTTP para chamadas externas padronizadas
http_repo = starter.get_http_repository()
Estrutura do Projeto
Starter: Orquestrador principal que configura Flask, CORS, Métricas e Swagger.Configs: Gerencia o carregamento de variáveis de ambiente e a configuração do logger JSON.Interceptor: Middleware Flask que captura dados de performance e logs de entrada/saída.HttpRepository: Facilita requisições HTTP externas com injeção de headers de segurança e rastreio.RequestInfo: Utilitário para gerenciar IDs de correlação (Correlation IDs) entre threads.
Licença
Este projeto está sob a licença MIT. Consulte o arquivo LICENSE para mais detalhes.
1 maintainer
Metadata
1 maintainer
Release files for csctracker-py-core 26.36.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| csctracker_py_core-26.36.1.tar.gz | 14.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| csctracker_py_core-26.36.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 29.8 kB
Release files / csctracker_py_core-26.36.1.tar.gz
| Download URL | csctracker_py_core-26.36.1.tar.gz |
|---|---|
| Size | 14.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3fdefc56f08a45bfd00f739769851683a0ee8a65494b960ed1d0a3adba7bcbc3
|
|
BLAKE2b-256 checksum How to use checksums |
23d89cd91e17d1b278d994f4e68f8eb98be32a179d12c5cd180484f89e3c7b8c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / csctracker_py_core-26.36.1-py3-none-any.whl
| Download URL | csctracker_py_core-26.36.1-py3-none-any.whl |
|---|---|
| Size | 15.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
90681a082830b29af0900f476c331a3af885b2149d33e14eed2d1cf92dafffcf
|
|
BLAKE2b-256 checksum How to use checksums |
ccf785f9f03d8803d6e82028f1fea7efffd06318051376ff514d4d5148452af2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
