エージェントのインストール Linux

Linux にホストエージェントをインストールするには、要件に応じてさまざまな方法があります。 前提条件の確認、利用可能なすべてのインストール方法、および Linux へのホストエージェントのインストールについては、以下のセクションを参照してください。

エージェントのインストール方法の選択

以下のインストール・オプションのいずれかを選択し、関連するリンクをクリックして続行します:

  • オンライン環境 (ホストが Instana ホストエージェントリポジトリと通信できる環境) では、サポートされている Linux ディストリビューションでワンライナー インストール手法を使用して、ホストエージェントを自動的にインストールできます。 詳細については、 自動(ワンライナー)スクリプトによるエージェントのインストールを参照してください。

  • あるいは、オンラインまたはオフライン(エアギャップ)環境では、エージェントパッケージを手動でダウンロードし、パッケージを手動でインストールするか、リポジトリを作成してパッケージマネージャにパッケージのインストールを指示します。 詳細については、 パッケージマネージャまたは手動(DEB、RPM)によるエージェントのインストールを参照してください。

  • .tar ファイルからエージェントをインストールして実行することができます。

    .tar ファイルからエージェントをインストールして実行するには、ファイルをダウンロードして解凍し、エージェントを起動します。 詳細については、 .tar ファイルからのエージェントのインストールと実行を参照してください。

  • 実験的な目的で、非 root ユーザーとしてエージェントをインストールして実行することもできます。

    この方法はサポートが限られており、本番環境では推奨されない。

    非 root ユーザーとして Instana エージェントを実行するには、 .tar ファイルからエージェントをインストールします。 詳細については、 非 root ユーザーとしてのエージェントのインストールと実行を参照してください。

自動(ワンライナー)スクリプトによるエージェントのインストール

エージェント・ワンライナーは、 Linux - ベースのオペレーティング・システムにホスト・エージェントを自動的にインストールするために使用できる強力なスクリプトです。 ワンライナーを使用してホストエージェントをインストールするには、以下の手順を実行します:

注記: ワンライナーは以下の Linux ディストリビューションをサポートしています: Debian 派生 (apt パッケージマネージャー) Red Hat 派生 (yum パッケージマネージャー) SUSE 派生 (zypp パッケージマネージャー)
  1. Instana UI のホームページで、 データソースの設定をクリックします。 Instana エージェント] タブで、[ エージェントのインストール ] を選択します。

    Instana の新しいトライアルインスタンスを開始している場合、エージェントカタログが表示され、インストールするホストエージェントを選択するプロンプトが表示されます。

  2. エージェント展開カタログページで、 Linux - 自動インストール(ワンライナー) というタイルをクリックします。

  3. エージェントパッケージングモードを選択します。

    • パッケージング・セクションで、配備するエージェント・タイプ(Dynamic または Static )を選択します。 静的エージェントと動的エージェントの違いについては、 ホストエージェントの種類を参照してください。

    • Runtime セクションで、エージェントマシンで使用するランタイムを選択し、エージェント展開方法(Interactive または Silent )を選択します。

    スクリプトには、 エージェントキーと ホストエージェントエンドポイントがあらかじめ入力されています。

    オプションを変更すると、スクリプトのパラメータも更新される。

    例えば、 Dynamic パッケージングオプション、Azul Zulu 11 および Interactive ランタイムオプションでエージェントをインストールするために、UI は以下のスクリプトを提供します:

    curl -o setup_agent.sh https://setup.instana.io/agent && chmod 700 ./setup_agent.sh && sudo ./setup_agent.sh -a <your_agent_key> -d <your_agent_key> -t dynamic -e <host-agent-endpoint>
     
  4. ホストエージェントをサービスとしてインストールして起動する場合は、 Install and start as service (only supported for SystemD-based systems) を選択します。 そして、 -s パラメーターがスクリプトに追加される。

    注: このオプションはsystemdベースのシステムでのみサポートされている。
  5. ホストエージェントをインストールするマシンにスクリプトをコピーし、スクリプトを実行してホストエージェントをインストールします。

    スクリプトを実行する前に、より多くのオプションのために他のパラメータを追加することができます。 使用可能なパラメータについては、 ワンライナーのスクリプト・パラメータを参照のこと。

    Instana ホストエージェントをインストールするには、root ユーザー権限が必要です。

