Primeiros passos com a API do Zabbix

Slides da apresentação no Zabbix on the road realizado em 29 de setembro de 2017 no Rio de Janeiro.

1. Primeiros passos com a API do Zabbix
Compreendendo o próximo nível
conectsys.com.br

2. Quem sou eu?
Janssen dos Reis Lima
•Bacharel em Sistemas de Informação pela FeMASS/UFF
•Especialista em Administração em Redes Linux pela
UFLA
•Engenheiro de Sistemas (SRE/DevOps) na Conectsys
•20 anos de experiência na área de TI
•Autor dos livros “Monitoramento de Redes com
Zabbix” e “Consumindo a API do Zabbix com Python”
•Membro ativo da comunidade
•Áreas de interesse: Automação, monitoramento, HPC,
API’s, Python

3. Agenda
•Apresentação da API do Zabbix
•Estrutura da API do Zabbix
•Classes e métodos da API do Zabbix
•O que é possível fazer?
•Integração entre sistemas
•Alguns projetos que utilizam a API do Zabbix

4. Visão geral da API
A API do Zabbix permite recuperar e modificar
configurações via programação, além de
fornecer acesso a dados históricos.

5. Visão geral da API
É amplamente utilizada para:

•Criar novas aplicações para trabalhar com
Zabbix;
•Fazer integração com software de terceiros;
•Automatizar tarefas rotineiras.

6. Visão geral da API


Consigo fazer isso com API?

7. Você sabe a diferença entre
back-end e front-end?

8. Você sabe a diferença entre
back-end e front-end?

9. server-side | client-side

10. Agora você já tem embasamento
para responder a essa pergunta:
A API do Zabbix faz dashboards?

11. Agora você já tem embasamento
para responder a essa pergunta:
A API do Zabbix faz dashboards?

NÃO

Utilizar a API do Zabbix não faz de você um
desenvolvedor web apto a desenvolver dashboards.
Mas sim, entregar os dados coletados via API para um
dashboard.

12. ZabiRepo

13. Octo-Zab

14. Zabbix-Dashboard

15. Grafana com plugin Zabbix

16. A API do Zabbix é uma API baseada na web e é
fornecida como parte da própria interface web
do Zabbix. Ela utiliza o protocolo JSON-RPC 2.0:
–Consiste de um conjunto de métodos;
–Requisições e respostas entre os clientes e a API
são codificados usando o formato JSON.

17. Requisição JSON
{
"jsonrpc": "2.0",
"method": "user.login",
"params": { "user": "Admin",
"password": "zabbix“
},
"id": 1,
"auth": null
}

18. Resposta JSON
{
"jsonrpc": "2.0",
"result": "0424bd59b807674191e7d77572075f33",
"id": 1
}

19. Antes da API
Antes da implementação da API do Zabbix, não
existia nenhuma ferramenta para controlar o
Zabbix fora da interface Web, exceto executar
consultas diretamente na base de dados, o que
não é muito seguro.

20. Onde encontrar documentação?
•https://www.zabbix.com/documentation/3.4/
manual/api

21. Requisições
•Enviar requisição HTTP POST para o arquivo
api_jsonrpc.php

Exemplo para chamar o método apiinfo.version:

POST http://localhost/zabbix/api_jsonrpc.php HTTP/1.1
Content-Type: application/json-rpc

{"jsonrpc":"2.0","method":"apiinfo.version","id":1,"auth"
:null,"params":{}}

22. Como fazer uma requisição?
•Interface web deve estar disponível
•Ter um cliente HTTP ou uma ferramenta JSON-
RPC
•Ter uma biblioteca com a API implementada

23. Usando o comando curl
# curl -s -X POST -H 'Content-Type: application/json' -d
'{"params": {"password": "zabbix", "user": "Admin"},
"jsonrpc": "2.0", "method": "user.login", "auth": null, "id": 1}'
http://localhost/zabbix/api_jsonrpc.php

Explicando:
•params: parâmetros que serão passados para o método da
API
•jsonrpc: versão do protocolo utilizado pela API
•mehtod: o método da API que será chamado
•id: identificador arbitrário do pedido
•auth: um token de autenticação para o usuário

24. Resposta da requisição
{"jsonrpc":"2.0","result":"1d8fa00b50f7c0be93938c
98a9d4d713 ","id":1}

•O resultado é o token para autenticação
•Apto para fazer as demais requisições

Obs.: para formatar a saída no formato JSON, insira
no final do comando: | python -mjson.tool

25. Continuando com as requisições
•Consulta
curl –s -X POST -H 'Content-Type: application/json' -d
'{"params": {"output": "shorten"}, "jsonrpc": "2.0",
"method": "host.get", "auth":
"1d8fa00b50f7c0be93938c98a9d4d713", "id": 1}'
http://localhost/zabbix/api_jsonrpc.php

