Skip to main content
Skip to content

Migrando do collectd para o OpenTelemetry

Este guia descreve a migração de uma instância GitHub Enterprise Server de collectd para a pilha de métricas OpenTelemetry.

GitHub Enterprise Server está fazendo a transição da pilha de métricas do collectd para o OpenTelemetry. O Collectd foi descontinuado na versão 3.23, e a atualização para a versão 3.23 o desabilita.

Linha do tempo da migração

VersãoPadrão para novas instalaçõesComportamento ao atualizarNotes
3.18CollectdCollectdOpenTelemetry é opt-in.
3.19 a 3.20OpenTelemetryAs configurações de métricas existentes são preservadas.As instâncias que usam collectd podem optar por usar o OpenTelemetry.
3.21 a 3.22OpenTelemetryAtualizações de versões anteriores à 3.21 habilitam o OpenTelemetry e desabilitam o collectd. Atualizações da 3.21 ou posterior preservam as configurações de métricas existentes.O Collectd ainda pode ser habilitado novamente.
3.23 ou posteriorOpenTelemetryOpenTelemetry está habilitado e collectd está desabilitado.O Collectd foi descontinuado e não pode ser habilitado novamente.

Preparando-se para migrar

Antes de migrar, conclua as seguintes preparações:

  • Teste a migração em uma instância de homologação antes de aplicá-la na produção.
  • Identifique as integrações de monitoramento que dependem das métricas do collectd, como dashboards externos e alertas.
  • Se você planeja executar as duas pilhas de métricas durante um período de transição, examine as limitações em Executar as duas pilhas de métricas.

Migrando para OpenTelemetry

Você pode migrar manualmente para o OpenTelemetry em instâncias que executam as versões 3.18 para 3.22. Se sua instância ainda usar a coleta, recomendamos migrar antes de atualizar para 3.21 ou posterior para que você possa verificar sua configuração de monitoramento com antecedência.

A atualização de uma versão anterior à 3.21 para a 3.21 ou 3.22 habilita automaticamente o OpenTelemetry e desabilita a coleta, mas você pode reabilitar a coleta após a atualização. A atualização para 3.23 ou posterior habilita o OpenTelemetry e desabilita permanentemente o collectd.

A migração requer habilitar as métricas do OpenTelemetry e desabilitar o collectd. Ambas as configurações estão disponíveis por meio de Console de Gerenciamento ou da linha de comando.

Usando o Console de Gerenciamento

  1. Em uma conta administrativa no GitHub Enterprise Server, no canto superior direito de qualquer página, clique em .

  2. Se você ainda não estiver na página "Administração do site", no canto superior esquerdo, clique em Administração do site.

  3. Na barra lateral " Site admin", clique em Console de Gerenciamento.

  4. Nas configurações de monitoramento, selecione Habilitar OpenTelemetry.

  5. Em Métricas - Collectd, selecione Desabilitar métricas do Collectd.

  6. Na barra lateral "Configurações", clique em Salvar configurações.

    Observação

    Se você salvar as configurações no Console de Gerenciamento, isso reiniciará os serviços do sistema, o que poderá resultar em tempo de inatividade visível pelo usuário.

  7. Aguarde a conclusão da execução de suas configurações.

Usando a linha de comando

  1. SSH em sua instância do GitHub Enterprise Server. Se sua instância for composta por vários nós, por exemplo, se a alta disponibilidade ou a replicação geográfica estiver configurada, efetue SSH no nó primário. Se você usar um cluster, poderá efetuar SSH em qualquer nó. Substitua HOSTNAME pelo nome do host da instância ou pelo nome do host ou endereço IP de um nó. Para saber mais, confira Acessar o shell administrativo (SSH).

    Shell
    ssh -p 122 admin@HOSTNAME
    
  2. Para habilitar as métricas do OpenTelemetry e desabilitar o collectd, execute os comandos a seguir.

    ghe-config observability.metrics.next-enabled true
    ghe-config observability.metrics.legacy-disabled true
    
  3. Para aplicar a configuração, execute o comando a seguir.

    Observação

    Durante uma execução de configuração, os serviços do sua instância do GitHub Enterprise Server podem ser reiniciados, o que pode causar um breve tempo de inatividade para os usuários.

    Shell
    ghe-config-apply
    
  4. Aguarde a conclusão da execução de suas configurações.

Executando as duas pilhas de métricas

Na versão 3.18 a 3.22, executar as pilhas collectd e OpenTelemetry ao mesmo tempo é possível, mas não é recomendado. Essa configuração tem as seguintes ressalvas:

  • Alguns nomes de métrica podem ser diferentes para permanecerem compatíveis com o formato do collectd.
  • Algumas métricas do OpenTelemetry não incluem rótulos.
  • Maior utilização de recursos para fornecer métricas para ambas as soluções.

O Collectd foi descontinuado na versão 3.23, portanto, a execução de ambas as pilhas não é possível após a atualização.

Verificações pós-atualização

Após a conclusão da execução da configuração, se você migrou manualmente ou uma atualização alternou sua instância para OpenTelemetry:

Exibindo dados históricos do collectd

Desde os patches 3.22.3, 3.21.8, 3.20.10 e 3.19.14, a guia Monitoramento inclui painéis do collectd para exibir dados históricos. Esses painéis exibem as métricas do collectd registradas até o momento em que a pilha do collectd foi desabilitada.