IDOT および OpenTelemetry プロジェクト

ターゲット環境に IDOT をインストールするには、以下の手順を実行してください：

1. お使いのアーキテクチャに適したインストーラーをダウンロードしてください：

   x86-64 または 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
    

   s390x または 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
    

   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

   注：Instana のUIには、システムのアーキテクチャを自動的に検出する簡易インストールスクリプト（instana-collector-installer-latest.sh）が用意されています。 UIスクリプトもアーキテクチャ固有のスクリプトも、同じコレクターをインストールします。

   Windows 用（ワンライナーによるダウンロードとインストール）

   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"

   Windows 用（MSIインストーラー）

   Windows 環境では、MSIインストーラーを推奨のインストール方法として使用してください。 MSIインストーラーは、対話型のGUIインストールをサポートし、 Windows サービスを自動的に登録するとともに、グループポリシーやSCCMなどのエンタープライズ展開ツールと連携します。

   詳細については、 「MSIインストーラーを使用した Windows への IDOT のインストール」 を参照してください。

   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>

   Kubernetes のインストールガイドライン（オペレーターおよび OpenShift OSのサポート情報を含む）の詳細については、 Kubernetes の「 Instana ディストリビューション版 OpenTelemetry Collectorのインストール」 を参照してください。

2. 以下のコマンドを使用して、インストール・スクリプトを実行する：

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

   インストールスクリプトを実行する際は、以下のパラメータを指定してください：

   • <INSTANA_OTEL_ENDPOINT_GRPC>: Instana に必要な gRPC エンドポイントを指定します。 この <ip_address>:<port> 形式を使用してください。
   • <INSTANA_KEY>: 認証に必要な Instana エージェントキーを指定します。
   • <INSTANA_OTEL_ENDPOINT_HTTP>: Instana のオプションの HTTP エンドポイントを指定します。 この <ip_address>:<port> 形式を使用してください。
   • <USE_SUPERVISOR_SERVICE>: 「 Instana 」スーパーバイザー・サービスが有効になっているかどうかを指定します。 デフォルト値はtrueです。 このパラメータを に設定 false すると、スーパーバイザー・サービスが無効になります。
   重要： インストーラーを実行するには、および INSTANA_KEYINSTANA_OTEL_ENDPOINT_GRPC パラメータが必須です。 これらのパラメータは、. install_path/collector/config/config.envディレクトリにあるファイル config.env で後から変更できます。 デフォルトのパスは. です /opt/instana/collector/config/config.env。 また、コレクターは通常、システムディレクトリへの書き込みやシステムレベルのサービスの設定を行う必要があるため、インストールにはルート権限が必要です。

「Supervisor Service」や「Collector Service」など、 OpenTelemetry の用語に関する詳細については、『 OpenTelemetry Collector Management 』のドキュメントを参照してください。

シェルレシーバーは、以下の設定オプションをサポートしています：

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)

リスト内の各コマンド commands は、以下のオプションに対応しています：

このレシーバーは、以下の解析モードに対応しています：

以下の例は、さまざまな設定オプションを示しています：

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"

以下の場合には、自動解析を使用してください：

• 単純な数値データや標準的な表形式のデータがあります。
• 正規表現の設定をせずに、すぐにセットアップしたい。
• すべての数値フィールドは指標として扱う必要があります。

以下の場合には、正規表現を用いた構文解析を使用してください：

• 識別子（PIDやシステム名など）と実際のメトリクスを区別する必要があります
• 出力形式が不規則または一定ではありません。
• フィールドの型や名前を明確に制御したい。
• カスタムフィールドの説明が必要です。

IDOT を使用する場合、 OTLP エクスポーターを設定して、デフォルトのオプションである Instana バックエンドにデータを送信するようにする必要があります。

デフォルトでは、 Instana バックエンドは自己署名証明書を使用します。 CAファイルを使用してコレクターを設定しない場合は、検証を無効にする必要があります。 そうしないと、 TLS のハンドシェイクが失敗します。

証明書検証を行わない設定例：

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>
 

スーパーバイザーの設定を確認してください。 正しいエンドポイントを指定し、自己署名証明書が正しく処理されるようにしてください。

あるいは、同じホスト上のローカル Instana エージェントを通じてデータを報告することもできます。 このオプションを使用するには、インストール時および設定ファイル内で特定の設定を行う必要があります。

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