django-celery-task-monitor

Monitoramento de tarefas Celery no Django Admin, com polling via REST.

Sumário de Conteúdos:

• Instalação
  • Requisitos
  • Instalando o pacote
  • Registrando as apps
  • Rodando as migrações
  • Próximo passo
• Configuração
  • CELERY_TASK_MONITOR_POLL_INTERVAL
  • CELERY_TASK_MONITOR_TRACE_PERMISSION
  • CELERY_TASK_MONITOR_FRIENDLY_ERROR_MESSAGE
  • CELERY_TASK_MONITOR_LIST_PER_PAGE
  • Configuração do Celery no projeto host
• Uso Básico
  • Exemplo mínimo
  • O que acontece automaticamente
  • Adicionando o botão de disparo no formulário
  • Mostrando o status ao vivo no change form
  • Consultando todas as tarefas
• Uso Avançado
  • Disparando tarefas em outros lugares (actions, etc.)
  • Intervalo de polling por ModelAdmin
  • Nome customizado da coluna
  • Customizando o template do badge
  • Customizando o painel de status do change form
  • Endpoint REST fora do admin
  • Usando o badge fora do admin
  • Progresso percentual
  • Mensagens customizadas (“Tarefa enfileirada.”, etc.)
• Referência da API
  • django_celery_task_monitor.models
  • django_celery_task_monitor.admin
  • django_celery_task_monitor.views
  • django_celery_task_monitor.permissions
  • django_celery_task_monitor.settings
  • Template tags ({% load task_monitor_tags %})
  • Templates
• JavaScript
  • Auto-inicialização
  • Badge vs. painel
  • API pública (window.TaskPoll)
  • Prevenção de duplicação e memory leaks
  • Formato do payload JSON
• Permissões
  • Como funciona view_task_trace
  • Onde isso é aplicado
  • Concedendo a permissão
• Projeto de Exemplo
  • Estrutura
  • Rodando localmente
  • Por que CELERY_TASK_ALWAYS_EAGER?
• FAQ
  • Como mostrar uma barra de progresso, em vez de só um badge de status?
  • Como integrar com Django-RQ (ou outra fila) em vez de Celery?
  • Como reprocessar uma tarefa que falhou?
  • Os badges antigos continuam fazendo polling para sempre?
  • Por que object_id é CharField em vez de IntegerField?
  • Preciso de um worker Celery rodando para ver o plugin funcionando?
  • Cliquei em disparar a tarefa e só aparece uma mensagem fixa que nunca muda
• Desenvolvimento
  • Configurando o ambiente
  • Rodando os testes
  • Qualidade de código
  • pre-commit
  • Traduções
  • Construindo esta documentação
• Release
  • Versionamento
  • Checklist de release
  • Compatibilidade

Funcionalidades

• Modelo TaskLog, vinculado a qualquer modelo do projeto host via GenericForeignKey

• Mixin CeleryTaskMonitorMixin para qualquer ModelAdmin, com coluna de status e polling automático

• Endpoint REST de polling registrado por ModelAdmin (get_urls()), sem código extra

• JavaScript modular e auto-contido (task-poll.js), sem dependências externas

• Controle de permissão granular (view_task_trace) para exibir ou ocultar stacktraces completos

• Internacionalizado (pt-BR/en)

Links Rápidos

• Instalação

• Configuração

• Uso Básico

• Uso Avançado

• Referência da API

• JavaScript

• Permissões

• Projeto de Exemplo

• FAQ

• Desenvolvimento

• Processo de Release