# SmartSense

## Introdução

O **GBS SmartSense** é uma aplicação web para monitorar clusters GBDS, permitindo que o usuário veja relatórios ao vivo do desempenho e integridade do ambiente.

Este manual está atualizado para a versão 1.2.4 do SmartSense.

### Acesso e Autenticação

O GBS SmartSense deve ser acessado com um navegador web e recomendamos o Google Chrome. A URL para acesso é específica para cada ambiente. Se necessário, entre em contato com a equipe de suporte da Griaule para obter a URL correta.

É necessário se autenticar para acessar o aplicativo. As credenciais necessárias para o GBS SmartSense são nome de usuário e senha.

![tela de login](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-08f38c94e618a101602ea807d318e334eac42c27%2Flogin.png?alt=media)

{% hint style="info" %}
Na parte inferior da tela há uma opção para alterar o idioma da interface do usuário. Esta opção também está disponível nas configurações após o login.
{% endhint %}

### Autenticação de dois fatores (2FA)

Quando a autenticação de dois fatores (2FA) estiver ligada, na primeira vez que você fizer login, após entrar seu username e senha, será mostrado um QR Code que deve ser registrado no Google Authenticator.

{% hint style="info" %}
Google Authenticator é um gerador de códigos de autenticação disponível como um aplicativo para smartphones [Android](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2\&hl=en\&gl=US) e [iOS](https://apps.apple.com/us/app/google-authenticator/id388497605).
{% endhint %}

![QR Code do Google authenticator para autenticação de dois fatores](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-8c851f0036863e95cc0e0cd352c0cd2bc6aa58c9%2F2FA_qrCode.png?alt=media)

Após registrar com sucesso o QR Code no Google Authenticator, insira o código de seis dígitos gerado e clique em Enviar.

Você só precisará registrar o QR Code uma vez. Mas, a cada login subsequente, você precisará inserir o código de seis dígitos gerado pelo Google Authenticator.

![Autenticação de dois fatores](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-1395263f1b55852ea3387c8e78fb7e5234e8ae66%2F2FA.png?alt=media)

Existe um número limitado de tentativas de login sem sucesso que um usuário pode fazer. Sempre que um código incorreto é inserido, uma mensagem de erro será exibida:

![Autenticação de dois fatores - código incorreto](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-b45daf45e1de591f55eb743b6c7967dd916674f8%2F2FA_incorrectCode.png?alt=media)

Se você atingir o número máximo de tentativas de login sem sucesso, sua conta será automaticamente bloqueada.

![Autenticação de dois fatores - conta bloqueada](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-f093828b7d143a9fdb1f0f55ed6f78e590fbb709%2F2FA_blockedAccount.png?alt=media)

{% hint style="warning" %}
Se sua conta for bloqueada, entre em contato com o administrador do sistema.
{% endhint %}

### Logins Simultâneos e Cadastro de Navegador

Apenas uma sessão por usuário é permitida. Não é possível fazer login simultaneamente com um mesmo perfil mais de uma vez na aplicação. Se um usuário já estiver conectado e outro acesso acontecer usando o mesmo nome de usuário e senha, o usuário com a sessão mais antiga será notificado e desconectado na próxima ação.

![](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-a8ff32a265c76c465e05f017eebc317c74964bd5%2FsimultaneousLogin.png?alt=media)

Além disso, apenas um navegador pode ser usado de cada vez. Ao tentar fazer login usando um navegador diferente, o usuário será informado que é necessário autenticar o novo navegador. A autenticação de um novo navegador revogará o acesso do navegador anterior.

![](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-63913ca2e47dcb93c0d2c36dd343ea1f1ac76a2e%2FbrowserEnrollment1.png?alt=media)

Para autenticar um novo navegador, clique em Autenticar e, em seguida, insira o código de verificação que será enviado para o e-mail vinculado à conta do usuário.

![](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-057a4f98078e6eb9a12c32b0eb500165738761a2%2FbrowserEnrollment2.png?alt=media)

Se a autenticação for bem-sucedida, uma notificação aparecerá no canto superior direito da tela após o login.

![](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-dcf4d6e20b27f7f4763b6c949fb3c27eb9fbeb77%2FbrowserEnrollment3.png?alt=media)

### Redefinir Senha

Você pode redefinir sua senha caso a esqueça.

Para redefinir sua senha, na tela de login, clique em Esqueceu sua senha?:

![](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-b5e3af1417b2eeb8e48cff0301f7a8fe339b2b6a%2FresetPassword1.png?alt=media)

Em seguida, insira o nome de usuário do perfil e clique em Enviar.

![](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-ec6cea4dfcfcbdf9ec48ed5696296358bc92b3b9%2FresetPassword2.png?alt=media)

Um e-mail contendo um código de verificação será enviado para o endereço de e-mail vinculado a esse perfil. Insira o código de verificação e clique em Enviar código.

![](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-057a4f98078e6eb9a12c32b0eb500165738761a2%2FresetPassword3.png?alt=media)

Se o código estiver correto, você poderá criar uma nova senha. Insira a nova senha duas vezes. Certifique-se de atender aos requisitos da senha, eles estão listados abaixo do campo de nova senha e ficarão verdes quando atendidos. Por fim, para confirmar a redefinição, clique em Redefinir senha.

![](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-1de4c68bca096e18a963d4ceeccabba30465e254%2FresetPassword4.png?alt=media)

## Interface do Usuário

Há seis telas que podem ser acessadas usando a barra lateral: `Lista de Nós`, `Comparação entre Configurações`, `Port Sweep`, `Histórico de Transações`, `Fila` e `Lista de Transações`.

![barra lateral](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-7eef825193474c72f7281073cb9935fb8dd756d0%2Fsidebar_ptbr.png?alt=media)

### Lista de Nós

A tela de `Lista de Nós` mostra informações sobre espaço de armazenamento disponível, RAM, temperatura, número de matchers e status para cada host/IP.

![tela de lista de nós](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-bec5db7d8dd5ec65460e28bea2c343f4ede54ba7%2FnodeList_ptbr.png?alt=media)

Para atualizar as informações mostradas, use o botão de atualização ou recarregue a página pressionando Ctrl/Command + R no teclado.

![botão de atualização](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-c4ccb6074aa6731598cb3c0bf2e07771bae453d0%2FrefreshButton_ptbr.png?alt=media)

No canto superior direito, é possível filtrar as informações mostradas por hostname ou endereço IP:

![lista de nós filtrada](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-10272d95afe1535cc5d6d9f3493c5d4897b09dc2%2Fsearch_ptbr.png?alt=media)

Para criar um novo nó sem acessar diretamente a base de dados, clique no botão Novo Nó no canto inferior direito. Insira as informações de hostname, IP, e porta. Em seguida, marque se é um nó **Ativo**. Finalmente, clique em Adicionar Nó.

O status **Ativo** significa que o nó será analisado e mostrado no SmartSense.

![popup de novo nó](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-8f8c2a2e861fa35b3ee5c2f7699d55c80b6b2de8%2FnewNode_ptbr.png?alt=media)

{% hint style="warning" %}
O **hostname** identifica o nó e deve ser único. Tentar criar um novo nó com o mesmo hostname de um nó já existente sobrescreverá o nó existente.
{% endhint %}

#### Detalhes do Nó

Clique em um item da Lista de Nós para abrir a tela de Detalhes do Nó, que mostra informações detalhadas sobre os serviços rodando naquele nó (aba de `Serviços`) e seus recursos de hardware (aba de `Recursos`). Nas duas abas, é possível atualizar as informações mostradas clicando no botão de atualização localizado no canto superior direito da tela.

**Aba de Serviços:**

A aba de `Serviços` mostra os serviços rodando no nó, com suas respectivas portas e seus status.

![aba de serviços](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-bdd2f1989e67fa21c82b81d362d82bfd90970e87%2FnodeDetailsServices_ptbr.png?alt=media)

**Aba de Recursos:**

A aba de `Recursos` mostra informações sobre o hardware do nó, como uso do disco, uso de memória RAM, taxa de transmissão, etc.

![aba de recursos](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-b876f75489aabf01b53503192942fc0f50904af7%2FnodeDetailsResources_ptbr.png?alt=media)

### Comparação entre Configurações

A tela de `Comparação entre Configurações` permite que o usuário selecione um arquivo de configuração e um nó de referência para comparar suas configurações com todos os outros nós. As configurações divergentes são mostradas em vermelho.

![tela de comparação entre configurações](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-d9355df1bb96321040501b8fc4759bf6adb58dc7%2FconfigurationComparison_ptbr.png?alt=media)

Para selecionar um arquivo de configuração, clique no menu *dropdown* e escolha um arquivo da lista.

![menu de seleção de arquivo de configuração](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-ad502416f4671fcebec2e19b2411fec0c8548618%2FconfigurationComparisonFile_ptbr.png?alt=media)

Em seguida, para selecionar um nó, clique no menu *dropdown* e escolha um nó da lista.

![menu de seleção de nós](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-4c4835bf9ab2b2860d83449bd571a32f15758028%2FconfigurationComparisonNode_ptbr.png?alt=media)

É possível remover linhas da tabela clicando no `X` localizado no lado esquerdo de cada linha. Essa opção simplesmente remove a linha da visualização, nenhum arquivo de configuração é modificado.

![botão de remover linha da visualização](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-8aef24b3b18656200c7fc5cad9743a1ceb53bce0%2FconfigurationComparisonDeleteRow_ptbr.png?alt=media)

Para restaurar a lista original com todas as linhas, marque a opção `Mostrar todas as linhas`.

![restaurar todas as linhas](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-f42992eae3be164be43adbeb3ff77a55b5206afd%2FconfigurationComparisonAllRows_ptbr.png?alt=media)

É possível filtrar os resultados e mostrar somente as colunas com nós que possuem configurações diferentes. Para fazer isso, marque a opção `Mostrar somente nós com diferenças`.

### Port Sweep

A tela de `Port Sweep` permite que o usuário selecione um IP e portas específicas para fazer um port sweep em todos os hosts e mostrar os resultados em uma tabela:

![tela de port sweep](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-be9d2f0105530018e06a61ce7ab748f844c34fde%2FportSweep_ptbr.png?alt=media)

Para selecionar um IP, clique no menu *dropdown* e escolha um endereço IP.

![port sweep lista de ips](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-2f9ab22a5f57d45b0ea87e563a746c88a0020c23%2FportSweepIPs_ptbr.png?alt=media)

As portas podem ser selecionadas como uma lista de portas separadas por vírgula (ex. `8000, 8080, 8125`); como um intervalo, com os limites superior e inferior separados por um hífen (ex. `8005-8015`); or como uma combinação de ambos (ex. `8005-8015, 8080`).

![port sweep seleção de portas](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-caf3d6a8aa263301456dec7ae985cc8c942995e5%2FportSweepPorts_ptbr.png?alt=media)

Depois de selecionar um IP e as portas, clique no botão Filtrar, localizado no canto superior direito da tela para realizar o port sweep.

### Histórico de Transações

A tela de `Histórico de Transações` mostra o uso em gráficos de barras (tipo histograma), criados com Kibana. Há cinco abas: `Identify`, `Identify (Latent)`, `Verify`, `Enroll` e `Update`. Em cada aba, é possível interagir com o gráfico, por exemplo, colocando o cursor sobre uma barra para mostrar o número de operações ou clicando e arrastando o cursor sobre algumas barras para dar zoom naquele intervalo. Na parte superior do gráfico, é possível adicionar filtros para personalizar a forma como as informações são mostradas.

![tela de histórico de transações](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-d0785e2f09e22b39a1c527f7a37dbfcc545c3414%2FtransactionHistory_ptbr.png?alt=media)

{% hint style="warning" %}
Para essa função, é preciso ter o ELK instalado e configurado corretamente. Além disso, é preciso ter os seguintes parâmetros em `config.properties`:

```properties
linkVerify=<link to Kibana dashboard>
linkIdentify=<link to Kibana dashboard>
linkIdentifyLatent=<link to Kibana dashboard>
linkEnroll=<link to Kibana dashboard>
linkUpdate=<link to Kibana dashboard>
```

{% endhint %}

### Fila

A tela de `Queue` mostra a fila atual de transações listada por prioridade.

![tela de fila](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-6cff90cd4eae947879aa7148a50b88bcf7020776%2FqueuePage.png?alt=media)

A lista é continuamente atualizada e o tempo de atualização pode ser ajustado usando o menu *dropdown* localizado no canto superior direito da tela:

![tela de fila - seleção de tempo de atualização](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-f7aa806e89df1fdb14d5ffd2ba6a82fcaa514133%2FqueueRefreshTime.png?alt=media)

É possível exibir a fila para o cluster inteiro ou para um nó referência. Para escolher um nó, clique no menu *dropdown* localizado no canto superior da tela e selecione um nó:

![tela de fila - seleção de nó de referência](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-a7994f120b5a11d59e56f23e20bdb28b00c262a1%2FqueueReferenceNode.png?alt=media)

### Lista de Transações

A tela de `Lista de Transações` mostra uma lista de transações processadas em um determinado período de tempo.

Ao abrir a página, serão exibidas as transações realizadas na última hora da data atual.

Para mostrar as transações realizadas em um intervalo de tempo diferente, selecione uma data, um tempo inicial e um tempo final. Em seguida, clique no botão Filtrar.

![tela de lista de transações](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-2d03fdf91a2d3edae3b820d0a8ec0aceaff09d43%2FtransactionsListPage.png?alt=media)

Também é possível filtrar as transações por PGUID, TGUID, label, chave e biográfico. Para isso, utilize o menu *dropdown* localizado no canto superior direito da tela para selecionar o tipo de filtro, preencha o campo *Valor* e clique no botão Filtrar.

Para obter informações detalhadas sobre uma transação, clique em um item da lista para mostrar a tela `Detalhes da transação`:

![tela de detalhes da transação](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-eb98ee0ee7f3e7de3a6e1d8937241228bafe3318%2FtransactionsDetails.png?alt=media)

É possível baixar os dados biométricos da transação. Para isso, clique no botão Download, localizado no canto superior direito da tela. O arquivo ZIP para download conterá as imagens das biometrias, bem como os templates.

Para mais informações sobre o status da transação, passe o mouse sobre *Ver detalhes* no lado direito da tela, na seção *Problemas*.

![tela de detalhes de transação - detalhes do status](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-b9522e296882070fce329013d51afc59155f1544%2FtransactionsDetailsSeeDetails.png?alt=media)

### Menu

No canto superior direito da tela, clique sobre o nome de usuário para acessar o menu:

![menu](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-791d8c39c586944b375a1ca29f1baef568840ab7%2Fmenu_ptbr.png?alt=media)

As opções disponíveis são:

* Configurações;
* Manual;
* Sair.

#### Configurações

Nesta tela, há opções para os usuários definirem suas preferências de uso:

![opções de configuração](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-1ed11085284f72ea757c039a9b8bb09afc75baac%2Fsettings_ptbr.png?alt=media)

* Tema: **claro** ou **escuro**;
* Idioma: **Português** ou **Inglês**;
* Formato de Data: **dd/mm/yyyy**, **mm/dd/yyyy**, ou **yyyy/mm/dd**;
* Formato de Hora: relógio de **12 horas (AM/PM)** ou de **24 horas**.

![tema claro ou escuro](https://35846584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7Bx0xNdsdGHpCZ20yxbn%2Fuploads%2Fgit-blob-1c30f720f8b0d686b971705343e8b02825b9e1ce%2Ftheme_ptbr.png?alt=media)
