Instalação da Extensão TDP APIM Insights para o WSO2 API Manager

A extensão TDP APIM Insights permite a análise e visualização dos dados de uso das APIs gerenciadas pelo WSO2.

250

Para a instala-lá é necessário possuir o respectivo arquivo da extensão (.taf), fornecido individualmente pela Tecnisys após a contratação do produto. Se deseja adiquiri-lá, fale conosco.

Pré-Requisitos

  • Arquivo da extensão TDP APIM Insights (.taf).

  • O Cluster TDP deve estar instalado e configurado, com os serviços do Apache NiFi, Apache Kafka, Apache Druid e Apache Superset em execução.

  • O WSO2 API Manager deve estar instalado e configurado.

  • O tdpctl, a Interface de Linha de Comando do TDP, deve estar instalada.

Sintaxe do Comando

tdpctl addon-install -f /caminho/para/arquivo.taf
Para informar o arquivo da extensão TDP (.taf) no comando, utilize a opção -f ou --file. Caso não informe o arquivo no comando, o tdpctl solicitará essa informação durante a execução. O caminho do arquivo deve ser absoluto.

Para informações sobre o comando addon-install, informe a opção --help:

tdpctl addon-install --help
Opção --help do comando tdpctl addon-install
Figure 1. Opção --help do comando tdpctl addon-install

Estágios da Instalação

A instalação da extensão TDP APIM Insights deve ser conduzida em dois estágios, executados em sequência.

O primeiro, o estágio BIG-DATA, deve ser executado em um dos hosts do Cluster TDP.

Já o segundo, o estágio API-MANAGER, deve ser executado no host em que o WSO2 API Manager está instalado.

No caso de uma implantação do WSO2 API Manager com mais de um nó, o estágio API-MANAGER deve ser executado em todas as máquinas.

Para ambos os estágios, o comando de instalação é o mesmo, conforme sintaxe apresentada acima.

Estágio BIG-DATA

No estágio BIG-DATA, são requisitadas informações, realizadas verificações e executadas operações nos serviços do Cluster TDP utilizados pela extensão. São eles: Apache NiFi, Apache Kafka, Apache Druid e Apache Superset.

No tdpctl, após a execução do comando de instalação da extensão (addon-install), o usuário deverá:

  1. Selecionar o idioma desejado.

  2. Informar o arquivo da extensão TDP (.taf), caso este não tenha sido informado no comando (opção -f ou --file).

  3. Informar a senha para decriptografar o arquivo.

  4. Confirmar que deseja iniciar a operação de instalação da extensão.

  5. Selecionar o estágio big-data (opção 1).

Na sequência, para cada serviço do Cluster TDP, o usuário deve:

AMBARI

  1. Informar o host do Ambari Web [Default: localhost].

  2. Informar a porta do Ambari Web [Default: 8080].

  3. Informar o protocolo de comunicação utilizado pelo Ambari Web [Default: http].

  4. Informar o nome do Cluster TDP definido no Ambari.

  5. Informar o usuário de autenticação do Ambari [Default: admin].

  6. Informar a senha de autenticação do Ambari.

NIFI

  1. Informar o usuário de autenticação do NiFi.

  2. Informar a senha de atutenticação do NiFi.

DRUID

  1. Informar o usuário de autenticação do Druid.

  2. Informar a senha de autenticação do Druid.

SUPERSET

  1. Informar o usuário de autenticação do Superset.

  2. Informar a senha de autenticação do Superset.

Confira todas as etapas do estágio BIG-DATA na imagem a seguir.

Execução do Estágio BIG-DATA
Figure 2. Execução do Estágio BIG-DATA
Ao final deste estágio é fornecida a URL do serviço do Apache NiFi. Lembre-se de copiá-la, pois será necessário informá-la no estágio API-MANAGER.

Os logs da instalação da extensão TDP APIM Insights são armazenados no diretório de instalação do tdpctl.

Para visualizar os logs, execute o comando a seguir:

tail -f <DIRETORIO_tdpctl>/tdpctl.log

A variável <DIRETORIO_tdpctl> corresponde ao diretório de instalação do tdpctl.

Estágio API-MANAGER

No estágio API-MANAGER, o WSO2 API Manager será configurado para enviar dados para o Cluster TDP, viabilizando, desta forma, o monitoramento das APIs.

No tdpctl, após a execução do comando de instalação da extensão (addon-install), o usuário deverá:

  1. Selecionar o idioma desejado.

  2. Informar o arquivo da extensão TDP (.taf), caso este não tenha sido informado no comando (opção -f ou --file).

  3. Informar a senha para decriptografar o arquivo.

  4. Confirmar que deseja iniciar a operação de instalação da extensão.

  5. Selecionar o estágio api-manager (opção 2).

Na sequência, para o WSO2 API Manager, o usuário deve:

WSO2AM

  1. Informar a URL do WSO2 API Manager para verificação da versão.

  2. Informar o usuário do WSO2 API Manager [Default: admin]

  3. Informar a senha do WSO2 API Manager.

  4. Informar o caminho de instalação do WSO2 API Manager. [Default: /opt/wso2am]

  5. Informar o nome do daemon service do WSO2 API Manager. [Default: wso2am]

  6. Informar o usuario do serviço WSO2 API Manager. [Default: wso2user]

  7. Informar a URL do serviço do Apache NiFi. Se o NiFi estiver em cluster, informar a URL de um dos nós.

Confira todas as etapas do estágio API-MANAGER na imagem a seguir.

Execução do Estágio API-MANAGER
Figure 3. Execução do Estágio API-MANAGER

Os logs da instalação da extensão TDP APIM Insights são armazenados no diretório de instalação do tdpctl.

Para visualizar os logs, execute o comando a seguir:

tail -f <DIRETORIO_tdpctl>/tdpctl.log

A variável <DIRETORIO_tdpctl> corresponde ao diretório de instalação do tdpctl.

Análise e Visualização dos Dados

Após a instalação da extensão TDP APIM Insights, os dados de uso das APIs gerenciadas pelo WSO2 API Manager podem ser analisados e visualizados no Apache Superset. Para isso, o usuário deve:

  1. Acessar a interface web do Apache Superset. Link disponível na seção Quick Links do Ambari Web.

    Página de início do Apache Superset
    Figure 4. Página de início do Apache Superset

  2. Na aba "Dashboards", selecionar o painel API MANAGER - WSO2.

    Visualização do painel API MANAGER - WSO2
    Figure 5. Visualização do painel API MANAGER - WSO2

  3. Utilizar os filtros e tabelas disponíveis para analisar os dados de uso das APIs.

    Explorar painel API MANAGER - WSO2
    Figure 6. Explorar painel API MANAGER - WSO2