Este documento tem como objetivo fornecer as informações necessárias para instalação e configuração do Servidor de Monitoração (SM).
Use os procedimentos indicados a seguir para realizar a instalação.
Informações Gerais e Requisitos para Instalação - Versão 4.0.0 ou superior
Para iniciar é necessário parar o serviço do Tomcat referente ao servidor de monitoração legado antes de realizar a instalação do novo SM.
A máquina onde será instalado o SM, deve possuir o servidor do WildFly, é instruído que seja utilizado a versão a partir da 25+ (Link: Instruções de Instalação do WildFly 25).
É de responsabilidade do usuário verificar se já existe uma instalação do SM antes de prosseguir com os passos deste manual.
O suporte aos bancos de dados Oracle e MariaDB é fornecido. A estrutura do banco de dados usada pela aplicação deve estar disponível e pronta antes da execução dos passos deste manual.
Os scripts estão inclusos no caminho (bd/script_atualizacao) no pacote de versão do projeto.
Para utilizar todas as funcionalidades do Servidor de Monitoração é necessário também realizar as instalação dos plugins, ver instruções no link: Plugins Servidor de Monitoração
Neste documento, "diretório raiz" é o diretório onde o Servidor de Aplicação WildFly foi instalado.
Etapa 1 - Instalação
1.1 - Configuração do datasource da Aplicação
O datasource é usado pela aplicação para ter acesso ao banco de dados, então para isto as informações devem estar disponíveis para configuração da conexão:
IP/Hostname, Porta, ServiceName/SID, Login, Senha.
Além das informações citadas também é necessário o nome do dataSource, que no caso deste projeto é LinxMonitoringManagerDS.
Os passos abaixo devem ser seguidos de acordo com o banco dados no qual a aplicação vai ser executada, fazendo também a substituição do nome do dataSource de LinxDS para LinxMonitoringManagerDS.
1.1.2 - Criando um datasource ORACLE para a Aplicação
Para realizar a configuração do datasource do banco Oracle, segue link do share com instruções completas com seu passo a passo, a partir da Etapa 6 – Criar um datasource Link Share.
O campo Name deve ser: LinxMonitoringManagerDS
O JNDI Name deve ser : java:jboss/datasources/LinxMonitoringManagerDS
1.1.3 - Criando um datasource MariaDB para a Aplicação
Para realizar a configuração do datasource do banco MariaDB, segue link do share com instruções completas com seu passo a passo Link Share.
O campo Name deve ser: LinxMonitoringManagerDS
O JNDI Name deve ser : java:jboss/datasources/LinxMonitoringManagerDS
1.2 - Distribuição do pacote da Aplicação
A aplicação é distribuída através de um arquivo “.war”.
Para iniciar sua distribuição, usando a interface de administração do servidor, acesse o menu “Deployments” e siga os seguintes procedimentos:
1.3 - Passos referente ao Deploy
Nessa etapa será apresentado os passos para ser realizado o Deploy manualmente pelo WildFly:
| Passos | Exemplos |
|---|---|
| 1 - Realizando Deploy |
|
| 2 - Selecionar o arquivo para importação |
|
| 3 - Clicar em Finish |
|
Para acessar o servidor de monitoração basta acessar a URL: http://ip-wildfly:porta-wildfly/linx-servidor-monitoracao/#/login
Exemplo: http://10.4.229.11:8100/linx-servidor-monitoracao/#/login
Caso a base de dados utilizada seja uma instalação nova, então é necessário definir a senha do usuário admin utilizando a senha temporária 123456 no primeiro login.
Verificando status dos serviços
A partir da versão 4.6.0 o servidor de monitoração dispõe de um endpoint para verificação de status dos serviços do produto. A validação contempla a camada dos serviços REST e o processamento de eventos recebidos via linx-messaging.
Os serviços REST são utilizados para consultas, cadastros, edições, logins, etc por meio da interface WEB do servidor de monitoração. Já o processamento de eventos via linx-messaging é utilizado para receber os eventos de forma passiva, isto é, o servidor fica apenas aguardando o recebimento de eventos enviados por outros sistemas. Atualmente o linx-messaging é a principal forma utilizada pelos produtos Linx para envio de eventos ao servidor de monitoração, exemplo: PDV, SP, Linx Cloud, Gerenciador de Integração, etc.
O endpoint de verificação usa o verbo HTTP GET e não recebe parâmetros. Para executar a verificação pode ser utilizado algum cliente HTTP, Postman ou direto em um navegador como o Chrome ou Firefox, por meio da seguinte URL: http://ip-wildfly:porta-wildfly/linx-servidor-monitoracao/api/v1/status/servicos
Exemplo: http://10.4.229.11:8100/linx-servidor-monitoracao/api/v1/status/servicos
O retorno da requisição é um JSON com os seguintes atributos:
| Atributo | Significado | Exemplo |
|---|---|---|
| numeroVersao | Valor string com a versão atual do produto | "4.6.0" |
| servicoRestAtivo | Valor booleano referente ao status atual de serviços REST | true |
| processadorEventosAtivo | Valor booleano referente ao status atual do serviço que recebe e processa eventos via linx-messaging | true |
| mensagemErro | Mensagem de erro ocorrido durante a validação dos serviços (é retornado apenas em caso de erro) | "Erro ao salvar evento de status" |
Exemplo de retorno com sucesso
Exemplo de retorno sem sucesso
Caso a requisição retorne 404 ou outro erro de inacessibilidade, então significa que a camada de serviços REST não foi iniciada corretamente, exemplo:
Para cada requisição de status de serviços executada com sucesso, também é gerado um evento que é processado e salvo no banco de dados com o seguinte ID de Definição de Evento: "STATUS_SERVICOS_SERV_MONITORACAO".
O evento gerado pode ser consultado/validado na tela Home, na aba "Eventos em tempo real" ou na tela Consultas / Eventos, na qual são pesquisados e retornados os eventos direto do banco de dados.
É possível também desabilitar o salvamento do evento de status de serviços no banco de dados por meio da criação de uma definição de evento com o ID "STATUS_SERVICOS_SERV_MONITORACAO" e marcando a opção "Desabilitar evento". Com isso, o evento gerado durante o processo de verificação de status será recebido e processado, mas não será salvo no banco e nem exibido na tela home na aba "Eventos em tempo real", mas é mantido o retorno da requisição com o status dos serviços. De forma análoga as outras opções também podem ser utilizadas, conforme necessidade: "Tempo de vida" ou "Manter armazenado somente último registro".
Segue exemplo de cadastro de definição de evento:
1.4 - Passos referente a Remoção do Deploy
| Passos | Exemplos |
|---|---|
| 1 - Removendo Deploy |
|
1.5 - Atualizando Deploy
Para o passo de atualização do deploy é instruído realizar a etapa de remoção ( 1.4 - Passos referente ao Deploy ), depois inserir novamente ( 1.3 - Passos referente ao Deploy ) pois, utilizando o replace só irá funcionar se o arquivo de deploy tiver o mesmo nome, algo que não costuma acontecer.
Etapa 2 - Integração com o Portal Big Retail
O servidor de monitoração pode ser utilizado integrado com o Portal Big Retail ou de forma independente.
A versão mínima necessária do Portal Big Retail: 3.39.0
Para utilizar de forma integrada, basta seguir os passos abaixo:
| Passos | Exemplos |
|---|---|
1 - Acessar o servidor de configuração Exemplo: 10.4.229.11:8090/linx-servidor-configuracao/#!/ |
|
2 - Acessar o menu: Manutenção > Parâmetros > Grupo de parâmetros |
|
| 3 - Selecionar o grupo de parâmetros GRP-PORTAL-BIG-RETAIL - GLOBAL e parâmetro URL da API Rest do Servidor de monitoracao. |
|
4 - Inserir o IP do servidor de monitoração Exemplo: http://10.4.229.11:8100 |
|
5 - Enviando os parâmetros configurados através do menu Enviar Parâmetros > Grupo de Parâmetros |
|
6 - Parâmetro configurado enviado para aplicação! |
|
7 - Acessando o Servidor de Monitoração via Portal Big Retail após configuração da integração |
|
Informações Gerais e Requisitos para Instalação - Versão inferior a 4.0.0
Instruções de Instalação do Banco de Dados:
Para Oracle: seguir as instruções do manual de instalação dos scripts de banco que se encontra em anexo, na pasta \script_atualizacao\ORACLE\02-ATUALIZACAO\ Roteiro_Atualizacao_SRVMON_Oracle.doc.
Para SQL Server: seguir as instruções do manual de instalação dos scripts de banco que se encontra em anexo, na pasta \script_atualizacao\SQLSERVER\02- ATUALIZACAO\ Roteiro_Atualizacao_SRVMON_SQLServer.doc.
Instruções de Instalação do Servidor:
Seguir as instruções do manual de instalação do TomCat que se encontra em anexo, SERV-MONITOR-MAN-apache_tomcat.PDF;
Seguir as instruções do manual de instalação do Servidor de Monitoração que se encontra em anexo, SERV-MONITOR-MAN.PDF;
Instruções de Instalação do Banco de Dados:
Para Oracle: seguir as instruções do manual de instalação dos scripts de banco que se encontra em anexo, na pasta \script_atualizacao\ORACLE\02-ATUALIZACAO\ Roteiro_Atualizacao_SRVMON_Oracle.doc.
Para SQL Server: seguir as instruções do manual de instalação dos scripts de banco que se encontra em anexo, na pasta \script_atualizacao\SQLSERVER\02- ATUALIZACAO\ Roteiro_Atualizacao_SRVMON_SQLServer.doc.
Instruções de Atulização do Servidor:
Parar o serviço do windows "Apache Tomcat 6".
Seguir o passo a passo do manual de instalação (SERV-MONITOR-MAN.pdf) que se encontra no pacote do release do Servidor de Monitoração (SERV-MONITOR-XX.XX.XX.zip), instalando na mesma pasta (portas, IP’s, endereço do banco, etc.) onde se encontra instalada a versão atual.