これでホストエージェントがインストールされた。 View Deployed Agents をクリックして、インフラストラクチャマップ上にエージェントを表示します。

インストール後にできることについては、「 次にすること 」のセクションをご覧ください。

注: Instana の公開システムパッケージリポジトリは、リポジトリファイルを作成することでシステムに追加されます。 このファイルは、Instana 認証リポジトリをマシンのインストールソースに追加します。

一行スクリプトのパラメータ

ワンライナー・スクリプトは以下のパラメーターを受け付ける:

パラメーター 説明
-a = (必須) エージェント・キー
-d = (オプション) Instanaのダウンロードキー。 セルフホスト (オンプレミス) の Instana デプロイメントを使用している場合、キーは Instana から提供されます。
-e = (必須) ホスト・エージェントのエンドポイント
-m = (オプション) Instana エージェントモード、 apm (デフォルト)、 infra、または aws を設定します。
-t = (オプション) エージェントのタイプ、 dynamic (デフォルト)または static
-j = (オプション) バンドルされた Java ランタイムとして Eclipse OpenJ9 11 を選択します。
-y = (オプション) 非インタラクティブなプロンプト。 対話型シェルなしでエージェントをインストールしたい場合に指定する。
-s = (オプション) instana-agent サービスを開始し、ブート時に開始できるようにする。 このオプションは、 systemd を実行しているシステムでのみ機能します。
-g = (オプション。-b を設定する場合に必要) ホスト エージェントの Git ベースの構成管理機能のリモート URL の仕様。
-b = (オプション。-g を設定する場合に必要) ホスト エージェントの Git ベースの構成管理機能を追跡するリモート ブランチの名前。
-u = (オプション。-p を設定する場合に必要) ホスト エージェントの Git ベースの構成管理機能に HTTP ベースのリモートを使用している場合の基本認証のユーザー名。
-p = (オプション) ホスト エージェントの Git ベースの構成管理機能に HTTP ベースのリモートを使用している場合の基本認証のパスワード。

パッケージマネージャまたは手動(DEB、RPM)によるエージェントのインストール

自動 (ワンライナー) スクリプトによるエージェントのインストールに加えて、Instana UI から DEB または RPM のエージェントパッケージをダウンロードすることもできます。 その後、パッケージマネージャーに指示してパッケージをインストールしてもらうか、手動でパッケージをインストールしてください。

エージェントと Instana がホストするエージェントリポジトリ間の通信が不可能または望ましくない場合、代わりにローカルミラーを使用できます。 Instana ホストエージェントがエージェントリポジトリをミラーとして使用するように設定したり、別のミラーを設定したり、エージェントリポジトリの場所を変更したりできます。

エージェントパッケージのダウンロード

注: セルフホストバックエンドを使用している場合、エージェントパッケージをダウンロードするには、バックエンドのバージョンが275でなければなりません。

Instana エージェントパッケージをダウンロードするには、次の手順を実行します:

  1. Instana UI のホームページで、 データソースの設定をクリックします。 Instana エージェント] タブで、[ エージェントのインストール ] を選択します。

    Instana の新しいトライアルインスタンスを開始している場合、エージェントカタログが表示され、インストールするホストエージェントを選択するプロンプトが表示されます。

  2. エージェント配置カタログページで、 Linux - Packages (DEB、RPM) タイルをクリックします。

  3. エージェントの設定を選択します。

    • パッケージング・セクションで、配備するエージェント・タイプ(Dynamic または Static )を選択します。 静的エージェントと動的エージェントの違いについては、 ホストエージェントの種類を参照してください。

    • ランタイムセクションでAzul Zulu 11 または Eclipse OpenJ9 11 ランタイムを選択します。

    • Mode セクションで、使用するパッケージモード(RPM または DEM )を選択します。

  4. Platform architecture セクションで、ホストエージェントをインストールする Linux マシンのアーキテクチャを選択します。

  5. ダウンロードアイコンをクリックして、ウェブブラウザからホストエージェントパッケージ(DEBまたはRPM)をダウンロードします。