•Resposta
{"jsonrpc":"2.0","result":[{"hostid":"10084"},{"hostid":"1
0107"},{"hostid":"10106"},{"hostid":"10109"},{"hostid":"1
0142"},{"hostid":"10159"},{"hostid":"10160"}],"id":1}

26. Ferramenta pra testar requisições
•Zapix - https://bitbucket.org/Vedmak/zapix
•Simples de usar
•Ideal para praticar o
formato de requisições
JSON com os métodos
da API do Zabbix

27. Por que eu preciso de uma biblioteca?
•As bibliotecas já implementam os métodos da API do
Zabbix e facilita o seu uso

•Qual a melhor biblioteca?
–Depende do seu conhecimento em programação
–Eu recomento a zabbix-api e pyzabbix (ambas escritas em
Python)
–https://github.com/gescheit/scripts/tree/master/zabbix
–https://github.com/lukecyca/pyzabbix

–https://www.zabbix.org/wiki/Docs/api/libraries (listagem
de todas as bibliotecas disponíveis)

28. Formatar a saída das requisições
•Ao invés de você consumir isso
[{u'host': u'Cable Modem', u'hostid': u'10106'}, {u'host':
u'TesteJanssen', u'hostid': u'10109'}, {u'host': u'Zabbix server',
u'hostid': u'10084'}, {u'host': u'Cliente', u'hostid': u'10107'},
{u'host': u'Nmap', u'hostid': u'10110'}]
•Você consumirá isto
10106 - Cable Modem
10109 – TesteJanssen
10084 – Zabbix server
10107 – Cliente
10110 - Nmap

29. Primeiros passos com Python
•Definir o cabeçalho do arquivo .py
#!/usr/bin/env python
# -*- coding: utf-8 -*-
from zabbix_api import ZabbixAPI
zapi = ZabbixAPI(server="http://<ip-ou-hostname>/zabbix")
zapi.login("<user>", "<password>")

30. Exemplo
•Consultar a versão da API do Zabbix instalada




print "Versão da API do Zabbix: ", zapi.api_version()

31. Exemplo com estrutura de controle
•Imprimir apenas o ID e nome do host

hosts = zapi.host.get({"output":["hostid","host"]})
for x in hosts:
print x["hostid"], "- ", x["host"]

32. Listar todos os hosts de acordo com o grupo de
host de acordo com o nome do grupo
id_grupo = zapi.hostgroup.get({"search":{"name":"Linux servers"},
"output":["groupid","name"]
})

nomes_grupo = zapi.host.get({"groupids":id_grupo[0]['groupid'],
"output":["host"]
})
print "Relação dos hosts associados ao grupo: ", id_grupo[0]['name']
print
"====================================================="
for x in nomes_grupo:
print x['hostid'], "-", x['host']

33. Listar a versão do agente dos hosts por grupo
grupo_hosts = zapi.item.get({"groupids":"17",
"filter":{"key_":"agent.version"},
"output":["lastvalue","hostid"]
})

print "Relação dos hosts com Zabbix Agent desatualizado."
print "-------------------------------------------------"
for x in grupo_hosts:
if x['lastvalue'] != "3.4":
host = zapi.host.get({"hostids":x['hostid'],
"output":["name"]})
print x['hostid'], "-", host[0]['name'], "-", x['lastvalue']

34. Relatórios
•Listagem básica de hosts e id’s.

35. Relatórios
•Número de vezes em que as triggers
foram acionadas em um determinado
período separado por host e
classificação de severidade.

36. Integração com outros sistemas
-Sistemas de pagamento
-Redes sociais

37. Zabbix + Google Analytics

38. ZABBIX + GLPI






•https://github.com/janssenlima/zabbix-glpi
Trigger PROBLEM

Executa uma ação

Reconhece evento
informando número do ticket

Trigger OK
Abre ticket informando número do evento



Fecha ticket informando número do evento

39. ZABBIX + GLPI + Telegram







•http://verdanatech.com/integrando-zabbix-
glpi-e-telegram/

40. Projetos que usam a API do Zabbix
Back-end
•Serviços de TI - https://github.com/janssenlima/api-zabbix
•Scripts diversos - https://github.com/janssenlima/api-zabbix
•Zabbix CLI Tools - https://www.zabbix.org/wiki/Zabbix_CLI_Tools
•ZabbixTuner - https://github.com/janssenlima/ZabbixTuner

Dashboards
•Grafana - https://github.com/alexanderzobnin/grafana-zabbix/
•ZabiRepo - https://github.com/usiusi360/zabirepo
•OctoZab - https://github.com/Quadrata-it/octo-zab
•Zabbix-Dashboard - https://github.com/incama/Zabbix-Dashboard

41. ZabbixTuner

42. Automação com Ansible
Módulos de monitoramento (Zabbix)
disponíveis no Ansible
•http://docs.ansible.com/ansible/latest/zabbix_host_module.html
•http://docs.ansible.com/ansible/latest/zabbix_group_module.html
•http://docs.ansible.com/ansible/latest/zabbix_hostmacro_module.html
•http://docs.ansible.com/ansible/latest/zabbix_maintenance_module.html
•http://docs.ansible.com/ansible/latest/zabbix_screen_module.html

Fácil utilização, não precisa programar nem saber
como fazer as requisições a API do Zabbix.

43. DÚVIDAS ?

44. www.conectsys.com.br

[email protected]

Telegram: @JanssenLima, @ZabbixBrasil
Fórum Zabbix : https://forum.zabbixoverflow.com


Onde me encontrar?