Configurazione di OpenTelemetry per approfondimenti sulle applicazioni AEM

Scopri come collegare un ambiente AEM as a Cloud Service alla piattaforma di osservabilità compatibile con OpenTelemetry di tua scelta.

In articoli precedenti, hai imparato i concetti e i vantaggi dell’utilizzo di OpenTelemetry con AEM as a Cloud Service. In questo tutorial viene utilizzato il progetto di esempio WKND di AEM come applicazione di esempio e viene illustrato come esportare la telemetria distribuendo config/otel.yaml utilizzando una pipeline di configurazione Cloud Manager.

I passaggi di alto livello sono i seguenti:

Prerequisiti

Prima di iniziare, assicurati di disporre di:

Passaggio 1: ottenere l’endpoint di osservabilità e le credenziali

Nella piattaforma di osservabilità, individua il relativo endpoint di acquisizione OTLP/HTTPS e crea o recupera le credenziali di acquisizione appropriate. Per istruzioni, consulta la documentazione della piattaforma.

Non sei sicuro di quale piattaforma usare? Vedere Scegliere una piattaforma di osservabilità.

Questa esercitazione utilizza una piattaforma di osservabilità con hosting autonomo che supporta OTLP su HTTPS e richiede un token di autenticazione di base.

Passaggio 2: memorizzare le credenziali di osservabilità in Cloud Manager

Archivia le credenziali di acquisizione come variabile di ambiente segreta di Cloud Manager.

Il file config/otel.yaml fa riferimento a questo segreto come ${{secrets.OTEL_CUSTOMER_AUTH}}. Le credenziali non devono mai essere visualizzate nell’archivio AEM o nei registri della pipeline.

Passaggio 3: aggiungere la configurazione OpenTelemetry

Creare il file config/otel.yaml nell’archivio dei progetti AEM. La piattaforma con hosting autonomo in questo tutorial utilizza la seguente configurazione:

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

Le impostazioni chiave sono:

Esportazione di tracce ogni volta che l’integrazione è abilitata. Le metriche e i registri sono facoltativi. Esportano solo se impostato su true.

Ad esempio, vedi la seguente configurazione di esempio WKND:

Passaggio 4: distribuire la configurazione di OpenTelemetry

La pipeline convalida la configurazione prima di applicare le impostazioni di destinazione.

Passaggio 5: generare il traffico AEM

Al termine della pipeline, genera un’attività dell’applicazione:

Attendi alcuni minuti perché la telemetria raggiunga la piattaforma di osservabilità.

Passaggio 6: verificare la telemetria nella piattaforma di osservabilità

Apri la piattaforma di osservabilità e cerca la telemetria. I passaggi per individuare tracce, metriche e registri variano a seconda della piattaforma. Le schermate seguenti provengono da dashboard di Grafana based observability platform.

Trovare il servizio AEM

Cerca un nome di servizio AEM simile a:

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

Nella piattaforma self-hosted utilizzata in questo tutorial, la telemetria del servizio di pubblicazione viene visualizzata come segue:

Ispeziona tracce

Cerca gli intervalli di richieste HTTP in entrata che corrispondono alle richieste della pagina WKND. Apri una traccia e rivedi il nome della richiesta, la durata e le estensioni correlate.

Controllare le metriche

Poiché la configurazione imposta metrics: true, cercare le metriche JVM e HTTP come utilizzo della memoria, durata della raccolta di oggetti inattivi, conteggio dei thread e durata della richiesta HTTP.

Ispezionare i registri

Poiché la configurazione imposta logs: true, controllare la destinazione per i registri dell’applicazione AEM. L’integrazione esporta i registri a una soglia di gravità supportata (WARN o superiore), pertanto le visite di pagina ordinarie potrebbero non produrre voci di registro a tale livello.

Risoluzione di problemi

Se la pipeline di configurazione non riesce o la telemetria non viene visualizzata nella piattaforma di osservabilità, controlla i registri della pipeline e verifica quanto segue:

Se il problema persiste, contatta il supporto Adobe e fornisci l’ID del programma AEM, l’ID dell’ambiente, l’ID di esecuzione della pipeline di configurazione, il messaggio di errore esatto e i dettagli del provider di osservabilità. Non includere mai credenziali di autenticazione o valori segreti.

Per ulteriori esempi di configurazione e informazioni sulla risoluzione dei problemi, consulta la documentazione del prodotto OpenTelemetry.

Passaggi successivi

Hai configurato OpenTelemetry per AEM as a Cloud Service e verificato che la telemetria dall’applicazione di esempio WKND sia disponibile nella tua piattaforma di osservabilità.

Ora puoi utilizzare questa telemetria per analizzare richieste lente o in errore, monitorare le prestazioni JVM e HTTP e correlare i registri delle applicazioni con le tracce per comprendere meglio il comportamento delle applicazioni AEM.

Per estendere la telemetria per la logica specifica dell’applicazione, vedere Strumenti personalizzati con OpenTelemetry.

Per ulteriori informazioni sulle opzioni di configurazione, sui provider di osservabilità supportati e sui requisiti di rete, consulta la documentazione del prodotto OpenTelemetry.

Risorse aggiuntive