IDOT et le projet « OpenTelemetry »

Pour installer l' IDOT e dans votre environnement cible, procédez comme suit :

1. Téléchargez le programme d'installation adapté à votre architecture :

   Pour les systèmes d' x86-64 s ou amd64 :

   curl -Lo instana_otelcol_setup.sh https://github.com/instana/instana-otel-collector/releases/latest/download/instana-otel-collector-installer-latest-linux-amd64.sh
   chmod +x instana_otelcol_setup.sh
    

   Pour les systèmes d' s390x s ou zLinux :

   curl -Lo instana_otelcol_setup.sh https://github.com/instana/instana-otel-collector/releases/latest/download/instana-otel-collector-installer-latest-linux-s390x.sh
   chmod +x instana_otelcol_setup.sh
    

   Pour les systèmes d' AIX :

   curl -Lo instana_otelcol_setup.sh https://github.com/instana/instana-otel-collector/releases/latest/download/instana-otel-collector-installer-latest-aix-ppc64.sh
   chmod +x instana_otelcol_setup.sh

   Remarque : l'interface utilisateur d' Instana fournit un script d'installation simplifié (instana-collector-installer-latest.sh) qui détecte automatiquement l'architecture de votre système. Le script de l'interface utilisateur et les scripts spécifiques à l'architecture installent tous deux le même collecteur.

   Pour Windows (téléchargement et installation en une seule ligne)

   powershell -Command "Invoke-WebRequest -Uri 'https://github.com/instana/instana-otel-collector/releases/download/<latest-version>/instana-otel-collector-installer-latest-windows-amd64.zip' -OutFile '$env:TEMP\instana-collector.zip'; Expand-Archive -Path '$env:TEMP\instana-collector.zip' -DestinationPath 'C:\Program Files\Instana\' -Force; Set-Location 'C:\Program Files\Instana\instana-collector\bin'; .\setenv.bat -a <INSTANA_KEY> -e <INSTANA_OTEL_ENDPOINT_GRPC> -H <INSTANA_OTEL_ENDPOINT_HTTP>; .\start.bat"

   Pour « Windows » (installation MSI)

   Utilisez le programme d'installation MSI comme méthode d'installation recommandée pour les environnements d' Windows. Le programme d'installation MSI prend en charge l'installation interactive via une interface graphique, enregistre automatiquement un service d' Windows, et s'intègre aux outils de déploiement d'entreprise tels que Group Policy et SCCM.

   Pour plus d'informations, consultez la section « Installation d' IDOT sur Windows à l'aide du programme d'installation MSI ».

   Pour consulter le graphique « Kubernetes » Helm

   helm install instana-otel-collector \
     --repo https://instana.github.io/instana-otel-collector instana-otel-collector-chart \
     --namespace instana-otel-collector \
     --create-namespace \
     --set clusterName=<CLUSTER_NAME> \
     --set instanaEndpoint=<INSTANA_OTEL_ENDPOINT> \
     --set instanaKey=<INSTANA_KEY>

   Pour plus d'informations sur les instructions d'installation d' Kubernetes, y compris la prise en charge des systèmes d'exploitation pour l'opérateur et l' OpenShift, consultez la page « Installation de la distribution Instana d' OpenTelemetry Collector » sur Kubernetes.

2. Exécutez le script d'installation à l'aide de la commande suivante :

   sudo ./instana_otelcol_setup.sh -e <INSTANA_OTEL_ENDPOINT_GRPC> -a <INSTANA_KEY> [-H <INSTANA_OTEL_ENDPOINT_HTTP>] [-u USE_SUPERVISOR_SERVICE] [<install_path>]

   Utilisez les paramètres suivants avec le script d'installation :

   • <INSTANA_OTEL_ENDPOINT_GRPC>: Indique le point de terminaison requis de l' gRPC pour Instana. Utilisez le <ip_address>:<port> format.
   • <INSTANA_KEY>: Indique la clé de l'agent d' Instana s requise pour l'authentification.
   • <INSTANA_OTEL_ENDPOINT_HTTP>: Spécifie le point de terminaison facultatif HTTP pour Instana. Utilisez le <ip_address>:<port> format.
   • <USE_SUPERVISOR_SERVICE>: Indique si le service de supervision d' Instana est activé. La valeur par défaut est true. Définissez ce paramètre sur false pour désactiver le service de supervision.
   Important : les paramètres INSTANA_OTEL_ENDPOINT_GRPC INSTANA_KEY et sont obligatoires pour lancer le programme d'installation. Vous pouvez modifier ces paramètres ultérieurement dans le config.env fichier qui se trouve dans le répertoire install_path/collector/config/config.env. Le chemin par défaut est /opt/instana/collector/config/config.env. De plus, l'installation nécessite des droits d'administrateur, car le collecteur doit généralement écrire dans les répertoires système et configurer des services au niveau du système.

Pour plus d'informations sur la terminologie d' OpenTelemetry, notamment les services « Supervisor » et « Collector », consultez la documentation relative à la gestion des collecteurs d' OpenTelemetry.

Le récepteur shell prend en charge les options de configuration suivantes :

receivers:
  shell:
    collection_interval: 60s  # How often to execute commands (default: 60s)
    commands:
      - name: disk_usage       # Required: Unique identifier for this command
        command: df -h /       # Required: Shell command to execute
        shell: /bin/sh         # Optional: Shell to use (default: /bin/sh)
        args: []               # Optional: Additional arguments to pass to the shell
        timeout: 5s            # Optional: Maximum time the command can run
        metric_name: disk.usage # Required for metrics: Name for the metric
        log_name: disk_check   # Optional: Name for log records (defaults to metric_name)
        description: "Check disk usage" # Optional: Human-readable description
        labels:                # Optional: Additional key-value pairs as attributes
          filesystem: "root"
        output_type: both      # Optional: How to process output (metric, log, or both; default: metric)

