Padrões de Desenvolvimento
Escrito por Hitfy
Geral
- Manter a língua Portuguesa como padrão, salvo exceções;
- Utilizar macros e publicá-las, a fim de permitir customizações via Portal.
Templates
- Nomenclatura:
- Manter a nomenclatura "Templates_{TECNOLOGIA}_Padrao";
- Caso seja necessário criar uma template para uma tecnologia que já exista, adicionar a versão na nomenclatura.
- Descrição:
- Tecnologia, versão, forma de monitoramento (Agente, SNMP, Script, etc).
- Agrupamento:
- Manter o grupo "Templates DevHIT" no processo de desenvolvimento;
- "Templates" e "Templates Padrao" quando finalizar o desenvolvimento.
Macros
- Nomenclatura:
- TG - Trigger;
- IT - Item;
- DIS - Descoberta;
- DIT - Protótipo de Item;
- DTG - Protótipo de Tirgger.
- Adicionar descrição;
- Em Português;
- Separar por underline (_).
Ex: {$TG_ESPACO_DISCO_X_ALTO}
Itens
- Sempre colocar uma descrição;
- Chave:
Utilizar ponto (.) para espaçar as palavras no key name.
Ex: disco.espaco.total["C:"].
- Intervalo mínimo de 1 minuto, mas pode ocorrer exceções (validar com time todo);
- Sempre utilizar a unidade correta;
- Utilizar macros sempre que possível (chave, parâmetros, etc);
- Banco de Dados/APIs/Afins: Sempre que possível criar um item mestre e itens dependentes;
- Sempre que possível, utilizar Value Mapping;
- History: normais e dependentes 30d e item master 1d;
- Trends default por 365d;
- Sempre colocar aplicações e tags de acordo com o tipo e em português.
Triggers
- Sempre criar triggers de nodata ou que acuse caso o monitoramento em geral esteja com falha;
- Nomenclatura:
- Apresentar Host, IP, Mensagem e Dados do problema.
- Exemplo: {HOST.HOST}/{HOST.IP}: <mensagem> ({ITEM.LASTVALUE1})
- Sempre colocar uma descrição do problema;
- Expressão
- Sempre que possível, utilizar macros
Ex: {$TG_MACRO} * 1.15
- ·Adicionar Flapping (recovery expression) sempre que possível;
- ·Adicionar tags conforme tipo de item/trigger: Capacidade, Configuração, Desempenho, Disponibilidade;
- Sempre colocar dependência para tipos de triggers com várias severidades;
Ex: Alertas de espaço em disco com várias severidades
- Habilitar fechamento manual para triggers que não se resolvem automaticamente
Ex: Eventlog
- URLs: Sempre que possuir uma documentação, referenciar no campo
Atualização Automática de Scripts
- Caso o monitoramento seja feito utilizando scripts, é possível criar uma automação que detecta a versão do script no proxy do cliente e comparar com a versão atual do repositório.
Para isso, basta:
Vincular a template "Template_Monitoramento_Checa_Versao_Padrao" na template da tecnologia
Configurar as macros na template da tecnologia:
Ativar a trigger da template da tecnologia:
Documentação
- Criar documentação de implantação no HCA (será transferido para HIT Doc);
Este documento deve conter:
- Resumo geral sobre a template desenvolvida
- Como implantar o monitoramento
- Macros e informações que devem ser configuradas na implantação
- Toda e qualquer tipo de informação relevante para a implantação e para o monitoramento
- Colocar link da página criada no F:/