注: インターネットに接続されていないオフライン(エアギャップ)環境では、 Artifactory から DEB または RPM 用のエージェントパッケージを直接ダウンロードできます。 最新のパッケージをダウンロードしてください。

これでエージェントパッケージがダウンロードされた。 次のセクションに進み、エージェントパッケージをインストールする。

エージェントパッケージのインストール

エージェントパッケージをインストールするようにパッケージマネージャに指示するか、エージェントパッケージを手動でインストールしてください。

パッケージマネージャを使用してエージェントパッケージをインストールするには、 Linux のディストリビューションに基づき、以下のいずれかの方法を使用します:

  • Debian derivatives (apt パッケージマネージャ)

    1. 以下のファイルを作成して、Instana エージェントパッケージ用のリソースを持つ apt パッケージマネージャーを準備します:

      # /etc/apt/sources.list.d/instana-agent.list
      deb [arch=amd64] https://packages.instana.io/agent generic main
       
      # /etc/apt/auth.conf.d/instana-packages.conf
      machine packages.instana.io
      login _
      password <your_agent_key>
       
      注: あるいは、 /etc/apt/sources.list.d/instana-agent.list の URL に認証をハードコードすることもできる。 しかし、この方法は軽度のセキュリティリスクを引き起こし、 apt 、Instana パッケージをインストールまたは更新するたびに警告が表示される。
    2. 以下のコマンドを実行して、Instana GPG キーを apt パッケージマネージャに追加する:

      wget -qO - https://packages.instana.io/Instana.gpg | sudo apt-key add -
       
  • RPM ベースのディストリビューション (yum パッケージマネージャ)

    1. 以下のコード・スニペットをyumソース(/etc/yum.repos.d/Instana-Agent.repo )にコピーする:

      [instana-agent]
      name=Instana
      baseurl=https://_:<your_agent_key>@packages.instana.io/agent/generic/x86_64
      enabled=1
      gpgcheck=1
      repo_gpgcheck=1
      gpgkey=https://packages.instana.io/Instana.gpg
      priority=5
      sslverify=1
       

      <your_agent_key>をあなたのエージェント・キーに置き換えてください。

    2. GPGパッケージの検証を有効にしたい場合、ディストリビューションによっては、あらかじめパッケージマネージャのキーリングにキーをインポートしておく必要があります。

      キーをインポートするには、以下のコマンドを実行する:

      rpm --import https://packages.instana.io/Instana.gpg
       
  • openSUSE/SLES (zypp パッケージマネージャ)

    openSUSE および SUSE Linux Enterprise Server の場合、パスは /etc/zypp/yum.repos.d/Instana-Agent.repo になりますが、中身は RPM ベースのディストリビューションと同じでかまいません。

これでエージェントパッケージがインストールされた。 パッケージマネージャーのソースをリフレッシュしたら、次のセクションに進んでください。