Chaque commande de la commands liste prend en charge les options suivantes :

Le récepteur prend en charge les modes d'analyse suivants :

Les exemples suivants illustrent les différentes options de configuration :

receivers:
  shell:
    collection_interval: 30s
    commands:
      - name: cpu_temperature
        command: cat /sys/class/thermal/thermal_zone0/temp
        metric_name: system.cpu.temperature
        description: "CPU temperature in millidegrees Celsius"

receivers:
  shell:
    collection_interval: 60s
    commands:
      - name: memory_free
        command: free -m | grep Mem | awk '{print $4}'
        metric_name: system.memory.free
        description: "Free memory in MB"
        labels:
          unit: "MB"
        output_type: metric

      - name: disk_usage
        command: df -h / | grep / | awk '{print $5}' | sed 's/%//'
        metric_name: system.disk.usage
        description: "Root filesystem usage percentage"
        labels:
          filesystem: "root"
          unit: "percent"
        output_type: both

      - name: last_logins
        command: last -n 5
        log_name: system.logins
        description: "Last 5 system logins"
        output_type: log

receivers:
  shell:
    collection_interval: 60s
    commands:
      - name: system_metrics_auto
        command: hyptop -b -n 1 | awk 'BEGIN {printf "%-12s %-10s %-8s %-12s\n","system","cpucount","cpu%","memoryinGB"}$2 ~ /^[0-9]+$/ {printf "%-12s %-10s %-8s %-12s\n",$1,$2,$3,$5}'
        metric_name: system.metrics.shell.hypervisor
        description: "System CPU and Memory metrics"
        output_type: metric

receivers:
  shell:
    collection_interval: 60s
    commands:
      - name: system_metrics_regex
        command: hyptop -b -n 1 | awk 'BEGIN {printf "%-12s %-10s %-8s %-12s\n","system","cpucount","cpu%","memoryinGB"}$2 ~ /^[0-9]+$/ {printf "%-12s %-10s %-8s %-12s\n",$1,$2,$3,$5}'
        metric_name: system.metrics.shell.hypervisor
        description: "System CPU and Memory metrics"
        output_type: metric
        row_regex: '^\s*(\S+)\s+(\d+)\s+([\d.]+)\s+([\d.]+)\s*$'
        metric_names:
          - system
          - cpucount
          - cpu
          - memoryinGB
        descriptions:
          - System Name
          - CPU Count
          - CPU Usage Percentage
          - Memory Usage in GB
        field_types:
          - Attribute  # system is an identifier, not a metric
          - Gauge      # cpucount is a numeric metric
          - Gauge      # cpu is a numeric metric
          - Gauge      # memoryinGB is a numeric metric
        labels:
          source: "hyptop"

      - name: process_stats
        command: ps aux | grep myapp | awk '{print $2, $3, $4}'
        metric_name: process.metrics
        description: "Process CPU and Memory usage"
        output_type: metric
        row_regex: '^\s*(\d+)\s+([\d.]+)\s+([\d.]+)\s*$'
        metric_names:
          - pid
          - cpu_percent
          - mem_percent
        descriptions:
          - Process ID
          - CPU Usage Percentage
          - Memory Usage Percentage
        field_types:
          - Attribute  # PID is an identifier, not a gauge
          - Gauge      # CPU percentage is a metric
          - Gauge      # Memory percentage is a metric
        labels:
          app: "myapp"

Utilisez l'analyse automatique dans les cas suivants :

• Vous disposez de résultats numériques simples ou de données tabulaires standard.
• Vous souhaitez une installation rapide sans avoir à configurer d'expressions régulières.
• Tous les champs numériques doivent être considérés comme des indicateurs.

Utilisez l'analyse syntaxique basée sur les expressions régulières dans les cas suivants :

• Il faut faire la distinction entre les identifiants (tels que les PID ou les noms de système) et les métriques proprement dites
• Vos formats de sortie sont irréguliers ou variables.
• Vous souhaitez pouvoir contrôler explicitement les types et les noms des champs.
• Vous avez besoin de descriptions de champs personnalisées.

Pour utiliser l' IDOT, vous devez configurer l'exportateur OTLP afin qu'il envoie les données au backend Instana, qui est l'option par défaut.

Par défaut, le backend Instana utilise un certificat auto-signé. Si vous ne configurez pas le collecteur avec le fichier CA, vous devez désactiver la vérification. Sinon, la négociation de la connexion « TLS » échoue.

Exemple de configuration sans vérification du certificat :

exporters:
  otlp:
    endpoint: https://otlp-grpc.<base_domain>:443
    tls:
      insecure: false
      insecure_skip_verify: true
    headers:
      x-instana-key: <your_instana_key>
      x-instana-host: <your_instana_host>
 

Vérifiez la configuration du superviseur. Assurez-vous qu'il cible le bon terminal et qu'il gère correctement le certificat auto-signé.

Vous pouvez également transmettre les données via l'agent local d' Instana s sur le même hôte. Cette option nécessite une configuration spécifique lors de l'installation et dans les fichiers de configuration.

sudo ./instana_otelcol_setup.sh -e 127.0.0.1:4317 -a <INSTANA_KEY> -H http://127.0.0.1:4318 -o <INSTANA_OPAMP_ENDPOINT> -u true

INSTANA_OTEL_ENDPOINT_GRPC=http://127.0.0.1:4317
INSTANA_OTEL_ENDPOINT_HTTP=http://127.0.0.1:4318

INSTANA_OPAMP_ENDPOINT=wss://<opamp-endpoint-url>:443/v1/opamp

exporters:
  otlphttp:
    endpoint: http://127.0.0.1:4318
    tls:
      insecure: true