Uso da pilha de monitoramento

A pilha de monitoramento dos clusters do Automation Suite inclui o Prometheus, Grafana e AlertManager, que são integrados dentro da UI do Rancher Cluster Explorer.

Observação:

As falhas de nó podem ocasionar um desligamento do Kubernetes, o que interromperia os alertas do Prometheus. Para evitar isso, recomendamos configurar um alerta separado no servidor RKE2.

Esta página descreve uma série de cenários de monitoramento. Para obter mais detalhes, consulte a documentação do Rancher sobre o uso do Rancher Monitoring.

Importante:

Ao usar coletores para exportar métricas para ferramentas de terceiros, habilitar o monitoramento de aplicativos pode interromper a funcionalidade do Automation Suite.

Acessando as ferramentas de monitoramento

Visão geral

A pilha de monitoramento para clusters do Automation Suite inclui Prometheus, Grafana, Gerenciamento de Alertas e Painel Longhorn.

Esta página descreve uma série de cenários de monitoramento.

Para obter mais detalhes, consulte a documentação do Rancher sobre o uso do Rancher Monitoring.

Você pode acessar as ferramentas de monitoramento do Automation Suite individualmente usando os seguintes URLs:

Aplicativo	Ferramenta	URL	Exemplo
Métricas	Prometheus	https://monitoring.fqdn/metrics	https://monitoring.automationsuite.mycompany.com/metrics
Painel	Grafana	https://monitoring.fqdn/dashboard	https://monitoring.automationsuite.mycompany.com/dashboard
Gerenciamento de alertas	AlertManager	https://monitoring.fqdn/alertmanager	https://monitoring.automationsuite.mycompany.com/alertmanager
Armazenamento persistente de bloco	Painel Longhorn	https://monitoring.fqdn	https://monitoring.automationsutie.mycompany.com

Monitoring tool authentication

Para acessar as ferramentas de monitoramento pela primeira vez, faça login como administrador com as seguintes credenciais padrão:

• Nome de usuário: admin
• Senha: para recuperar a senha, execute o seguinte comando:

  kubectl get secrets/dex-static-credential -n uipath-auth -o "jsonpath={.data['password']}" | base64 -d

Dex authentication

To update the default password used for Dex authentication while accessing the monitoring tools, take the following steps.

Observação:

Dex is a basic authentication method that is layered over the monitoring tools. Therefore, updating the Dex password does not impact the passwords for the monitoring tools. In this scenario, the passwords for the monitoring tools remain the same as before.

1. Execute o seguinte comando substituindo newpassword por sua nova senha:

   password="newpassword"
   password=$(echo -n $password | base64)
   kubectl patch secret dex-static-credential -n uipath-auth --type='json' -p="[{'op': 'replace', 'path': '/data/password', 'value': '$password'}]"

2. Execute o seguinte comando, substituindo <cluster_config.json> pelo caminho para seu arquivo de configuração:

   /opt/UiPathAutomationSuite/UiPath_Installer/install-uipath.sh -i <cluster_config.json> -f -o output.json --accept-license-agreement

Verificando alertas atualmente sendo disparados

Para visualizar os alertas, navegue até o Prometheus usando https://monitoring.fqdn/metrics e clique na guia Alertas. Aqui, é possível visualizar todos os alertas configurados no Automation Suite.

Para visualizar os alertas ativos, filtre o status do alerta clicando na caixa de seleção Disparo e na caixa de seleção Mostrar anotações na parte superior. Aqui você pode visualizar todos os alertas disparados no momento e suas mensagens correspondentes.

Silenciamento dos alertas

Se os alertas forem muito ruidosos, você poderá silenciá-los. Para isso, siga as seguintes etapas:

1. Clique no bloco AlertManager no canto superior esquerdo do painel do Monitoring. A tela a seguir é exibida.
   
   

   

   
   
2. Encontre o alerta em questão e selecione Silenciar.
   
   

   

   
   
3. Preencha os detalhes de Criador e Comentário e clique em Criar. O alerta não deve mais ser mostrado no Painel de monitoramento ou ser relatado para qualquer um dos receptores configurados.

Configurando os alertas

Observação:

Você pode encontrar uipathctl na pasta de instalação do Automation Suite: .../UiPathAutomationSuite/UiPath_Installer/bin.

Antes de começar a configurar os alertas, certifique-se de habilitar o kubectl.

Adicionando uma nova configuração de e-mail

Para adicionar uma nova configuração de e-mail após uma instalação, execute o seguinte comando:

./uipathctl config alerts add-email \
  --name test \
  --to "[e-mail]" \
  --from "[e-mail]" \
  --smtp server.mycompany.com \
  --username admin \
  --password somesecret \
  --require-tls \
  --ca-file <path_to_ca_file> \
  --cert-file <path_to_cert_file> \
  --key-file <path_to_key_file> \
  --send-resolved

Bandeira	Description	Exemplo
name	O nome da configuração de e-mail	testconfig
to	O endereço de e-mail do destinatário	[e-mail]
from	O endereço de e-mail do usuário	[e-mail]
SMTP	URL do servidor SMTP ou endereço IP e número da porta	server.mycompany.com:567
username	Nome de usuário de autenticação	admin
password	Senha de autenticação	securepassword
require-tls	Sinalizador booleano que indica que o TLS está habilitado no servidor SMTP.	N/A
ca-file	Caminho do arquivo contendo o Certificado CA do servidor SMTP. Isso é opcional se a CA for privada.	./ca-file.crt
cert-file	Caminho do arquivo contendo o certificado do servidor SMTP. Isso é opcional se o certificado for privado.	./cert-file.crt
key-file	Caminho do arquivo contendo a chave privada do certificado do servidor SMTP. Isso é necessário se o certificado for privado.	./key-file.crt
send-resolved	Sinalizador booleano para enviar um e-mail assim que o alerta for resolvido.	N/A

Removendo uma configuração de e-mail

Para remover uma configuração de e-mail, você deve executar o seguinte comando. Certifique-se de inserir o nome da configuração de e-mail que deseja remover.

./uipathctl config alerts remove-email --name test

Atualizando uma configuração de e-mail

Para atualizar uma configuração de e-mail, você deve executar o seguinte comando. Certifique-se de inserir o nome da configuração de e-mail que deseja atualizar e os parâmetros opcionais adicionais a serem editados. Esses parâmetros são os mesmos para adicionar uma nova configuração de e-mail. Você pode inserir um ou mais sinalizadores ao mesmo tempo.

./uipathctl config alerts update-email --name test [additional_flags]

Acesso ao painel do Grafana

Para acessar os painéis do Grafana, você deve recuperar suas credenciais e usá-las para fazer login:

• Nome de usuário:

  kubectl -n cattle-monitoring-system get secrets/rancher-monitoring-grafana -o "jsonpath={.data.admin-user}" | base64 -d; echo

• Senha:

  kubectl -n cattle-monitoring-system get secrets/rancher-monitoring-grafana -o "jsonpath={.data.admin-password}" | base64 -d; echo

Monitoramento do service mesh

Você pode monitorar o Istio Service Mesh por meio dos seguintes painéis do Grafana: o Istio Mesh e o Istio Workload.

Painel do Istio Mesh

Esse painel mostra o volume geral de solicitações, assim como as taxas de erros 400 e 500 em todo o service mesh para o período de tempo selecionado. Os dados são exibidos no canto superior direito da janela. Consulte os quatro gráficos na parte superior para obter essas informações.

Ele também mostra a taxa de sucesso imediata no último minuto passado para cada serviço individual. Observe que uma taxa de sucesso de NaN indica que o serviço não está servindo tráfego no momento.

Painel do Istio Workload

Esse painel mostra as métricas de tráfego no intervalo de tempo selecionado no canto superior direito da janela.

Use os selectores na parte superior do painel para detalhar cargas de trabalho específicas. Um namespace de interesse específico é o uipath.

A seção superior mostra métricas gerais, a seção Cargas de trabalho de entrada separa o tráfego com base na origem e a seção Serviços de saída separa o tráfego com base no destino.

Monitoramento de volumes persistentes

Você pode monitorar volumes persistentes por meio do painel do Kubernetes/Volumes persistentes. Você pode rastrear o espaço livre e utilizado para cada volume.

Você também pode verificar o status de cada volume clicando no item Volumes persistentes dentro do menu Armazenamento do Cluster Explorer.

Monitoramento da utilização de hardware

Para verificar a utilização do hardware por nó, você pode usar o painel Nós. Há dados disponíveis sobre a CPU, memória, disco e rede.

Você pode monitorar a utilização do hardware para cargas de trabalho específicas usando o painel do Kubernetes/Compute Resources/Namespace (Workloads). Selecione o namespace uipath para obter os dados necessários.

Criação de um instantâneo visual compartilhável de um gráfico do Grafana

1. Clique na seta que aponta para baixo ao lado do título do gráfico e, em seguida, selecione Compartilhar.
2. Clique na guia Instantâneo e defina o Nome do instantâneo, Expiração e Tempo limite.
3. Clique em Publicar para snapshot.raintank.io.

Para obter mais detalhes, consulte a documentação do Grafana sobre painéis de compartilhamento.