エージェントの準備

  1. ホスト・エージェントのエンドポイントとエージェント・キーを設定します。

    エンドポイント、ポート、およびエージェントのキー値を見つけるには、Instana UI のホーム ページに移動し、[ エージェントの展開 ] をクリックします。 エージェント展開カタログページで、 Linux - 自動インストール(ワンライナー) というタイルをクリックします。 その後、展開スクリプトでエンドポイント、ポート、およびエージェントのキー値を確認できます。

    次のスクリプト例を参照:

    curl -o setup_agent.sh https://setup.instana.io/agent && chmod 700 ./setup_agent.sh && sudo ./setup_agent.sh -a aGeNTKEY0vaLuO0Eu1ABc -d n3asffgkg -t dynamic -e ingress-green-saas.instana.io:443  
     
  2. ホストエージェントをインストールする前に、環境変数を設定してください。

    export INSTANA_AGENT_KEY=$agentkey
    export INSTANA_AGENT_ENDPOINT=$endpoint
    export INSTANA_AGENT_ENDPOINT_PORT=$endpoint_port
     
    注: エージェントのコンフィギュレーションのための環境変数 INSTANA_AGENT_HOSTINSTANA_AGENT_PORT の使用は、非推奨である。 これらの環境変数は、Instana トレーサがエージェントに接続するように設定するために予約されています。 グローバルに設定されている場合、Instana トレーサはエージェントに接続できません。 これらの環境変数を使用してエージェントを設定するサポートは、Instana の将来のバージョンでは削除されます。

    環境変数を設定するためのオプションのまとめ:

    • Git -ベースのコンフィギュレーション管理である:環境変数をファイルに置くのは良い方法だ。 詳細については、 Git ベースの構成管理」 を参照してください。

    • Systemd: ドロップインは、サービスの環境仕様を上書きする最も簡単な方法だ。

    • SysVinit: ファイルを /etc/sysconfig ( Red Hat 派生) または /etc/default ( Debian 派生) のいずれかに置く。

    環境変数のオプションの詳細については、 環境変数の設定とオーバーライドを参照してください。

これでエージェントインストールの準備作業は完了です。 エージェントをインストールするセクションに進んでください。

エージェントのインストール

パッケージ・マネージャのソースを更新し、以下のコマンドのいずれかを実行して、選択したアーキテクチャにエージェントをインストールする:

  • Debian 派生ディストリビューション

    • 静的エージェントをインストールするには、以下のコマンドを実行する:

      apt-get install instana-agent-static
       
    • ダイナミック・エージェントをインストールするには、以下のコマンドを実行する:

      apt-get install instana-agent-dynamic
       
  • Red Hat デリバティブ

    • 静的エージェントをインストールするには、以下のコマンドを実行する:

      yum install instana-agent-static
       
    • ダイナミック・エージェントをインストールするには、以下のコマンドを実行する:

      yum install instana-agent-dynamic
       
  • Eclipse OpenJ9 11 バンドル・パッケージ

    ホスト・エージェントは、以下のパッケージ名のいずれかを使用してインストールする: instana-agent-static-j9 または instana-agent-dynamic-j9

これでホストエージェントがインストールされた。 インストール後にできることについては、「 次にすること 」のセクションをご覧ください。

.tar ファイルからのエージェントのインストールと実行

.tar ファイルからエージェントをインストールして実行したい場合は、ファイルをダウンロードして解凍し、エージェントを起動します。

.tar ファイルには、 エージェントキーと ホストエージェントエンドポイントがあらかじめ入力されています。

.tar ファイルからエージェントをインストールする手順に従ってください:

  1. 前提条件のチェック
  2. エージェントのダウンロード
    • UIによるエージェントのダウンロード
    • wget によるエージェントのダウンロード
  3. エージェントの開始

前提条件のチェック

