Redis

A integração do Redis coleta métricas relacionadas ao desempenho e ao uso. As métricas de desempenho se concentram na capacidade da CPU, da memória e da rede, e as métricas de uso se concentram em chaves, comandos e replicação. A integração também coleta registros do Redis e os analisa em um payload JSON. Durante esse processo, os símbolos de papel e nível são transformados em um formato legível.

Para mais informações sobre o Redis, consulte a documentação do Redis.

Pré-requisitos

Para coletar a telemetria do Redis, instale o Agente de operações:

  • Para métricas, instale a versão 2.7.0 ou mais recente.
  • Para registros, instale a versão 2.5.0 ou mais recente.

Este receptor suporta a versão 6.2 do Redis.

Configurar o agente de operações para Redis

Seguindo o guia para Configurar o agente de operações, adicione os elementos necessários para coletar a telemetria das instâncias do Redis e reinicie o agente.

Exemplo de configuração

Os comandos a seguir criam a configuração para coletar e ingerir telemetria para o Redis e reinicia o agente de operações.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    redis:
      type: redis
  service:
    pipelines:
      redis:
        receivers:
        - redis
logging:
  receivers:
    redis:
      type: redis
  service:
    pipelines:
      redis:
        receivers:
        - redis
EOF

sudo service google-cloud-ops-agent restart
sleep 60

Configurar a coleta de registros

Para ingerir logs do Redis, crie um receptor para os logs produzidos pelo Redis e, em seguida, crie um pipeline para o novo receptor.

redisPara configurar um receptor para os registros , especifique os seguintes campos:

Campo Padrão Descrição
exclude_paths Uma lista de padrões de caminho do sistema de arquivos a serem excluídos do conjunto correspondente a include_paths.
include_paths [/var/log/redis/redis-server.log, /var/log/redis_6379.log, /var/log/redis/redis.log, /var/log/redis/default.log, /var/log/redis/redis_6379.log] Uma lista de caminhos do sistema de arquivos a serem lidos acompanhando cada arquivo. Um caractere curinga (*) pode ser usado nos caminhos. por exemplo, /var/log/redis/*.log.
record_log_file_path false Se definido como true, o caminho para o arquivo específico de que a gravação de registro foi recebida aparecerá na entrada de registro de saída como o valor do rótulo agent.googleapis.com/log_file_path. Ao usar um caractere curinga, apenas o caminho do arquivo de que o registro foi recebido é gravado.
type Este valor precisa ser redis.
wildcard_refresh_interval 60s O intervalo em que os caminhos de arquivos curinga no include_paths são atualizados. Dado como uma duração de tempo, por exemplo, 30s ou 2m. Essa propriedade pode ser útil com capacidades de registro altas em que os arquivos de registro são alternados mais rapidamente do que o intervalo padrão.

O que é registrado

O logName é derivado dos IDs do receptor especificados na configuração. Os campos detalhados dentro de LogEntry são os seguintes.

Os registros redis contêm os seguintes campos no LogEntry:

Campo Tipo Descrição
jsonPayload.level string Nível de entrada de registro
jsonPayload.message string Mensagem de registro, incluindo stacktrace detalhado, quando fornecido
jsonPayload.pid número O ID do processo que emite o registro
jsonPayload.role string Traduzido do caractere de papel do Redis (sentinel, RDB/AOF_writing_child, slave, master)
jsonPayload.roleChar string Caractere do papel do Redis (X, C, S, M)
severity string (LogSeverity) Nível de entrada de registro (traduzido).

Configurar a coleta de métricas

Para ingerir métricas do Redis, crie um receptor para as métricas produzidas pelo Redis e, em seguida, crie um pipeline para o novo receptor.

Esse receptor não aceita o uso de várias instâncias na configuração, por exemplo, para monitorar vários endpoints. Todas essas instâncias gravam na mesma série temporal, e o Cloud Monitoring não tem como diferenciá-las.

Para configurar um receptor para suas métricas do redis, especifique os campos a seguir:

Campo Padrão Descrição
address localhost:6379 O URL exposto pelo Redis.
ca_file Caminho para o certificado de CA. Como cliente, isso verifica o certificado do servidor. Se estiver vazio, o receptor usará a CA raiz do sistema.
cert_file Caminho para o certificado TLS a ser usado para conexões exigidas por mTLS.
collection_interval 60s Um valor de time.Duration, como 30s ou 5m.
insecure true Define se uma conexão TLS segura será ou não usada. Se definido como false, o TLS será ativado.
insecure_skip_verify false Define se é necessário pular a verificação do certificado. Se insecure for definido como true, o valor de insecure_skip_verify não será usado.
key_file Caminho para a chave TLS a ser usada para conexões exigidas por mTLS.
password A senha usada para se conectar ao servidor.
type Este valor precisa ser redis.

O que é monitorado?

A tabela a seguir fornece a lista de métricas que o agente de operações coleta da instância do Redis.

Tipo de métrica 
Tipo, tipo
Recursos monitorados		 Rótulos
workload.googleapis.com/redis.clients.blocked
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.clients.connected
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.clients.max_input_buffer
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.clients.max_output_buffer
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.commands.processed
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/redis.connections.received
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/redis.connections.rejected
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/redis.cpu.time
CUMULATIVE, DOUBLE
gce_instance 		state
workload.googleapis.com/redis.keys.evicted
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/redis.keys.expired
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/redis.keyspace.hits
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/redis.keyspace.misses
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/redis.latest_fork
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.memory.fragmentation_ratio
GAUGE, DOUBLE
gce_instance 		 
workload.googleapis.com/redis.memory.lua
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.memory.peak
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.memory.rss
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.memory.used
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.net.input
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/redis.net.output
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/redis.rdb.changes_since_last_save
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.replication.backlog_first_byte_offset
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.replication.offset
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/redis.slaves.connected
GAUGE, INT64
gce_instance 		 

Verificar a configuração

Nesta seção, descrevemos como verificar se você configurou corretamente o receptor do Redis. Pode levar um ou dois minutos para que o agente de operações comece a coletar telemetria.

Para verificar se os registros do Redis estão sendo enviados para o Cloud Logging, faça o seguinte:

  1. No console do Google Cloud, acesse a página do Análise de registros.

    Acessar a Análise de registros

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Geração de registros.

  2. Digite a consulta a seguir no Editor e clique em Executar consulta: 
    resource.type="gce_instance"
log_id("redis")

Para verificar se as métricas do Redis estão sendo enviadas para o Cloud Monitoring, faça o seguinte:

  1. No Console do Google Cloud, acesse a página do  Metrics Explorer:

    Acesse o Metrics explorer

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.

  2. Na barra de ferramentas do painel do criador de consultas, selecione o botão  MQL ou  PromQL.
  3. Verifique se MQL está selecionado na opção de ativar/desativar MQL. A alternância de idiomas está na mesma barra de ferramentas que permite formatar sua consulta.
  4. Digite a consulta a seguir no Editor e clique em Executar consulta: 
    fetch gce_instance
| metric 'workload.googleapis.com/redis.clients.max_input_buffer'
| every 1m

Ver painel

Para visualizar as métricas do Redis, é necessário ter um gráfico ou um painel configurado. A integração do Redis inclui um ou mais painéis para você. Todos os painéis são instalados automaticamente depois que você configura a integração e o Agente de operações começa a coletar dados de métricas.

Também é possível ver visualizações estáticas de painéis sem instalar a integração.

Para ver um painel instalado, faça o seguinte:

  1. No console do Google Cloud, acesse a página  Painéis:

    Ir para Painéis

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.

  2. Selecione a guia Lista de painéis e escolha a categoria Integrações.
  3. Clique no nome do painel que você quer visualizar.

Se você configurou uma integração, mas o painel não foi instalado, verifique se o agente de operações está em execução. Quando não há dados de métricas para um gráfico no painel, a instalação do painel falha. Depois que o Agente de operações começar a coletar métricas, o painel será instalado para você.

Para acessar uma visualização estática do painel, faça o seguinte:

  1. No console do Google Cloud, acesse a página  Integrações:

    Acessar Integrações

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.

  2. Clique no filtro de plataforma de implantação do Compute Engine.
  3. Localize a entrada do Redis e clique em Ver detalhes.
  4. Selecione a guia Painéis para uma visualização estática. Se o painel estiver instalado, navegue até ele clicando em Ver painel.

Para mais informações sobre painéis no Cloud Monitoring, consulte Painéis e gráficos.

Para mais informações sobre como usar a página Integrações, consulte Gerenciar integrações.

Instalar políticas de alertas

As políticas de alertas orientam o Cloud Monitoring a notificar você quando ocorrerem condições especificadas. A integração do Redis inclui uma ou mais políticas de alertas para você usar. É possível ver e instalar essas políticas de alertas na página Integrações no Monitoring.

Para visualizar e descrever as descrições de políticas de alertas disponíveis, faça o seguinte:

  1. No console do Google Cloud, acesse a página  Integrações:

    Acessar Integrações

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.

  2. Localize a entrada do Redis e clique em Ver detalhes.
  3. Selecione a guia Alertas. Essa guia apresenta descrições das políticas de alertas disponíveis e mostra uma interface para instalá-las.
  4. Instalar políticas de alertas. As políticas de alertas precisam saber para onde enviar as notificações de que o alerta foi acionado. Portanto, elas exigem informações para instalação. Para instalar políticas de alertas, faça o seguinte:
    1. Na lista de políticas de alertas disponíveis, selecione aquelas que você quer instalar.

    2. Na seção Configurar notificações, selecione um ou mais canais de notificação. Você pode desativar o uso dos canais de notificação, mas, se isso acontecer, as políticas de alertas vão ser disparadas silenciosamente. É possível verificar o status no Monitoring, mas não receber notificações.

      Para saber mais sobre canais de notificação, consulte Gerenciar canais de notificação.

    3. Clique em Criar políticas.

Para mais informações sobre políticas de alertas no Cloud Monitoring, consulte Introdução a alertas.

Para mais informações sobre como usar a página Integrações, consulte Gerenciar integrações.

A seguir

Para ver um tutorial sobre como usar o Ansible para instalar o agente de operações, configurar um aplicativo de terceiros e instalar um painel de amostra, consulte o vídeo Instalação do agente de operações para resolver problemas de aplicativos de terceiros.