Usa APM Tracer in Helidon

Per utilizzare APM Tracer con Helidon, effettuare le operazioni riportate di seguito.

  1. Aggiungere APM Tracer al progetto Maven. Per i dettagli, vedere Aggiungi tracciante APM a progetto Maven.
  2. Controllare la versione Helidon e aggiungere la dipendenza corrispondente.

    Per Helidon 2, aggiungere la seguente dipendenza:

    <dependency>
        <groupId>com.oracle.apm.agent.java</groupId>
        <artifactId>apm-java-agent-helidon</artifactId>
        <version>[1.0.1389,)</version>
    </dependency>
    Per Helidon 3 SE, aggiungere la seguente dipendenza:
    <dependency>
        <groupId>io.helidon.tracing</groupId>
        <artifactId>helidon-tracing-opentracing</artifactId>
    </dependency>         
    <dependency>
        <groupId>com.oracle.apm.agent.java</groupId>
        <artifactId>apm-java-agent-helidon3</artifactId>
        <version>[1.8.3326,)</version>
    </dependency>
    Per Helidon 3 MP, aggiungere la seguente dipendenza:
    <dependency>
        <groupId>io.helidon.tracing</groupId>
        <artifactId>helidon-tracing-opentracing</artifactId>
    </dependency>         
    <dependency> 
        <groupId>io.helidon.microprofile.tracing</groupId> 
        <artifactId>helidon-microprofile-tracing</artifactId> 
    </dependency>
    <dependency>
        <groupId>com.oracle.apm.agent.java</groupId>
        <artifactId>apm-java-agent-helidon3</artifactId>
        <version>[1.8.3326,)</version>
    </dependency>
    Per Helidon 4 SE, aggiungere la seguente dipendenza:
    <dependency>
        <groupId>io.helidon.tracing</groupId>
        <artifactId>helidon-tracing-opentracing</artifactId>
    </dependency>
    <dependency>
        <groupId>io.helidon.tracing.providers</groupId>
        <artifactId>helidon-tracing-providers-opentracing</artifactId>
    </dependency>        
    <dependency>
        <groupId>com.oracle.apm.agent.java</groupId>
        <artifactId>apm-java-agent-helidon4</artifactId>
        <version>[1.15.0.516,)</version>
    </dependency>
    Nota

    Per Helidon 4, incluso Helidon 4 MP, vedere Supporto per Helidon 4.

  3. Configurazione per Helidon.

    APM Tracer utilizza le seguenti proprietà nel file di configurazione Helidon:

    Proprietà Valore predefinito Richiesto descrizione;
    nome   No Nome del tracciante. Questa proprietà non può essere nulla.
    servizio   Nome del servizio. Questa proprietà non può essere nulla.
    chiave dati privata   Chiave di caricamento dati APM necessaria per la comunicazione di Oracle APM Service Cloud.
    data-upload-endpoint   Endpoint di caricamento dati APM necessario per la comunicazione Oracle APM Service Cloud.
    canale daemon   No Il canale Daemon APM è una connessione socket tra Tracer e Daemon. Il formato di questo valore di proprietà è <host>:<port>.

    Quando il daemon viene avviato con questo set di proprietà, il daemon accetta la connessione socket e ascolta i dati su questo canale specificato.

    Quando Tracer viene avviato con questo set, l'endpoint di caricamento dati viene ignorato e i dati vengono inviati al daemon solo utilizzando questo canale socket.

    raccolta-metriche true No

    Raccoglie le metriche del server e genera report su OCI APM Service Cloud. L'impostazione predefinita è true.

    L'utente può accedere a tutte le metriche server raccolte dalla telemetria OCI.

    raccolta-risorse true No

    Raccoglie le risorse del server e genera report su OCI APM Service Cloud.

    Tutte le risorse raccolte vengono utilizzate come dimensione per la query sui dati.

    directory di log apm-tracer-log nella directory di lavoro JVM No Percorso completo della directory di log in cui vengono scritti tutti i log APM Tracer. Se questa opzione non è impostata, viene creata la directory di log predefinita (apm-tracer-log nella directory di lavoro della JVM.
    tag   No Tag statiche da includere in tutti gli intervalli di trace.
    proprietà   No

    Proprietà aggiuntive del tracciatore APM. Ciò consente di impostare le proprietà a livello di programmazione all'avvio di APM Tracer.

    Le proprietà vengono ignorate se una chiave o un valore è nullo.

    Esempi:
    • Helidon SE: è necessario specificarlo in formato YAML. Il nome predefinito è application.yaml. Vedere l'esempio che segue.
      tracing:
          service: "helidon-http"
          data-upload-endpoint: <data upload endpoint of your OCI domain>
          private-data-key: <privatedata key of your OCI domain>
          collect-metrics: true
          collect-resources: true
          log-directory: "/user/apm/log"
          tags:
              tag1: true
              tag2: 1234
              tag3: "hello"
          properties:
              com.oracle.apm.agent.logging.level: DEBUG
              com.oracle.apm.agent.key1: value123

      Quanto sopra utilizza il formato preferito per la sezione properties. È supportato anche il formato riportato di seguito.

      tracing:
          ...
          ...
          ...
          properties:
              - key: com.oracle.apm.agent.logging.level
                value: DEBUG
              - key: com.oracle.apm.agent.key1
                value: value123
    • Helidon MP: è necessario specificarlo nel formato PROPERTIES (chiave=valore). Il nome predefinito è microprofile-config.properties. Vedere l'esempio che segue.
      tracing.service=my-helidon-service
      tracing.data-upload-endpoint=<data upload endpoint of your OCI domain>
      tracing.private-data-key=<private data key of your OCI domain>
      tracing.collect-metrics=true
      tracing.collect-resources=true
      tracing.log-directory=/user/apm/log
      tracing.tags.tag1=true
      tracing.tags.tag2=1234
      tracing.tags.tag3=hello
      tracing.properties.com.oracle.apm.agent.data.upload.file=stdout
      tracing.properties.com.oracle.apm.agent.json.pretty=true
      Quanto sopra è il formato preferito per la sezione properties, ma supporta anche il seguente formato:
      tracing.service=my-helidon-service
      ...
      ...
      ...
      tracing.properties.0.key=com.oracle.apm.agent.data.upload.file
      tracing.properties.0.value=stdout
      tracing.properties.1.key=com.oracle.apm.agent.json.pretty
      tracing.properties.1.value=true
  4. Se si dispone di Helidon MP, saltare questo passaggio.

    Avviare e configurare il tracciatore di Helidon SE, ad esempio l'applicazione Main.java, effettuando le operazioni riportate di seguito.

    Tracer tracer = TracerBuilder.create(Config.create()).build();

    Quando si utilizza il codice precedente, è necessario assicurarsi che il parametro TracerBuilder venga aggiunto nel progetto Helidon. Creare un oggetto di configurazione e utilizzare lo stesso oggetto di configurazione per creare un oggetto TracerBuilder in Main.java.

    TracerBuilder sta avviando APM Tracer come tracciante opentracing e viene registrato in opentracing GlobalTracer.

Supporto opentelemetria per Helidon 4

Per le applicazioni Helidon 4, seguire le istruzioni elencate nella sezione Abilita OpenTelemetry in Agente APM di Configura agente Java APM per utilizzare OpenTelemetry.

Nota

Il supporto per l'ottimizzazione del supporto non è più valido per Helidon 4 MP. Se è necessario configurare il supporto per Opentelemetry, vedere Abilita OpenTelemetry in APM Agent da Configura APM Java Agent per utilizzare OpenTelemetry.