ホストエージェントをインストールする前に、以下の前提条件が満たされていることを確認してください:

  • 以下のオプションのいずれかを使用して、エージェントにJava開発キット(JDK)が利用可能でなければならない:

    • JDKを <instana-agent-install-dir>/jvm<instana-agent-install-dir>/jvm/bin/java が存在するように)に配置またはリンクする。

    • カスタマイズ可能な方法は、そのJDKを指すように環境変数 JAVA_HOMEをエクスポートすることである(この環境変数は instana-agent-install-dir>/bin/setenv に設定することもできる)。

    以下の JDK がエージェントの実行にサポートされています:

    JVMは、システム上のすべてのユーザーが実行可能でなければならない。 選択した Java ディストリビューションの最新の使用可能なパッチ・リリースを使用することをお勧めします。 エージェントには、 TLSv1.3 をサポートする JDK が必要である(現在のすべての JDK 11 ビルドで利用可能)。 お使いのOSのディストリビューションによっては、OSディストリビューターが提供するパッケージが、輸出規制のために強力な暗号化サポートを含んでいない場合があります。 このようなパッケージを使うと、 java.lang.RuntimeException: Could not generate DH key pair のようなエラーが出るかもしれません。

  • ファイルシステムの変更時にエージェントが使用するリソースを削減するには、 Linux ディストリビューションに inotify-tools パッケージをインストールする必要があります。

  • エージェントを実行するために使用されるユーザが、エージェントディレクトリとそのすべてのサブディレクトリに書き込めることを確認する。 エージェントは、自動検出に従って必要なセンサーをダウンロードし、 data サブディレクトリにログファイルを作成します。

  • 使用可能なディスク容量が100MB程度あることを確認してください。

  • エージェントは以下のホストからアップデートとセンサーをダウンロードする。 以下のホストとポートにアクセスできることを確認する:

    • DNS名artifact-public.instana.io
    • デスティネーション・ポートtcp/80 tcp/443
  • 現在、インスタナ・サービスは2つの異なる地域で提供されている。 個々のインスタンスは、ほとんどのエージェントとユーザーに地理的に最も近い場所に配置されます。 エージェントはダウンロード時にあらかじめ設定されていますが、インストール方法によっては Instana バックエンドの設定が必要です。 インスタンスが配置されている地域については、製品内のエージェント管理セクションまたは IBM の技術担当者にお問い合わせください。

  • セルフホスト (オンプレミス) の Instana を使用している場合は、Instana バックエンドのインストール時に定義されたエンドポイントを使用します。 また、Instana UI でエージェントが報告するエンドポイントを確認することもできます。 Instana UI のホームページで、 データソースの設定をクリックします。 Instana エージェント] タブで [ エージェントのインストール ] を選択し、デプロイメント コードまたは YAML 設定を確認します。

  • Instana SaaS, を使用している場合は、 ホストエージェントエンドポイントで説明されているエンドポイントを使用します。

エージェントのダウンロード

ホストエージェントは、以下のいずれかの方法でダウンロードできます:

  • Instana UI から以下の手順でエージェントをダウンロードします

    1. Instana UI のホームページで、 データソースの設定をクリックします。 Instana エージェント] タブで、[ エージェントのインストール ] を選択します。

      Instana の新しいトライアルインスタンスを開始している場合、エージェントカタログが表示され、インストールするホストエージェントを選択するプロンプトが表示されます。

    2. エージェント配置カタログページで、 Linux - Archive ( tar.gz ) タイルをクリックします。

    3. パッケージング・セクションで、配備するエージェント・タイプ(Dynamic または Static )を選択します。 静的エージェントと動的エージェントの違いについては、 ホストエージェントの種類を参照してください。

    4. ドロップダウンリストで、プラットフォームアーキテクチャ(オペレーティングシステム)を選択します。

      アーカイブファイルは、Instana アカウントの設定で自動的に事前設定されるため、エージェントを展開して起動するだけです。

    5. ダウンロードアイコンをクリックして、ウェブブラウザからホストエージェントパッケージファイル( tar.gz )をダウンロードし、ファイルを解凍します。

  • 以下のコマンドを実行して、エージェントをwgetでダウンロードする:

    wget --save-cookies {{agent_folder_name}}/instana-cookies.txt --post-data 'email={{instana_username}}&password={{instana_password}}' https://{{instana_tenant_unit}}-{{instana_tenant}}.instana.io/auth/signIn
     
    wget --content-disposition --load-cookies {{agent_folder_name}}/instana-cookies.txt --post-data 'type=linux64' https://instana.io/ump/{{instana_tenant}}/{{instana_tenant_unit}}/agent/download -O {{opt_folder}}/{{name_of_agent_archive.tar.gz}}
     

