So stellen Sie den APM-Java-Agent bereit:

1. Bevor Sie fortfahren, bestätigen Sie, dass Sie die Voraussetzungen erfüllt und den APM-Java-Agent bereitgestellt haben.
   Hinweis
   
   Beim Provisioning des APM-Java-Agent wird empfohlen, ihn an einem beliebigen Speicherort Ihres lokalen Rechners bereitzustellen und anschließend in ein Docker-Image zu kopieren.
2. Ändern Sie Dockerfile, um den APM-Java-Agent in ein Docker-Image zu kopieren:

   COPY <DESTINATION_DIRECTORY>/oracle-apm-agent <Docker_Image_Directory>/oracle-apm-agent/

   Beachten Sie, dass <DESTINATION_DIRECTORY> den Speicherort auf Ihrem lokalen Rechner angibt, an dem Sie den APM-Java-Agent durch Provisioning bereitgestellt haben, und <Docker_Image_Directory> das Verzeichnis im Docker-Image angibt, in das Sie den APM-Java-Agent kopieren. <Docker_Image_Directory> kann auch das Zielverzeichnis des Anwendungsservers in Docker sein, z.B. $DOMAIN_HOME, wenn Sie mit Oracle WebLogic Server arbeiten.

3. Fügen Sie dem Startskript des Anwendungsservers die folgende Option von -javaagent hinzu:

   java -javaagent:<Docker_Image_Directory>/oracle-apm-agent/bootstrap/ApmAgent.jar -jar target/<appserver.jar>

4. Erstellen Sie mit dem integrierten APM-Java-Agent und dem geänderten Startskript ein neues Docker-Image, und übertragen Sie das Image per Push in die Registry.

Wenn Sie Ihre Docker-Container mit Kubernetes verwalten, aktualisieren Sie die Kubernetes-Konfiguration so, dass das neue Docker-Image verwendet wird, und starten Sie den Kubernetes-Pod neu.

Außerdem können Sie mit der Downward-API weitere Dimensionen festlegen, die vom Kubernetes-Pod gemeldet werden sollen, indem Sie die folgenden Umgebungs- und Volume-Einstellungen in die Deployment-Spezifikation (yaml-Datei) des Kubernetes-Pods kopieren. Informationen zur Downward-API finden Sie unter The Downward API in der Kubernetes-Dokumentation.

Umgebungseinstellungen

spec:
  containers:
  - name: <container-name>
    image: image: <your-registry>/<your-docker-image>:latest
    env:
      - name: APM_ATTRIBUTES_K8S_POD_NAME
        valueFrom:
          fieldRef:
            fieldPath: metadata.name
      - name: APM_ATTRIBUTES_K8S_NAMESPACE_NAME
        valueFrom:
          fieldRef:
            fieldPath: metadata.namespace
      - name: APM_ATTRIBUTES_K8S_NODE_NAME
        valueFrom:
          fieldRef:
            fieldPath: spec.nodeName

Volume-Einstellungen

spec:
  containers:
  - name: <container-name>
    image: image: <your-registry>/<your-docker-image>:latest
    volumeMounts:
      - name: apm-attributes-k8s
        mountPath: /etc/apm-attributes-k8s
    volumes:
      - name: apm-attributes-k8s
        downwardAPI:
         items:
           - path: "labels"
             fieldRef:
               fieldPath: metadata.labels
           - path: "annotations"
             fieldRef:
               fieldPath: metadata.annotations

Voraussetzung: Installieren Sie den Operator OpenTelemetry im Kubernetes-Cluster.

Es stehen drei verschiedene Optionen zur Verfügung: Operatorreleasemanifest, Operator-Helm-Diagramm oder Operatorhub.

In den meisten Fällen sollte ein cert-manager installiert werden. Wenn die Helm-Diagrammoption verwendet wird, können Sie stattdessen ein selbstsigniertes Zertifikat generieren.

kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.2/cert-manager.yaml

Um den Operator OpenTelemetry zu installieren, führen Sie den folgenden Befehl aus:

kubectl apply -f https://github.com/open-telemetry/opentelemetry-operator/releases/latest/download/opentelemetry-operator.yaml

APM-Java-Agent bereitstellen

So stellen Sie den APM-Java-Agent bereit:

1. Erstellen Sie eine benutzerdefinierte Kubernetes-Ressource (CR).

   Um die automatische Instrumentierung zu verwalten, muss dem Operator OpenTelemetry Informationen zum APM-Java-Agent und seiner Konfiguration mit der Benutzerdefinierten Ressourcendefinition (CRD) bereitgestellt werden.

   Diese benutzerdefinierte Ressource wird vom Operator verwendet, um den Agent in den Pod zu kopieren und ihm die erforderliche Konfiguration hinzuzufügen.

   Um die CR zu erstellen, führen Sie den folgenden Befehl aus:

   kubectl apply -f - <<EOF
   apiVersion: opentelemetry.io/v1alpha1
   kind: Instrumentation
   metadata:
     name: inst-apm-java
     namespace: opentelemetry-operator-system
   spec:
     java:
       image: container-registry.oracle.com/oci_observability_management/oci-apm-java-agent:1.15.0.516
       env:
         - name: OTEL_com_oracle_apm_agent_data_upload_endpoint
           value: <data-upload-endpoint>
         - name: OTEL_com_oracle_apm_agent_private_data_key
           value: <private-data-key>
   EOF

   Dabei gilt:

   • <data-upload-endpoint> ist die Endpunkt-URL für den Datenimport, die beim Erstellen der APM-Domain generiert wird. Weitere Informationen finden Sie unter Datenimportendpunkt und Datenschlüssel abrufen.
   • <private-data-key> ist der private Datenschlüssel für die APM-Java-Agent-Installation, der beim Erstellen der APM-Domain generiert wird. Weitere Informationen finden Sie unter Datenimportendpunkt und Datenschlüssel abrufen.
   Die erstellte CR kann mit dem folgenden Befehl abgefragt werden:

   kubectl get otelinst -n opentelemetry-operator-system

   Alle Endpunkte und Umgebungsvariablen müssen korrekt sein, damit die automatische Instrumentierung ordnungsgemäß funktioniert.
2. Fügen Sie die Kubernetes-Annotation hinzu.

   Der Operator OpenTelemetry verwendet die Kubernetes-Annotation, um zu entscheiden, welche Pods automatisch mit dem APM-Java-Agent injiziert werden sollen.

   Die Anmerkung kann einem Namespace hinzugefügt werden. In diesem Fall werden alle Pods in diesem Namespace injiziert. Die Annotation kann auch einzelnen PodSpec-Objekten hinzugefügt werden, die als Teil von Deployment, Statefulset und anderen Ressourcen verfügbar sind.

   Anmerkung:

   instrumentation.opentelemetry.io/inject-java: "opentelemetry-operator-system/inst-apm-java"

   So beginnen Sie mit der Bearbeitung des Namespace:

   • Führen Sie den folgenden Befehl aus:

     kubectl edit namespace <your-namespace-name>

   • Bearbeiten Sie den Namespace, nachdem der Editor geöffnet wurde. Beispiel: der vi-Editor.
   • Fügen Sie die Anmerkung zum Namespace hinzu. Denken Sie daran, Einrückung ist sehr wichtig, um es als gültige YAML-Datei zu machen.
   Beispiel:

   apiVersion: v1
   kind: Namespace
   metadata:
     labels:
       kubernetes.io/metadata.name: mynamespace
     annotations:
       instrumentation.opentelemetry.io/inject-java: "opentelemetry-operator-system/inst-apm-java"
     name: mynamespace
   spec:

3. Starten Sie den Kubernetes-Pod neu.

   Um den Pod neu zu starten, in den Sie den APM-Java-Agent automatisch injizieren möchten, führen Sie den folgenden Befehl aus:

   kubectl delete pod <your-pod-name> -n <your-namespace-name>

4. Prüfen Sie den Kubernetes-Pod.
   Um zu prüfen, ob Ihr Pod nach dem Neustart automatisch mit dem APM-Java-Agent injiziert wurde, führen Sie den folgenden Befehl aus:

   kubectl get pod <your-pod-name> -n <your-namespace-name> -o yaml

Sie können jetzt zum nächsten Schritt gehen: APM-Java-Agent-Deployment prüfen.

So stellen Sie den APM-Java-Agent auf einem gemounteten Volume bereit:

1. Bestätigen Sie, dass Sie die Voraussetzungsaufgaben für APM-Java-Agent abgeschlossen haben.

   Notieren Sie sich den Datenuploadendpunkt und den Datenschlüssel beim Erstellen der APM-Domain.

2. Erstellen Sie ein neues Dateisystem, mit dem die Pods gemountet werden.

   Beim Erstellen des Dateisystems müssen Sie unbedingt dasselbe Compartment des virtuellen Cloud-Netzwerks (VCN) auswählen, das Kubernetes verwendet. Führen Sie dasselbe für das Subnetz-Compartment aus.

3. Mounten Sie das Dateisystem in den Pods.

   Dieser Schritt erfordert Änderungen an den entsprechenden YAML-Dateien.

   Erstellen Sie die PersistentVolume und zugehörige Entitys in Kubernetes mit der folgenden yaml-Datei. Beachten Sie die folgenden Felder, die Sie für Ihre Umgebung bearbeiten müssen: mntTargetId, server und path.

   kind: StorageClass
   apiVersion: storage.k8s.io/v1
   metadata:
     name: oci-fss
   provisioner: oracle.com/oci-fss
   parameters:
     mntTargetId: ocid1.mounttarget.oc1.iad.xxxxxxxxxxxxxxxxxxxxxx
   ---
   apiVersion: v1
   kind: PersistentVolume
   metadata:
    name: oke-fsspv
   spec:
    storageClassName: oci-fss
    capacity:
     storage: 10Gi
    accessModes:
     - ReadWriteMany
    mountOptions:
     - nosuid
    nfs:
   # Replace this with the IP of your FSS file system in OCI
     server: 10.0.10.39
   # Replace this with the Path of your FSS file system in OCI
     path: "/fss-for-kub"
     readOnly: false
   ---
   apiVersion: v1
   kind: PersistentVolumeClaim
   metadata:
    name: oke-fsspvc
   spec:
    storageClassName: oci-fss
    accessModes:
    - ReadWriteMany
    resources:
     requests:
    # Although storage is provided here it is not used for FSS file systems
       storage: 10Gi
    volumeName: oke-fsspv

   Um die Änderungen anzuwenden, führen Sie kubectl apply -f <filename.yaml> aus

   Aktualisieren Sie anschließend die yaml-Datei, mit der die Pods verwaltet werden, und fügen Sie den Volume- und Volume-Mount hinzu.

   Um wirksam zu werden, erstellen Sie die Pods neu.

4. Laden Sie die APM-Java-Agent-Datei herunter.

   Laden Sie die Datei herunter, und kopieren Sie sie auf das gemountete Volume.

   Anweisungen zum Herunterladen finden Sie unter APM-Java-Agent-Software herunterladen.

   Kopieren Sie es nach dem Herunterladen auf das gemountete Volume.

5. APM-Java-Agent durch Provisioning bereitstellen.

   Melden Sie sich bei einem der Container an, um den APM-Java Agent bereitzustellen, suchen Sie die JAR-Datei APM-java-agent-installer, und führen Sie Folgendes aus:

   java -jar ./apm-java-agent-installer-<version>.jar provision-agent -service-name=<Name of the Service> -destination=<Destination_Directory> -private-data-key=<Agent installation key generated during APM domain creation> -data-upload-endpoint=<dataUploadEndpoint URL generated during APM domain creation>

   Anweisungen zum Provisioning finden Sie unter APM-Java-Agent bereitstellen.

6. APM-Java-Agent durch Deployment bereitstellen.

   Stellen Sie den APM-Java-Agent bereit, indem Sie den Speicherort von oracle-APM-agent für den Microservice in der yaml-Datei angeben.

   Fügen Sie das Argument -javaagent und den Speicherort der JAR-Datei des APM-Agent zum java-Befehl jedes Microservice hinzu:

   java -javaagent:<Mounted Volume>/oracle-apm-agent/bootstrap/ApmAgent.jar

7. Starten Sie Kubernetes neu.

   Erstellen Sie die Pods neu, indem Sie kubectl apply -f <filename.yaml> ausführen.

   Sie können jetzt zum nächsten Schritt gehen: APM-Java-Agent-Deployment prüfen.