Observação: esse instantâneo é visível na internet pública por qualquer pessoa com o link.

Criação de painéis persistentes personalizados do Grafana

Para obter detalhes sobre como criar painéis persistentes personalizados do Grafana, consulte a Documentação do Rancher.

Acesso do administrador ao Grafana

O acesso de administradores ao Grafana normalmente não é necessário nos clusters do Automation Suite, pois os painéis estão disponíveis para acesso de leitura por padrão para usuários anônimos, e a criação de painéis persistentes personalizados deve ser feita usando as instruções nativas vinculadas acima neste documento.

No entanto, o acesso de administradores ao Grafana é possível com as instruções abaixo.

O nome de usuário e senha padrão para o acesso de administradores do Grafana pode ser recuperado da seguinte forma:

kubectl get secret -n cattle-monitoring-system rancher-monitoring-grafana -o jsonpath='{.data.admin-user}' | base64 -d && echo
kubectl get secret -n cattle-monitoring-system rancher-monitoring-grafana -o jsonpath='{.data.admin-password}' | base64 -d && echo

Observe que nos clusters do Automation Suite de alta disponibilidade existem vários pods do Grafana para habilitar o acesso de leitura ininterrupto no caso de falha de nós, assim como um maior volume de consultas de leitura. Isso é incompatível com o acesso de administradores, porque os pods não compartilham o estado da sessão, e o login requer isso. Como solução alternativa, o número de réplicas do Grafana deve ser escalonado temporariamente como uma enquanto se desejar que o administrador tenha acesso. Consulte abaixo instruções sobre como dimensionar o número de réplicas do Grafana:

# scale down
kubectl scale -n cattle-monitoring-system deployment/rancher-monitoring-grafana --replicas=1
# scale up
kubectl scale -n cattle-monitoring-system deployment/rancher-monitoring-grafana --replicas=2

Consulta do Prometheus

No Painel do Monitoring, clique em Gráfico do Prometheus. Uma nova janela é exibida.

A documentação sobre as métricas disponíveis está aqui:

• https://github.com/prometheus/node\_exporter#enabled-by-default - Conecte-se para visualizar
• https://github.com/kubernetes/kube-state-metrics/tree/master/docs#exposed-metrics - Conecte-se para visualizar
• Consulta de métricas do Prometheus (Istio)

Criação de alertas personalizados

Você pode criar alertas personalizados usando uma consulta do Prometheus com uma expressão booleana.

1. Para fazê-lo, clique em Regras do Prometheus no menu Avançado do Painel de monitoramento.
2. Clique em Criar no canto superior direito da janela para criar um novo alerta, e siga a documentação do Rancher: PrometheusRules
3. Quando o alerta for acionado, ele deverá ser mostrado no Painel do Monitoring. Além disso, ele será roteado para qualquer um dos receptores configurados.

Monitoramento do status de recursos do Kubernetes

Para consultar o status dos pods, implantações, statefulsets etc., você pode usar a UI do Cluster Explorer. Essa é a mesma página de destino que foi acessada após se conectar ao endpoint do Rancher Server. A página inicial mostra um resumo, com detalhes específicos de cada tipo de recurso à esquerda. Observe o seletor do namespace na parte superior da página. O painel também pode ser substituído pela ferramenta Lens.

Exportação de métricas do Prometheus para um sistema externo

O Prometheus usa o recurso de gravação remota do Prometheus para coletar e exportar métricas do Prometheus para um sistema externo.

Observação: o UiPath® não é compatível nem mantém as integrações do endpoint de gravação remota. Entretanto, os endpoints são compatíveis com a instância do Prometheus entregue dentro do Automation Suite.

Para configurar o remote_write em um cluster do Automation Suite:

1. Conecte-se ao ArgoCD.
2. Clique em Aplicativos.
3. Navegue até o instalador de malha.
4. Abra o painel DETALHES DO APLICATIVO e desative a autocorreção.
5. Navegue até o aplicativo rancher-monitoring.
   
   

   

   
   
6. Abra o painel DETALHES DO APLICATIVO > guia MANIFESTO.
   
   

   

   
   
7. Clique em EDITAR e navegue até a seção valores > prometheus > prometheusSpec.
8. Adicione as configurações remoteWrite desejadas.
   Descubra as configurações disponíveis para a funcionalidade de gravação remota.

   
9. SALVE a nova configuração. O aplicativo Rancher Monitoring exibe OutOfSync até a nova configuração ser aplicada.
   Observação: o Prometheus não precisa ser reiniciado para aplicar as novas configurações de gravação remota.

   

   
   

   

   
   
10. Teste a integração de gravação remota desejada. Retorne à Etapa 8 para adicionar uma nova configuração.