Zabbix

 

Essa documentação trata do serviço externo Zabbix. O serviço externo é acessado via API. As funcionalidades descritas aqui indicam as capacidades e os requisitos da integração, bem como o questionário e as funcionalidades relacionadas.

Tipo de Integração

A integração OZmap-Zabbix é do tipo Ativa.

Descrição

O Zabbix é uma ferramenta de software de código aberto para monitorar a infraestrutura de TI, como redes, servidores, máquinas virtuais, serviços em nuvem e equipamentos de rede em geral (como ONUs de clientes, por exemplo). O Zabbix coleta e exibe métricas básicas.

As funcionalidades da integração entre OZmap e Zabbix se baseiam nos items disponíveis no sistema de monitoramento, e seus identificadores. Para extrair informações destes identificadores, são utilizadas expressões regulares, as quais extraem de um texto a informação desejada.

Como clientes OZmap são encontrados no Zabbix

Para a manipulação de potência e status do cliente OZmap, é possível extrair a informação do código do cliente a partir de qualquer campo da ONU Zabbix, exemplo:

ITEM = JOAODASILVA-05325423605-joao.silva

Considerando que o campo código do cliente no OZmap é o login PPPoE utilizado pelo cliente, a integração aplica uma função nos textos acima para extrair apenas essa informação, que seria: “joao.silva“.

Para isso, a expressão regular é utilizada.

Veja aqui exemplos de como pode ser formatado o texto do item e expressões para usar

Resumo de funcionalidades

Funcionalidade

Descrição

Direção da integração

Funcionalidade

Descrição

Direção da integração

Atualização de status

Atualização do valor de status do cliente no OZmap baseado na leitura informada pelo Zabbix.

Zabbix => OZmap

Atualização de potência

Atualização do valor de potência lida no OZmap baseado na leitura informada pelo Zabbix.

Zabbix => OZmap

Funcionalidades

Abaixo serão descritas as funcionalidades apresentadas no resumo de forma a entender como funciona o fluxo de sincronização.

Atualização de status

Atualização do valor de status do cliente no OZmap baseado na leitura informada pelo Zabbix. O campo “status” é atualizado no OZmap utilizando o item de status definido nas configurações e respeitando as regras abaixo.

  • São lidos todos os itens com nome definido nas configurações

  • Para cada item, é extraído o código de identificação que encontrará o cliente no OZmap, utilizando a expressão regular definida.

  • Caso seja encontrado, e o valor presente no OZmap seja diferente do valor trazido pelo Zabbix, o campo do OZmap é atualizado. O valor de status segue o seguinte padrão:

Status Zabbix

Status OZmap

Status Zabbix

Status OZmap

1

OK (0)

Qualquer outro valor

ERROR (1)

Atualização de potência

Atualização do valor de potência lida no OZmap baseado na leitura informada pelo Zabbix. O campo “Potência lida” é atualizado no OZmap, utilizando o item definido nas configurações.

  • São lidos todos os itens com nome definido nas configurações

  • Para cada item, é extraído o código de identificação que encontrará o cliente no OZmap, utilizando a expressão regular definida.

  • Caso seja encontrado, e o valor presente no OZmap seja diferente do valor trazido pelo item do Zabbix, o campo “Potência lida” do OZmap é atualizado.

Configurações Base

Parâmetro

Descrição

Padrão

Parâmetro

Descrição

Padrão

Tempo entre Sincronizações

Tempo aguardado entre as sincronizações realizadas pela integração

15 minutos

Nome do parâmetro de usuário

Nome do parâmetro de usuário passado na chamada de autenticação do servidor Zabbix (esse parâmetro diverge dependendo da versão do Zabbix utilizada pelo cliente).

user

Configurações Específicas - Potência

Parâmetro

Descrição

Padrão

Parâmetro

Descrição

Padrão

Nome do Item de potência

Nome do item que guarda a potência da ONU no Zabbix (ex: Potency ONU)

Potency RX

Atributo de busca do item de potência

Atributo que será utilizado para buscar os itens de potência no Zabbix.

name

Atributo de extração do código de vínculo para potência