これでホストエージェントがダウンロードされた。 次のセクションに進み、エージェントを開始する。

エージェントの開始

解凍したエージェント・パッケージ・ファイルをシステム全体でアクセス可能な場所に置き、rootユーザーとしてエージェントを実行する。

注意: 他のユーザーでホストエージェントを実行した場合、ホストエージェントの機能は制限されます。 というのも、パフォーマンスメトリクスの中には、ルートだけがサポートしているものがあるからだ。 Docker コンテナの監視は、 Docker ホスト・マシンの root のみが行える。 さらに、Java仮想マシン(JVM)をアタッチして監視できるのは、ルート・ユーザーまたはスタートアップ・ユーザーのみである。 ホスト・エージェントをrootとして実行できない場合は、エージェント・ユーザーが有効なシェルで sudoersにリストされていることを確認してください。

エージェントを始動するには、次のコマンドを実行します。

INSTANA_AGENT_FOLDER/bin/start
 

これでホスト・エージェントがインストールされ、起動した。 インストール後にできることについては、 次にすることを参照してください。

非 root ユーザーとしての Instana エージェントのインストールと実行

非 root ユーザとしてエージェントをインストールできるのは、 Linux 環境のみです。また、 サポートされる機能のセクションで説明されているように、選択されたセンサのみがサポートされます。 明確に言及されていないその他の機能やセンサーは動作するかもしれないが、本番環境では正式にサポートされていない。 一般的なトラブルシューティングの手順については、 エージェントがインストールされ、非 root ユーザーとして実行されるを参照してください。

非 root ユーザーとして Instana エージェントを実行するには、Instana エージェントの.tar ファイルを解凍し、エージェントを起動します。

Instana エージェントを RHEL 9 にインストールするには、次の手順を実行します:

注意: エージェントをインストールするホストマシンのオペレーティングシステムに応じて、コマンドを変更することができます。
  1. Instana エージェントの通常ユーザーを作成します:

    sudo adduser instana
     
  2. Java をインストールします。

  3. エージェントのダウンロード 」セクションの説明に従ってホスト・エージェントをダウンロードし、次のコマンドを実行してエージェント・アーカイブ・ファイルを展開します:

    tar -xvf <instana-agent-*>.gz
     

    ファイルを解凍すると、 instana-agent-* ディレクトリが表示されます。

  4. instana-agent-* ディレクトリの所有者を変更する:

    chown -R instana:instana /instana-agent
     
  5. INSTANA_AGENT ディレクトリに移動し、Instana エージェントを起動します:

    ./bin/start
     
  6. オプションエージェントのステータスを確認する:

    ./bin/status
     

これでホストエージェントがインストールされた。 インストール後にできることについては、 次にすることを参照してください。

サポートされている機能

非 root ユーザーとして実行される Instana エージェントは、以下の機能をサポートします:

Javaアタッチメント

JVM ベースのアプリケーションの場合、アタッチメントが機能するように、Instana エージェントが実行されているのと同じユーザーアカウントでターゲット JVM アプリケーションを実行する必要があります。

ホストセンサー

ホストセンサーがコマンド( sudoers ディレクトリ)にアクセスするには、 ファイルの sudo entry パーミッションが必要です。 readlink コマンド (/proc ディレクトリ) にアクセスするためのパーミッションが必要です。 詳しくは、 トラブルシューティングをご覧ください。

ACEセンサー

  • Instana エージェントを起動するユーザーで ACE プロセスを開始すると、自動検出を含め、すべてがうまく機能します。

  • ACE プロセスが別のユーザー (Instana エージェントを起動するユーザーではない) で起動された場合、環境変数は空文字を返します。 この場合、ACEセンサーはREST APIによるリモート・モニタリングとローカル・モニタリングをサポートする。 しかし、自動検出は機能しない。