{"id":7194,"date":"2019-07-11T10:00:53","date_gmt":"2019-07-11T17:00:53","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=7194"},"modified":"2025-06-13T21:33:42","modified_gmt":"2025-06-14T04:33:42","slug":"monitoring-couchbase-sync-gateway-kubernetes-cluster-prometheus","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/pt\/monitoring-couchbase-sync-gateway-kubernetes-cluster-prometheus\/","title":{"rendered":"Monitoramento Prometheus do cluster Kubernetes do Couchbase Mobile"},"content":{"rendered":"

ATUALIZA\u00c7\u00c3O: A partir da vers\u00e3o 2.8, o Sync Gateway inclui suporte integrado ao exportador Prometheus<\/a>. As estat\u00edsticas s\u00e3o exportadas em formato compat\u00edvel com o Prometheus por meio do endpoint de m\u00e9tricas. Isso significa que n\u00e3o h\u00e1 mais a necessidade de ter um exportador separado. Leia a documenta\u00e7\u00e3o do Couchbase para obter mais detalhes sobre Monitoramento do Sync Gateway v2.8+ usando o novo ponto de extremidade<\/a>.<\/em><\/p>\n

O Couchbase Mobile 2.5<\/a> A vers\u00e3o introduziu uma extensa relat\u00f3rios de estat\u00edsticas<\/a> recursos no Gateway de sincroniza\u00e7\u00e3o<\/a>. As estat\u00edsticas fornecem informa\u00e7\u00f5es importantes sobre a integridade da implanta\u00e7\u00e3o do Couchbase Mobile e constituem uma parte integrante de qualquer implanta\u00e7\u00e3o.<\/p>\n

Este \u00e9 um guia passo a passo para usar o Prometeu<\/a> (monitoramento e alerta de c\u00f3digo aberto) com clusters do Sync Gateway em Kubernetes<\/a>. Usaremos Grafana<\/a> para visualizar as estat\u00edsticas.<\/p>\n

Costuma-se afirmar que o Prometheus e o Kubernetes compartilham um \"ancestralidade espiritual<\/em>\". Ambos os projetos s\u00e3o hospedados pelo Funda\u00e7\u00e3o para computa\u00e7\u00e3o nativa em nuvem<\/a>. Eles s\u00e3o orientados por objetivos de design comuns, o que torna o Prometheus muito adequado para monitorar implanta\u00e7\u00f5es do Kubernetes.<\/p>\n

Em uma postagem relacionada<\/a>Na publica\u00e7\u00e3o anterior, discutimos a configura\u00e7\u00e3o do monitoramento com o Prometheus em um cluster do Couchbase Mobile em um ambiente sem o Kubernetes. Se voc\u00ea acompanhou essa publica\u00e7\u00e3o, pode pular as se\u00e7\u00f5es iniciais e ir direto para a se\u00e7\u00e3o Arquitetura de implanta\u00e7\u00e3o<\/em> se\u00e7\u00e3o.<\/p>\n

Hist\u00f3rico<\/h2>\n

Relat\u00f3rio de estat\u00edsticas do gateway de sincroniza\u00e7\u00e3o<\/h3>\n

As estat\u00edsticas do Sync Gateway s\u00e3o relatadas no formato JSON e est\u00e3o dispon\u00edveis por meio do _expvar<\/a> por meio do Sync Gateway Administrador REST<\/a> interface.
\nEssas s\u00e3o as categorias de estat\u00edsticas que s\u00e3o relatadas.
\n\"\"<\/p>\n

Prometeu<\/h3>\n

Prometeu<\/a> \u00e9 uma plataforma de monitoramento e alerta de sistemas de c\u00f3digo aberto. Em seu n\u00facleo, Servidor Prometheus<\/strong> \u00e9 respons\u00e1vel por sondar os \"alvos do Prometheus\" para obter estat\u00edsticas e armazen\u00e1-las como dados de s\u00e9rie temporal. Os alvos do Prometheus s\u00e3o configurados estaticamente ou podem ser descobertos pelo Prometheus.<\/p>\n

Grafana<\/h3>\n

Grafana<\/a> \u00e9 uma plataforma de alerta e visualiza\u00e7\u00e3o de dados de c\u00f3digo aberto. Ela \u00e9 compat\u00edvel com o Prometheus como fonte de dados e pode ser usada para criar pain\u00e9is abrangentes.<\/p>\n

Apresentando o Prometheus Sync Gateway Exporter<\/h2>\n

Para que o Prometheus monitore o Sync Gateway, precisamos de um \"alvo do Prometheus\" correspondente ao Sync Gateway. Esse destino \u00e9 o Exportador do gateway de sincroniza\u00e7\u00e3o<\/strong>, aqui denominada \"o Exportador\". Em termos simples, o Exportador<\/a> \u00e9 respons\u00e1vel por exportar as estat\u00edsticas do Sync Gateway para as m\u00e9tricas do Prometheus.<\/p>\n

\"\"<\/figure>\n

Arquitetura de implanta\u00e7\u00e3o<\/h2>\n

Quando juntamos tudo isso, uma implanta\u00e7\u00e3o t\u00edpica se parece com o seguinte:<\/p>\n

\"\"<\/figure>\n

Ok... parece muito mais complexo do que realmente \u00e9. Na verdade, \u00e9 bastante simples:<\/p>\n

Cont\u00eainer do exportador do gateway de sincroniza\u00e7\u00e3o<\/strong><\/p>\n

Os cont\u00eaineres Exporter e Sync Gateway devem ser colocados no mesmo pod usando o padr\u00e3o sidecar<\/a>. A API REST do Sync Gateway Admin \u00e9, por padr\u00e3o, apenas exposto<\/a> no localhost. Essa configura\u00e7\u00e3o tamb\u00e9m \u00e9 altamente recomendada em ambientes de produ\u00e7\u00e3o. Como o exportador pesquisa a API de administra\u00e7\u00e3o do Sync Gateway para obter estat\u00edsticas, ele precisa estar no mesmo host\/n\u00f3 que o Sync Gateway.<\/p>\n

Al\u00e9m disso, as estat\u00edsticas do Sync Gateway s\u00e3o relatadas por n\u00f3. Portanto, em um cluster de dois ou mais n\u00f3s do Sync Gateway, cada n\u00f3 do Sync Gateway deve ter seu pr\u00f3prio exportador.<\/p>\n

Servi\u00e7o do exportador do gateway de sincroniza\u00e7\u00e3o<\/strong><\/p>\n

Os pods do Sync Gateway que cont\u00eam o Exporter devem ser expostos a outros servi\u00e7os no cluster. No Kubernetes, voc\u00ea faz isso por meio de um Servi\u00e7o de rede do Kubernetes<\/a>. O Sync Gateway Exporter Service exp\u00f5e os pods do Sync Gateway e o torna acess\u00edvel ao Prometheus Service.<\/p>\n

Operador do Prometheus<\/strong><\/p>\n

Pesquisa continuamente as estat\u00edsticas do exportador, que, por sua vez, pesquisa o ponto de extremidade REST do Sync Gateway. O servidor usa as regras definidas na se\u00e7\u00e3o rules.yaml<\/em> para enviar alertas para o Gerenciador de alertas<\/strong>. A maneira mais simples de implantar o Prometheus no cluster do Kubernetes \u00e9 usando o comando Operador do Prometheus<\/a>. O Prometheus Operator cuida da implanta\u00e7\u00e3o da pilha do Prometheus, incluindo o Gerenciador de alertas e o Grafana.
\nO Operador atua em v\u00e1rias Defini\u00e7\u00f5es de Recursos Personalizados (CRDs). A mais interessante \u00e9 a Monitor de servi\u00e7o<\/strong>. O Service Monitor \u00e9 respons\u00e1vel por definir como os servi\u00e7os devem ser monitorados. Nesse caso, os pods do Sync Gateway que s\u00e3o expostos por meio do Sync Gateway Exporter Service s\u00e3o monitorados.<\/p>\n

Grafana<\/strong><\/p>\n

O servi\u00e7o pesquisa as estat\u00edsticas do Prometheus Server e as representa graficamente em um painel baseado na Web que pode ser acessado por meio do navegador da Web. Para acessar o painel do Grafana de fora do cluster, voc\u00ea precisar\u00e1 usar o encaminhamento de porta. Voc\u00ea tamb\u00e9m pode exp\u00f4-lo usando o NodePort ou o equivalente no Kubernetes. Novamente, o Prometheus Operator deve cuidar da implanta\u00e7\u00e3o do mesmo.<\/p>\n

C\u00f3digo-fonte do exportador<\/h2>\n

O Sync Gateway Exporter \u00e9 de c\u00f3digo aberto couchbaselabs<\/em><\/a> e est\u00e1 dispon\u00edvel no GitHub. Ele \u00e9 compat\u00edvel com o Couchbase Sync Gateway 2.5+. Para isso, embora nos esforcemos para mant\u00ea-lo atualizado com a vers\u00e3o mais recente do Sync Gateway, n\u00e3o podemos garantir isso. A boa not\u00edcia \u00e9 que ele \u00e9 de c\u00f3digo aberto e inclui instru\u00e7\u00f5es sobre como voc\u00ea pode estend\u00ea-lo para suportar estat\u00edsticas adicionais<\/a>.<\/p>\n

Clone a fonte do Exporter do Github e atualize os subm\u00f3dulos relevantes. O reposit\u00f3rio inclui todos os yaml<\/em> arquivos de configura\u00e7\u00e3o que seriam usados para a implanta\u00e7\u00e3o.<\/p>\n

git clone https:\/\/github.com\/couchbaselabs\/couchbase-sync-gateway-exporter\r\n\r\ngit submodule update --init --rebase --remote --recursive<\/code><\/pre>\n
O yaml<\/em> Os arquivos de configura\u00e7\u00e3o mencionados nesta postagem est\u00e3o dispon\u00edveis na pasta \"kubernetes\".<\/p>\n
cd \/path\/to\/cloned\/exporter\/source\/kubernetes<\/code><\/pre>\n
Instala\u00e7\u00e3o<\/h2>\n
No restante da postagem, examinaremos as etapas para configurar o monitoramento em um cluster do Couchbase Mobile no cluster do Kubernetes. As instru\u00e7\u00f5es aqui contidas devem se aplicar a qualquer implanta\u00e7\u00e3o gerenciada do Kubernetes.<\/p>\n
Implanta\u00e7\u00e3o do cluster do Couchbase Server<\/h3>\n
Siga as instru\u00e7\u00f5es aqui<\/a> para implantar a vers\u00e3o mais recente do cluster do Couchbase Server usando o Couchbase Autonomous Operator.<\/p>\n
Implanta\u00e7\u00e3o do cluster do Sync Gateway<\/h3>\n
Siga as instru\u00e7\u00f5es aqui<\/a> para implantar um cluster do Sync Gateway no Kubernetes<\/p>\n
Implanta\u00e7\u00e3o do Prometheus e do Grafana<\/h3>\n
H\u00e1 v\u00e1rios op\u00e7\u00f5es<\/a> para implantar o Prometheus. De fato, a maioria dos servi\u00e7os gerenciados do Kubernetes pode ter op\u00e7\u00f5es
\nUma das op\u00e7\u00f5es mais simples \u00e9 implantar usando o Operador do Prometheus<\/a> usando Leme<\/a>.<\/p>\n
O gr\u00e1fico do Prometheus implantar\u00e1 toda a pilha de monitoramento, incluindo o servidor Prometheus, o Grafana, o Alert Manager etc.<\/p>\n
Instalando o Helm<\/h4>\n
Se voc\u00ea j\u00e1 tiver o Helm em execu\u00e7\u00e3o em seu cluster, pule esta etapa<\/p>\n
kubectl create serviceaccount --namespace kube-system tiller\r\n\r\nkubectl create clusterrolebinding tiller-cluster-admin --clusterrole=cluster-admin --serviceaccount=kube-system:tiller\r\nhelm init --service-account tiller --upgrade<\/code><\/pre>\n
Instalando o Prometheus<\/h4>\n
Instale o Prometheus Operator executando este comando na raiz do reposit\u00f3rio clonado.<\/p>\n