Nesta página, você encontrará algumas ferramentas que podem ser utilizadas para o monitoramento de seu ambiente Protheus. As configurações aqui descritas pretendem facilitar a implantação do monitoramento; porém, não há impeditivos para que você configure seus dashboards de maneira diferente. Certifique-se apenas de que as informações coletadas agregarão valor à análise de seu ambiente e não impactarão no funcionamento da aplicação.

Links relevantes

InfluxDB • Instalação do InfluxDB • Criando um token do InfluxDB • Linguagem Flux • Primeiros passos com o Flux • Telegraf • Pilha TICK (TICK Stack) • Instalação do Telegraf • Primeiros passos com Telegraf • Criando um token para o InfluxDB • Grafana • Instalação do Grafana • Dashboard (Grafana) de observabilidade para ambientes Protheus

Após instalar o InfluxDB, será necessário:

♦ Criar uma nova bucket;

♦ Gerar um token para o coletor do Telegraf.

Criando uma bucket

Para criar uma nova bucket, acesse o endereço do InfluxDB, definido no momento de sua instalação. Em caso de dúvidas, verifique na documentação qual é o endereço e porta padrões. Na tela que carregará, clique, no menu lateral, em Data, e selecione a aba Bucket. Após isto, clique em +Create Bucket (canto superior direito) para adicionar uma nova bucket.

Atribua o nome da bucket que será criada no campo Name. Em seguida, clique em Create.

Opcional: Você pode definir a deleção dos dados após determinado período; mas não habilite esta opção para períodos curtos para poder ter uma análise mais precisa de seu ambiente. Lembre-se que os dados coletados podem ser utilizados para análise do consumo em momentos atípicos onde seus recursos são consumidos de maneira diferente do normal.

Gerando um token para o coletor do Telegraf

Após criar a bucket, clique novamente em Data no menu lateral. Selecione a aba API Token.

Clique em +Generate API Token e selecione Read/Write API Token.

Digite uma descrição para o token no campo Description. Em seguida, selecione o escopo de acesso. Neste caso, apenas a leitura e escrita da bucket criada anteriormente está sendo permitida. No lugar de "engprodados", estará o nome da bucket criada no passo anterior.

Copie o token gerado. Este será utilizado para configurar o telegraf dentro do arquivo telegraf.conf e no portal do grafanaGrafana.

Caso necessário, consulte a documentação oficial para verificar os passos de criação de token do InfluxDB.

Seguindo o exemplo de instalação do Telegraf como serviço Windows, os parâmetros necessários serão editados para o funcionamento adequado do dashboard no Grafana. Nesta seção, você verá:

♦ Como editar o arquivo de configuração do Telegraf;

♦ Como conectar o Telegraf à base criada no InfluxDB.

Acesse o caminho onde está o arquivo telegraf.conf padrão, (por exemplo, "C:\Program Files\InfluxData\telegraf\telegraf.conf") e substitua o conteúdo deste arquivo pelo do arquivo telegraf.conf disponibilizado no git.

Após inserir o conteúdo, será necessário editar algumas chaves para se conectar a seu ambiente.

Localize a chave token e insira o token criado previamente no InfluxDB, detalhado na seção anterior.

Localiza as chaves bucket e organização e insira os valores correspondentes aos de seu ambiente InfluxDB, definidos durante a instalação (em caso de dúvidas, o nome da organização pode ser acessado em Menu do usuário > About. No canto direito será exibido o nome da organização).

[[outputs.influxdb_v2]]
  ## URL onde está o influxdb.
  urls = ["https://IP_DO_INFLUXDB:8086"]
  ## API token para autenticação.
  token = "SEU_TOKEN"
  ## Nome da organizaçao onde serão escritos os dados.
  organization = "SUA_ORGANIZACAO"
  ## Bucket de destino onde serão gravados os dados.
  bucket = "SUA_BUCKET"

Consulte também os primeiros passos com Telegraf.

O Grafana não é um coletor nem uma base de dados; é apenas uma ferramenta que apresenta os dados coletados por meio de outras ferramentas. Para a coleta foi utilizado o Telegraf, e para o armazenamento, o InfluxDB. Importante ressaltar que nesta página está demonstrada a configuração das três ferramentas.

Após instalar o Grafana e o plugin Clock, será necessário:

♦ Configurar a origem dos dados (data source) que serão apresentados no Grafana;

♦ Configurar seu dashboard (nota: um dashboard foi criado pela Engenharia de Dados Protheus para facilitar a visualização dos dados, e este será importado; para configurar seu dashboard sem importar este, consulte a documentação do Grafana para maiores detalhes).

Configurando o data source

Acesse o endereço do serviço Grafana (definido na instalação; em caso de dúvidas, consulte a documentação) para visualizar o painel. Clique em Configuration > Data Sources no menu lateral esquerdo:

Em seguida, clique em Add data source, à direita:

Nas opções de databases, selecione InfluxDB:

Em Name, defina um nome para o datasource (este nome será utilizado no dashboard), e em Query Language, selecione FLUX.

Na seção HTTP, defina, em URL, o endereço do InfluxDB (IP do servidor onde o InfluxDB está instalado e porta). Se a instalação do InfluxDB foi realizada conforme o padrão de instalação descrito no site da ferramenta, os parâmetros abaixo podem ser deixados da maneira sugerida pelo Grafana.

Na seção Auth, caso a instalação tenha sido conforme o padrão, você pode definir as configurações conforme esta página. Caso contrário, será necessário consultar a documentação para a configuração de autenticação.

Defina Basic Auth como habilitado, e coloque o User (usuário cadastrado no InfluxDB) e Password (senha de acesso ao InfluxDB).

Em Custom HTTP Headers, inclua o header Authorization com o valor "Token <TOKEN_GERADO_NO_INFLUXDB>"

Na seção InfluxDB Details, defina:

• Em Organization, o nome da organização configurada no InfluxDB;
• Em Token, apenas o token disponibilizado no InfluxDB;
• Em Default Bucket, qual será a bucket padrão, existente no InfluxDB

Após isto, clique em Save & Test.

Importando o Dashboard

Após configurar os acessos, no menu lateral, clique em Import.

Insira o código 15660 no campo Import via grafana.com e, em seguida, clique em Load. Consulte a documentação do dashboard a ser importado: Grafana Dashboard Doc.

As configurações serão carregadas; clique em Import.

Na tela inicial selecione, em bucket, a bucket onde os dados do telegraf estão sendo armazenados; em instances, selecione a instância que deseja monitorar; e em services, selecione o serviço que deseja monitorar.