Logo Grafana

O Grafana é uma plataforma líder de observabilidade para visualização de métricas. Ele permite que você crie painéis sob medida para exibir insights significativos dos fluxos de dados em tempo real do seu aplicativo.

O Grafana é um aplicativo nativo da nuvem que está pronto para ser lançado em provedores de infraestrutura populares, instalado em seu próprio hardware ou implantado como um contêiner autônomo. Neste guia, focaremos na última opção usando a imagem oficial do Grafana para iniciar uma instância que é executada no Docker.

Começando

A criação de contêiner Grafana mais simples é assim:

docker run -d --name=grafana -p 3000:3000 grafana/grafana

Você terá um novo servidor Grafana acessível na porta 3000. Visite http://localhost:3000 e entre como admin/admin.

Agora você pode começar a adicionar fontes de dados e painéis para criar suas visualizações. Pressione o botão “Adicionar sua primeira fonte de dados” na página inicial para conectar uma nova fonte; selecione o tipo de provedor na tela a seguir e preencha os dados para que o Grafana possa acessar seus dados.

Em seguida, retorne à página inicial e clique em “Criar seu primeiro painel”. Escolha seu tipo de visualização preferido e use o painel de consulta para selecionar as métricas apropriadas de seus dados. Quando terminar, sua nova visualização será exibida em seu painel.

Este procedimento demonstra com que facilidade você pode iniciar uma instância de teste Grafana descartável. A execução de um contêiner pronto para produção requer um pouco mais de reflexão. Aqui está uma abordagem mais completa que está melhor equipada para uso a longo prazo.

Selecionando uma variante de imagem

A Grafana usa um modelo de negócios de licença dupla. A edição de código aberto é publicada como grafana/grafana no Docker Hub, enquanto o Enterprise é grafana/grafana-enterprise. As instruções a seguir funcionarão com essas duas variantes de nível superior.

Várias versões do Grafana estão disponíveis, cada uma nos sabores Alpine ou Ubuntu. O Alpine deve ser preferido na maioria das situações de implantação: é mais fino e focado em fornecer um ambiente compatível com Grafana sem extras supérfluos.

O sistema operacional é selecionado anexando seu nome após a versão do Grafana em uma tag de imagem:

grafana/grafana:8.3.0-ubuntu

É sempre melhor fixar em uma versão específica para que você não receba alterações involuntárias à medida que novas atualizações são publicadas. Omitindo o nome do SO (grafana/grafana:8.3.0) fornecerá a variante Alpine da versão selecionada.

Criando um contêiner

O Grafana tem requisitos de implantação relativamente simples. Você precisa montar um volume do Docker para armazenar seus dados persistentes e vincular uma porta do host para poder acessar o serviço. As configurações podem ser fornecidas montando um arquivo de configuração no contêiner ou injetando variáveis ​​de ambiente.

docker run -d --name grafana -p 9000:3000 \
 -v grafana-data:/var/lib/grafana
 grafana/grafana:8.3.0

Este exemplo inicia um novo contêiner Grafana chamado grafana que escuta na porta 9000 em seu host Docker. A porta está vinculada a 3000 no contêiner, pois esse é o endereço de escuta padrão do Grafana.

Um volume do Docker chamado grafana-data é referenciado pelo -v bandeira. Está montado para /var/lib/grafana dentro do container, onde o Grafana armazena todos os seus dados gerados. A montagem de volume significa que o conteúdo do diretório será armazenado fora do contêiner, evitando a perda de dados quando o contêiner parar ou seu host reiniciar.

Configuração de injeção

Você pode substituir as chaves de configuração do Grafana definindo variáveis ​​de ambiente ao iniciar seu contêiner. Você pode alterar qualquer uma das chaves nos arquivos de configuração do formato INI do Grafana, colocando em maiúscula o nome da chave e prefixando GF_:

# INI file
 instance_name = my-grafana
 
 [security]
 admin_user = demo
 admin_password = grafana
 
 ---
 
 # Corresponding environment variables
 GF_DEFAULT_INSTANCE_NAME=my-grafana
 GF_SECURITY_ADMIN_USER=demo
 GF_SECURITY_ADMIN_PASSWORD=grafana

Certifique-se de incluir o implícito DEFAULT nome da seção quando você está alterando o valor de uma variável de nível superior no arquivo de configuração.

Depois de descobrir quais valores você deseja alterar, forneça as variáveis ​​de ambiente corretas com -e sinalizadores quando você inicia seu contêiner:

docker run -d --name grafana -p 9000:3000 \
 -e GF_DEFAULT_INSTANCE_NAME=my-grafana
 -e GF_SECURITY_ADMIN_USER=demo
 -e GF_SECURITY_ADMIN_PASSWORD=grafana
 -v grafana-data:/var/lib/grafana
 grafana/grafana:8.3.0

O Grafana também suporta configuração baseada em arquivo. Com esse mecanismo, o valor da variável de ambiente de destino se torna o caminho para um arquivo disponível dentro do contêiner. O Grafana obterá o valor real da configuração lendo o arquivo.

Para usar essa abordagem, modifique qualquer variável de ambiente com sufixo __FILE ao seu nome normal:

docker run -d --name grafana -p 9000:3000 \
 -e GF_DEFAULT_INSTANCE_NAME=my-grafana
 -e GF_SECURITY_ADMIN_USER=demo
 -e GF_SECURITY_ADMIN_PASSWORD__FILE=/run/secrets/password
 -v grafana-data:/var/lib/grafana
 grafana/grafana:8.3.0

Você pode adicionar o arquivo ao contêiner usando uma montagem de ligação (-v ./password.txt:/run/secrets/password) ou um sistema de gerenciamento de segredos dedicado, como o Docker Secrets. A configuração baseada em arquivo fornece uma maneira mais segura de injetar valores confidenciais que você prefere não expor como texto simples nos logs de trabalho de CI e no histórico do shell.

Substituindo o arquivo de configuração

Você sempre pode substituir o arquivo de configuração em disco do Grafana se estiver alterando muitos valores para que as variáveis ​​de ambiente sejam convenientes.

A imagem do Docker localiza este arquivo em /etc/grafana/grafana.ini. Você pode montar uma substituição para o caminho esperado usando uma montagem de ligação do Docker:

docker run -d --name grafana -p 9000:3000 \
 -v ./grafana.ini:/etc/grafana/grafana.ini
 -v grafana-data:/var/lib/grafana
 grafana/grafana:8.3.0

Usar um arquivo de configuração facilita a injeção de configurações mais complicadas. Você pode interpolar variáveis ​​para construir valores dinâmicos. Os arquivos de configuração também suportam comentários que permitem documentar suas intenções de ajudar futuros mantenedores.

Gerenciando plug-ins

Muitas instalações do Grafana requerem plugins que adicionam fontes de dados extras ou fornecem painéis de painel pré-construídos. A imagem do Docker inclui um utilitário auxiliar que permite adicionar plug-ins a um novo contêiner definindo uma variável de ambiente especial.

Veja como adicionar um plug-in oficial listado no catálogo do Grafana:

docker run -d --name grafana -p 9000:3000 \
 -e GF_INSTALL_PLUGINS=grafana-simple-json-datasource
 -v grafana-data:/var/lib/grafana
 grafana/grafana:8.3.0

O GF_INSTALL_PLUGINS A variável espera que uma lista separada por vírgulas de nomes de plug-ins seja instalada quando o contêiner for iniciado pela primeira vez. Os nomes serão passados ​​para o grafana-cli plugins install comando. Isso significa que você pode incluir expressões de versão, como grafana-simple-json-datasource 1.1.0e faça referência a plugins da comunidade por meio de seu URL:

docker run -d --name grafana -p 9000:3000 \
 -e GF_INSTALL_PLUGINS=https://example.com/grafana-plugin.zip
 -v grafana-data:/var/lib/grafana
 grafana/grafana:8.3.0

Criando uma imagem personalizada

Ativação manual de containers Grafana com configuração fornecida via docker run sinalizadores é repetitivo e propenso a erros. Construir sua própria imagem do Docker com suas modificações incluídas economiza tempo e centraliza as configurações quando vários membros da equipe precisam ser capazes de criar uma nova instância.

Você pode conseguir isso escrevendo um Dockerfile que estende o arquivo oficial grafana/grafana imagem. Isso lhe dá a oportunidade de copiar em um arquivo de configuração personalizado e definir quaisquer variáveis ​​de ambiente extras que você precisar.

FROM grafana/grafana:8.3.0
 
 # Add plugins
 ENV GF_INSTALL_PLUGINS=grafana-simple-json-datasource
 
 # Copy a config file from your working directory
 COPY grafana.ini /etc/grafana/grafana.ini

Use seu Dockerfile para construir sua nova imagem do Grafana:

docker build -t custom-grafana:latest .

Agora você pode iniciar uma instância de contêiner pré-configurada a partir de sua imagem:

docker run -d --name grafana -p 9000:3000 \
 -v grafana-data:/var/lib/grafana
 custom-grafana:latest

Essa abordagem é particularmente útil quando você fez modificações extensas em seu ambiente Grafana. Agora você pode reproduzir com confiabilidade sua configuração sempre que iniciar um contêiner. Isso também ajuda nas alterações de versão da sua instalação ao longo do tempo.

Uma desvantagem é a necessidade de reconstruir sua imagem quando as atualizações upstream do Grafana são publicadas. Você terá que puxar periodicamente grafana/grafana, docker build sua imagem, envie-a para um registro e, em seguida, puxe a nova versão em seu host do Docker. O estágio final é recriar seus contêineres em execução para que eles usem a imagem atualizada.

Resumo

O Docker simplifica a instalação e a configuração do Grafana, fornecendo um ambiente isolado no qual você pode hospedar sua plataforma de observabilidade. Você pode iniciar rapidamente novas instâncias do Grafana vinculando uma porta de host, montando um volume de dados e fornecendo valores de configuração por meio de variáveis ​​de ambiente. Mais tarde, você pode encapsular sua configuração em sua própria imagem reutilizável que se baseia na base oficial.

Uma vez instalado e funcionando, uma instalação Dockerized Grafana funciona como uma instalação normal. Você pode conectar fontes de dados, interagir com a API HTTP e configurar alertas apontando para a porta do host vinculada ao seu contêiner. Você também pode atribuir um nome de domínio à sua instância e configurar o HTTPS servindo-o por trás de um proxy reverso, como Apache ou Traefik.


Fonte Adicione ao Google Notícias