Erforderlich

Installieren Sie den Operator OpenTelemetry im Cluster K8s.

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

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

Option 1: Operator-Helm-Diagramm

Mit dieser Option wird der OpenTelemetry-Operator mit dem Helm-Diagramm installiert.

1. Helm-Diagramm-Repository hinzufügen.

   helm repo add open-telemetry https://open-telemetry.github.io/opentelemetry-helm-charts
   helm repo update

2. Erstellen Sie den Kubernetes-Namespace für den Operator OpenTelemetry.

   kubectl create namespace opentelemetry-operator-system

3. Installieren Sie den Operator OpenTelemetry.

   helm install opentelemetry-operator open-telemetry/opentelemetry-operator \
   --namespace opentelemetry-operator-system \
   --set "manager.collectorImage.repository=otel/opentelemetry-collector-k8s"\
   --set admissionWebhooks.certManager.enabled=false\
   --set admissionWebhooks.autoGenerateCert.enabled=true

Option 2: Operatorreleasemanifest

Mit dieser Option werden YAML-Dateien zum Installieren des OpenTelemetry-Operators verwendet.

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

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

APM-Dotnet-Agent durch Deployment bereitstellen

So stellen Sie den APM Dotnet-Agent bereit:

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

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

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

   Führen Sie den folgenden Befehl aus, um die CR in Ihrem Kubernetes-Cluster zu erstellen:

   kubectl apply -f - <<EOF
   apiVersion: opentelemetry.io/v1alpha1
   kind: Instrumentation
   metadata:
     name: inst-apm-dotnet
     namespace: opentelemetry-operator-system
   spec:
     dotnet:
       image: us-ashburn-1.ocir.io/idpyjkbcc9tk/apm-net-agent:latest
       env:
         - name: OTEL_EXPORTER_OTLP_ENDPOINT
           value: <data-upload-endpoint>/20200101/opentelemetry
         - name: OTEL_EXPORTER_OTLP_HEADERS
           value: "Authorization=dataKey <private-data-key>"
         - name: OTEL_LOGS_EXPORTER
           value: "none"
         - name: OTEL_DOTNET_AUTO_TRACES_ADDITIONAL_SOURCES
           value: "OpenTelemetry.ODP"
   EOF

   Dabei gilt:

   • <data-upload-endpoint> ist die Endpunkt-URL für den Datenupload, die beim Erstellen der APM-Domain generiert wird. Weitere Informationen finden Sie unter Datenuploadendpunkt und Datenschlüssel abrufen.
   • <private-data-key> ist der private Datenschlüssel für die APM-Dotnet-Agent-Installation, der beim Erstellen der APM-Domain generiert wird. Weitere Informationen finden Sie unter Datenuploadendpunkt 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 eine Kubernetes-Annotation, um zu entscheiden, welche Pods automatisch mit dem APM Dotnet-Agent injiziert werden sollen.

   Die Annotation 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 für x64 glibc:

   annotations:
     instrumentation.opentelemetry.io/inject-dotnet: opentelemetry-operator-system/inst-apm-dotnet

   Anmerkung für x64 musl:

   annotations:
     instrumentation.opentelemetry.io/inject-dotnet: opentelemetry-operator-system/inst-apm-dotnet
     instrumentation.opentelemetry.io/otel-dotnet-auto-runtime: linux-musl-x64

   So beginnen Sie mit der Bearbeitung Ihres Namespace:

   • Führen Sie den folgenden Befehl aus:

     kubectl edit namespace <your-namespace-name>

   • Nachdem Sie den obigen Befehl ausgeführt haben, bearbeiten Sie den Namespace, sobald der Editor geöffnet ist. Beispiel: Verwenden Sie den Editor vi.
   • Anmerkung zum Namespace hinzufügen. Denken Sie daran, Einrückung ist sehr wichtig, um es als gültige YAML-Datei zu machen.
   Nachfolgend finden Sie ein Beispiel für einen Namespace mit der hinzugefügten Anmerkung:

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

3. Starten Sie den Kubernetes-Pod neu.

   Um den Pod neu zu starten, in den Sie den APM Dotnet-Agent automatisch injizieren möchten, führen Sie Folgendes 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 Dotnet-Agent injiziert wurde, führen Sie Folgendes aus:

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

Sie können jetzt mit dem nächsten Schritt fortfahren: Deployment des APM-Dotnet-Agent prüfen.