Pular para o conteúdo

Soluções · Integrações, sistemas e qualidade de dados

Integração sem documentação: como medir o que ficou

A integração foi construída sem documentação. Como sei se ela está funcionando bem?

Resposta direta

Mede-se pelo comportamento observável, não pelo desenho. Três frentes bastam para começar: contagens de registros que entram e saem em cada ponta, horários em que cada troca acontece e registros de erro que o processo deixa. Onde houver divergência entre pontas, há trabalho a fazer. A ausência de documentação não impede medir; impede prever. Por isso, a medição começa pelo que a integração faz hoje e vira registro do que se sabe, para que a próxima pessoa não recomece do zero.

Objetivo
Explicar medição
Formato indicado
Projeto de implementação
Atualizado em

O que esta página acrescenta: Trata a medição como reconstrução de evidência a partir do que a integração já registra, sem depender de documentação prévia.

Rastros que a integração já produz

Mesmo sem documentação, quase toda integração deixa rastros: contagens, horários de execução, mensagens de erro e registros gravados nas duas pontas. Reunir esses rastros é o ponto de partida, porque eles descrevem o que a integração faz hoje, e não o que se supõe que ela faça.

Vale separar sinal de ruído. Mensagem de erro genérica diz pouco; contagem por período e por ponta diz muito. O critério é simples: um rastro serve se permitir comparar dois momentos ou duas pontas sem depender da memória de quem construiu.

Comparação entre origem e destino

A medição mais direta compara o que entrou com o que saiu, em um intervalo fechado: conta-se os registros na origem e no destino e observa-se a diferença. Diferença estável e conhecida é aceitável. Diferença que muda a cada execução indica falha de regra, de filtro ou de horário.

Quando não há campo que ligue os dois lados, o identificador do próprio registro costuma servir de chave de conferência. Sem essa ligação, a comparação vira estimativa e precisa ser tratada como tal.

O que a medição não resolve

Medir não reconstrói a intenção de quem construiu a integração. Regras de negócio, exceções e acordos verbais não aparecem nos rastros. A medição mostra o comportamento atual; não diz se ele está correto.

Também não substitui documentação nem define responsabilidade por si. Em integrações antigas, o resultado da medição costuma ser um conjunto de hipóteses que precisam de confirmação de quem opera o processo. Sem essa confirmação, o número observado pode estar certo e a conclusão, errada.

Recurso prático

Sinais que a integração deixa e o que cada um permite medir

Sinal observávelO que ele permite medir
Contagem de registros que entram e saem em cada pontaDivergência entre origem e destino no mesmo período
Horário de início e de fim de cada execuçãoAtrasos, execuções sobrepostas e intervalos em que nada rodou
Registros de erro e mensagens de rejeiçãoO que falha, com que frequência e se alguém foi avisado
Campo que liga o mesmo registro nas duas pontasSe o item chegou inteiro do outro lado ou se perdeu no caminho
Quem alterou a integração por últimoOnde procurar explicação quando não existe documentação

O erro mais comum é medir apenas o sucesso da execução e não o conteúdo: uma rotina pode terminar sem erro e ainda assim gravar menos registros do que recebeu.

Sobre o que está escrito aqui

Conceitos relacionados: contagem de registros por ponta · janela de execução · registro de erro · chave de correlação · responsável pela integração. Exemplos são ilustrativos. Não há cliente, resultado, preço, prazo ou certificação nesta página. Quando o formato indicado é Projeto de implementação, ele descreve uma possibilidade de trabalho — a conversa inicial avalia contexto e aderência.

Para continuar

Páginas relacionadas

O mesmo problema em outro objetivo

Outras leituras em Integrações, sistemas e qualidade de dados

Quer avaliar isso no seu contexto?

Esta página trata de integração construída sem documentação. Diagnóstico de integração é a frente que investiga o mecanismo por trás desse tipo de problema. O formato mais associado é Projeto de implementação.