Cadastro de plugins personalizados

Este é segundo post da série de tutoriais sobre plugins personalizados. Caso você não tenha criado o seu primeiro plugin ainda, recomendamos a leitura do post anterior.

Como carregar meu plugin na ferramenta?

Neste post continuaremos a usar o plugin criado como exemplo no post anterior e detalharemos os passos necessários para carregá-lo na Unit Platform.

Após acessar o produto Multisite Monitoring, clicar em Plugins > Plugins Personalizados > Adicionar Plugin:

Etapa 1: Informações gerais do plugin

O cadastro do plugin é divido em três etapas. Na primeira, são requisitadas as informações gerais do plugin:

Onde:

1. Empresa: Nome da empresa que utilizará o plugin. Por questões de segurança e privacidade, os plugins personalizados são vinculados a apenas uma empresa, ou seja, outras empresas não verão esse plugin, nem poderão utilizá-lo.
2. Nome do plugin: Nome que será exibido no monitoramento.
3. Tipo da credencial: Não selecionar nada.
4. Adicionar parâmetro: Clique em adicionar parâmetros, pois esse plugin necessita de uma entrada (código da cidade).
   1. Parâmetro 1: Preencha com o nome do argumento, neste caso, colocamos “City”.
5. Opções extras: Serão exibidos mais alguns campos. Preencha conforme a imagem.
6. Enviar script: Clique em “Selecionar” e faça upload do arquivo “my_first_plugin.php”.
7. Argumentos da linha de comando: Cada um dos parâmetros adicionados no passo 4 são identificados na linha de comando por índices. Como temos apenas um argumento, neste campo adicione apenas “$arg1$”. Caso o plugin possuísse mais argumentos, cada um deles precisaria ser adicionado na linha de comando devidamente indexado, por exemplo: $arg2$, $arg3$, e assim por diante.
8. Testar plugin: clique para verificar se está tudo correto.

Selecione um dispositivo e execute o teste. A seleção de um dispositivo é necessária porque todos os serviços cadastrados para o monitoramento devem estar vinculados a um dispositivo. Ao clicar em “Executar teste”, deverá ser exibida uma mensagem de sucesso da execução e o sistema avançará para a próxima etapa automaticamente.

Etapa 2: Saídas do plugin

Informar o tipo das saídas (1), o nome da saída (2) e a cor que desejar. Clicar no botão Próximo:

Etapa 3: Regras de monitoramento

Na última etapa de regras é necessário criar o template padrão de regras de monitoramento que o plugin irá seguir. É obrigatorio adicionar no mínimo duas regras.

Na regra 1, definiremos que se a temperatura da cidade estiver acima de 20 graus, o plugin deverá exibir o estado WARNING. Para isso, utilizamos o comparador “>=” com “20” graus no estado “WARNING”. Esta definição é apenas um modelo padrão para vir preenchido quando adicionar um serviço. Esses parâmetros podem ser personalizados a qualquer momento, tanto no template do plugin quanto no próprio serviço.

Na regra padrão, deixamos no estado OK, ou seja, quando a temperatura não for “maior ou igual a 20”, o plugin assumirá esse estado.

Os textos usados nas imagens são:

Regra 1: It is getting hot... The city $output1$ is $output2$ and $result1$ degrees. The wind is $output4$ and the humidity is $output3$

Regra padrão: It is ok... The city $output1$ is $output2$ and $result1$ degrees. The wind is $output4$ and the humidity is $output3$

As variáveis $output$ são usadas para obter os valores retornados nas strings auxiliares definidas aqui, na seção “Saída do plugin”. Os índices são usados para obter os valores de uma posição específica. As variáveis $result$ seguem a mesma lógica, mas retornam os valores dos resultados.

Adicionando o plugin no monitoramento

Agora que o plugin foi carregado pela ferramenta, já se pode utilizá-lo no monitoramento.

Editar o dispositivo desejado e adicionar o serviço manualmente:

Quando executar o teste do plugin, o estado e o texto de saída já virão em caráter de teste.

Neste momento da execução, o estado estava WARNING porque em Porto Alegre a temperatura estava acima de 20 graus.

Para procurar outros códigos de cidades, entre no site abaixo:

https://hgbrasil.com/status/weather/

Nesta mesma interface, caso se queira alterar as regras, existe uma aba na parte superior direita chamada Regras. Após o teste realizado com sucesso, salve o serviço.

É possível adicionar vários serviços de várias cidades, cuidando apenas para não duplicar os nomes dos serviços.

Neste exemplo, adicionamos quatro serviços com os seguintes códigos:

• Maceió: BRXX0143
• Brasília: BRXX0043
• São Paulo: BRXX0232
• Porto Alegre: BRXX0186

Porém, no monitoramento de Maceió editamos a regra padrão par retornar o estado WARNING caso a temperatura esteja acima dos 30 graus e criamos mais uma regra para retornar o estado CRITICAL caso esteja acima de 38 graus:

Visualizando os resultados do monitoramento

Para visualizar os itens de monitoramento deve-se acessar o menu Visualização > Status de monitoramento. Use o campo de pesquisa para localizar os serviços recém criados.

No próximo post, revisaremos a criação de plugins mais avançados e exploraremos o uso de credenciais.