Atributo que será utilizado para extrair o código que será buscado dentro do OZmap, a extração ocorre por expressão regular, identificada abaixo. (ex: name, key_)

key_

Expressão regular para identificação do código de vínculo entre sistemas para potência

Expressão utilizada para extrair do parâmetro de código, o código que será buscado no OZmap, o padrão é utilizar todo o valor do atributo indicado acima.

/(.*)/

Configurações Específicas - Status

Parâmetro

Descrição

Padrão

Parâmetro

Descrição

Padrão

Nome do Item de status

Nome do item que guarda o status da ONU no Zabbix (ex: Status ONU)

Status ONU

Atributo de busca do item de status

Atributo que será utilizado para buscar os itens de status no Zabbix.

name

Atributo de extração do código de vínculo para status

Atributo que será utilizado para extrair o código que será buscado dentro do OZmap, a extração ocorre por expressão regular, identificada abaixo. (ex: name, key_)

key_

Expressão regular para identificação do código de vínculo entre sistemas para status

Expressão utilizada para extrair do parâmetro de código, o código que será buscado no OZmap, o padrão é utilizar todo o valor do atributo indicado acima.

/(.*)/

Dados Acesso

https://docs.google.com/forms/d/e/1FAIpQLSffEHBN8_z-qusFP36R3HJ9RXueblHISNsAVffnaHejj84udQ/viewform

Zabbix

Dados de acesso necessários para buscar informações via API no sistema Zabbix. (Estes dados devem ser fornecidos no questionário inicial)

Parâmetro

Descrição

Exemplo

Parâmetro

Descrição

Exemplo

URL

Endereço do servidor Zabbix considerando se existe ou não um “path” para acessar(ex: /zabbix).

https://zabbix.cliente.com.br/zabbix

Login

Nome usuário do sistema criado para a integração.

ozmap

Senha

Senha de acesso do usuário

-

OZmap

Parâmetro

Descrição

Exemplo

Parâmetro

Descrição

Exemplo

Token

Token associado a conta do usuário de integração cadastrado no ozmap. (O usuário deve ter acesso aos projetos que a integração irá trabalhar (Escolha do usuário). Tutorial de como gerar usuário/chave).

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtb2R1bGUiOiJhcGkiLCJ1c2VyIjoiNWQ5ZjNmYjgyMDAxNDEwMDA2NDdmNzY4IiwiY3JlYXRpb25EYXRlIjoiMjAyMC0wOC0yNFQxNjoxMjoyMS43MTdaIiwiaWF0IjoxNTk6Mjg1NTQxfQ.S215vbHlBLtZSzxmORIc2sH1lEKi5VALKBqZB1VcFCE

Liberação de IPs

Para validação e execução da integração no ambiente de produção, é necessário que sejam liberados no servidor do cliente os IPs utilizados pelo OZmap:

Logs

A integração ainda não possui logs.

Questionário

Pergunta

Resposta

Funcionalidade

Pergunta

Resposta

Funcionalidade

É possível utilizar apenas algumas das funcionalidades acima?

Sim, é possível escolher executar apenas uma ou mais das funcionalidades descritas

-

É possível alterar o mapeamento de status definidos? Ex: Status 3 no Zabbix ser OK no OZmap

Não, até a presente versão o mapeamento de status é fixo, é algo possível de ser feito mediante pedido de melhoria.

Atualização de Status

É possível considerar uma potência menor que um valor pré definido como status ERRO?

Não, atualmente a integração de potência apenas atualiza no OZmap, é possível desenvolver a parte uma aplicação que identifica padrões específicos da empresa e muda o status de acordo com as definições de cada um. (OZmatic)

Atualização de Status

Na atualização de status, é possível pegar o código do cliente OZmap na ONU a partir de qualquer campo?

Sim, atualmente na versão da integração, o código do cliente OZmap é pego a partir de qualquer campo da ONU.

Atualização de Status

Na atualização de potência, é possível pegar o código do cliente OZmap na ONU a partir de qualquer campo?

Sim, atualmente na versão da integração, o código do cliente OZmap é pego a partir de qualquer campo da ONU.

Atualização de Potência

//Anotar as perguntas e possíveis respostas e quais as funcionalidades relacionadas às respostas.