Configurar OpenTelemetry para insights sobre aplicativos AEM

Saiba como conectar um ambiente do AEM as a Cloud Service à plataforma de observabilidade compatível do OpenTelemetry de sua escolha.

Em artigos anteriores, você aprendeu sobre os conceitos e benefícios de usar OpenTelemetry com AEM as a Cloud Service. Neste tutorial, usamos o projeto de amostra WKND do AEM como um aplicativo de exemplo e mostramos como exportar a telemetria implantando o config/otel.yaml usando um Pipeline de configuração do Cloud Manager.

As etapas de alto nível são:

Pré-requisitos

Antes de iniciar, verifique se você tem:

Etapa 1: Obter seu endpoint de observabilidade e credencial

Na sua plataforma de observabilidade, localize o ponto de extremidade de assimilação OTLP/HTTPS e crie ou recupere a credencial de assimilação apropriada. Consulte a documentação da plataforma para obter instruções.

Não tem certeza de qual plataforma usar? Consulte Escolher uma plataforma de observação.

Este tutorial usa uma plataforma de observabilidade auto-hospedada que oferece suporte a OTLP em HTTPS e requer um token de autenticação básico.

Etapa 2: armazenar a credencial de observabilidade no Cloud Manager

Armazene a credencial de assimilação como uma variável de ambiente secreta do Cloud Manager.

O arquivo config/otel.yaml faz referência a este segredo como ${{secrets.OTEL_CUSTOMER_AUTH}}. A credencial nunca deve aparecer no repositório do AEM ou nos logs de pipeline.

Etapa 3: adicionar configuração OpenTelemetry

No repositório de projetos do AEM, crie o arquivo config/otel.yaml. A plataforma auto-hospedada neste tutorial usa a seguinte configuração:

kind: "Otel"
version: "v1"
metadata:
  envTypes:
    - "dev"
    - "stage"
    - "prod"
data:
  enabled: true
  type: "generic"
  endpoint: "https://my-self-hosted-observability.adobe.net"
  authHeaderName: "Authorization"
  authHeaderValue: "${{secrets.OTEL_CUSTOMER_AUTH}}"
  metrics: true
  logs: true

As principais configurações são:

Rastreia a exportação sempre que a integração é habilitada. Métricas e logs são opcionais. Eles exportam somente quando definidos como true.

Por exemplo, consulte a seguinte configuração de amostra WKND:

Etapa 4: implantar a configuração OpenTelemetry

O pipeline valida a configuração antes de aplicar as configurações de destino.

Etapa 5: gerar tráfego do AEM

Depois que o pipeline for concluído, gere alguma atividade de aplicativo:

Aguarde alguns minutos para que a telemetria chegue à sua plataforma de observabilidade.

Etapa 6: verificar a telemetria na plataforma de observabilidade

Abra sua plataforma de observabilidade e procure a telemetria. As etapas para localizar rastreamentos, métricas e logs variam de acordo com a plataforma. As seguintes capturas de tela são de painéis da plataforma de observabilidade baseada em Grafana.

Encontrar o serviço AEM

Procurar um nome de serviço do AEM semelhante a:

cm-p<program>-e<environment>-aem-publish-<environment-type>

Na plataforma auto-hospedada usada neste tutorial, a telemetria do serviço de Publicação é exibida da seguinte maneira:

Inspecionar rastreamentos

Procure extensões de solicitação HTTP de entrada que correspondam às solicitações de sua página WKND. Abra um rastreamento e revise o nome da solicitação, a duração e os intervalos relacionados.

Inspecionar métricas

Como a configuração define metrics: true, procure métricas JVM e HTTP como uso de memória, duração da coleta de lixo, contagem de threads e duração da solicitação HTTP.

Inspecionar logs

Como os conjuntos de configurações logs: true, verifique se há logs de aplicativo do AEM no seu destino. A integração exporta logs em um limite de severidade com suporte (WARN ou superior), portanto, visitas de página comuns podem não produzir entradas de log nesse nível.

Resolução de problemas

Se o Pipeline de configuração falhar ou a telemetria não aparecer na sua plataforma de observabilidade, revise os logs do pipeline e verifique o seguinte:

Se o problema persistir, entre em contato com o Suporte da Adobe e forneça a ID do programa da AEM, a ID do ambiente, a ID de execução do pipeline de configuração, a mensagem de erro exata e os detalhes do provedor de observação. Nunca inclua credenciais de autenticação ou valores secretos.

Para obter exemplos de configuração adicionais e informações de solução de problemas, consulte a documentação do produto OpenTelemetry.

Próximas etapas

Você configurou o OpenTelemetry para o AEM as a Cloud Service e verificou que a telemetria do aplicativo de amostra WKND está disponível na sua plataforma de observabilidade.

Agora você pode usar essa telemetria para investigar solicitações lentas ou com falha, monitorar o desempenho de JVM e HTTP e correlacionar logs de aplicativos com rastreamentos para entender melhor o comportamento do aplicativo AEM.

Para estender a telemetria para a lógica específica do aplicativo, consulte Instrumentação personalizada com OpenTelemetry.

Para explorar opções de configuração adicionais, provedores de observação compatíveis e requisitos de rede, consulte a documentação do produto OpenTelemetry.

Recursos adicionais