Set up PSA in Docker Engine

You can set up PSA in the Docker engine using the automation script, which is available with the installation zip file. When you run the installation command, the script automatically builds the docker image and deploys PSA.

Supported Operating System

  • Linux (RHEL >=8, Amazon Linux, CentOS and Ubuntu)
  • macOS with Intel processor
  • Windows

    Note: Installing PSA using the automated script is not supported on Windows. To install PSA on Windows, see

    Deploy PSA Manually.

The following table illustrates the differences between installing PSA in Kubernetes and Docker:

KubernetesDocker

Heimdall and Ignite are deployed as pods on the existing Kubernetes cluster through Helm Charts.

Heimdall and Ignite are deployed as containers.

Heimdall creates Web Monitoring and API Monitoring measurement job pods through Kube APIs.Heimdall creates Web Monitoring and API Monitoring measurement job containers through Docker APIs.
When the measurement is ready, Heimdall deletes the job pods through the Kube APIs.When the measurement is ready, Heimdall deletes the job containers through the Docker APIs.

PSA インストールファイルのダウンロード

Splunk AppDynamicsPSA インストール zip ファイルを、Cisco AppDynamics ダウンロードセンターまたはベータアップロードツールからダウンロードします。このファイルには、sum-chrome-agent、sum-api-monitoring-agent、sum-heimdall、Helm チャート、および自動化スクリプトの Docker ファイルが含まれています。sum-chrome-agent、sum-api-monitoring-agent、および sum-heimdall のイメージをビルドする場合は、Docker がインストールされていることを確認します。インストールされていない場合は、ここから Docker をダウンロードしてインストールできます。

(オプション)プロキシサーバーの設定

プロキシサーバーを設定すると、すべてのドメインに適用されます。application-onprem.yaml ファイルにプロキシサーバーアドレスを指定して、プロキシサーバーを設定します。キーと値のペアの設定

プロキシサーバーからドメインをバイパスするには、次の手順を実行します。

  1. application-onprem.yaml ファイルを開きます。
  2. noProxy proxyConfig にドメイン URL を追加します。例:proxyServer : "*noProxy noProxy で指定するドメイン URL
    proxyConfig:
    apiMonitoringAgent:
    enabled: true
    proxyServer: <proxy-server-address>
    browserMonitoringAgent:
    enabled: true
    proxyServer: <proxy-server-address>
    heimdall:
    enabled: true
    proxyServer: <proxy-server-address>
    noProxy:
    enabled: true
    proxyServer: "<specify the domain URLs that you want to bypass separated by comma>"

    例:proxyServer: "*abc.com,*xyz1.com,*xyz2.com"

    noProxy で指定したドメイン URL は、プロキシサーバーにリダイレクトされません。[noProxy] フィールドに任意の数のドメインを追加できます。他のすべての指定されていないドメイン URL は、プロキシサーバーにリダイレクトされます。

Configure Proxy Server at a Job Level

You can configure a proxy server and a bypass list for a particular job. Any proxy server URL and bypass list configured at the agent level gets overridden by the proxy server URL and bypass list configured at the job level. Perform the following steps to configure a proxy server at the job level:
  1. Create or edit a Synthetic job.
  2. Select the Run a script option.
  3. Add the following details in the beginning the script:
    '''yml
    jobLevelProxyConfig:
      proxyServer: "<proxy-server-address>"
      bypassProxyList: "<list of URLs that you want to bypass, separated by semi-colon>"
    '''
    Example:
    '''yml
    jobLevelProxyConfig:
      proxyServer: "http://tinyproxy: tinyproxy.svc.cluster.local:8888"
      bypassProxyList: "*abc.com;*xyz1.com;*xyz2.com"
    '''
    
    pageUrl = "https://help.splunk.com/en"
    driver.get(pageUrl)
    assert "Splunk" in driver.title, "Title should contain Splunk"

Deploy PSA in Docker

  1. Unzip the PSA installation zip file.
  2. Run the following command to install PSA in a Docker engine:
    ./install_psa -e docker -v -u <Shepherd-URL> -a <EUM-account> -k <EUM-key> -c <location-code> -d <location-description> -t <location-name> -s <location-state> -o <location-country> -i <location-latitude> -g <location-longitude> -p <PSA-tag> -r <heimdall-replica-count> -z <agent-type> -m <chrome-agent_min/max-memory> -n <API-agent_min/max-memory> -x <chrome-agent_min/max-CPU> -y <API-agent_min/max-CPU> -w <heimdall_proxy_server>~<web_monitoring_proxy_server>~<api_monitoring_proxy_server> -B <bypass-proxy-domains> -q <ignite-persistence> -C true -A <serviceaccount-name> -U <userID> -G <groupID> -N <run_as_a_non-root_user> -F <file_system_groupID> -O <override_the_security_context>
    A sample installation command looks like this :
    ./install_psa -e docker -v -u <Shepherd-URL> -a <EUM-account> -k <EUM-key> -c DEL -d Delhi -t Delhi -s DEL -o India -i 28.70 -g 77.10 -p 23.5 -r 1 -z all -m 100Mi/500Mi -n 100Mi/100Mi -x 0.5/1.5 -y 0.1/0.1 -w http://testproxy-heimdall.net:3213~http://testproxy-chrome.net:3213~http://testproxy-api.net:3213 -B "www.test.com,*.appdynamics.com" -q true -C true -A serviceaccount-name -U 9001 -G 9001 -N true -F 9001 -O true
The following table describes the usage of the flags in the command. Asterisk (*) on the description denotes mandatory parameters.
FlagDescription
-e

*Environment

For example, Docker, Minikube, or Kubernetes.

-vDebug mode
-u

*Shepherd URL

For example, https://sum-shadow-master-shepherd.saas.appd-test.com/

See Shepherd URL.

-a

*EUM Account

For example, a ti-23-2-saas-nov2

-k

*EUM Key

For example, 2d35df4f-92f0-41a8-8709-db54eff7e56c

-c

*Location Code

For example, DEL NY

-d

*Location Description

For example, 'Delhi, 100001'

-t

*Location City

For example, Delhi

-s

*Location State

For example, CA

-o

*Location Country

For example, India, United States

-i

Location Latitude

For example, 28.70

-g

Location Longitude

For example, 77.10

-p

*PSA release tag

For example, 23.5

-rHeimdall replica count
-z

*Agent type

For example, web, api, or all

-m

*Minimum/Maximum memory in Mi/Gi for sum-chrome-agent
-n*Minimum/Maximum memory in Mi/Gi for sum-api-monitoring-agent
-x*Minimum/Maximum CPU for sum-chrome-agent
-y*Minimum/Maximum CPU for sum-api-monitoring-agent
-w

Specify the proxy servers for Heimdall, Web, and API monitoring, separated by a tilde(~).

-B

Specify the domain URLs that you want to bypass from the proxy server.

For example, "*abc.com,*xyz1.com,*xyz2.com"

-qSpecify true or false to enable or disable Ignite Persistence.
-CSpecify true to enable performance logs on the Chrome browser. The default value is false.
-A Specify the service account of the sum-chrome-agent and sum-api-monitoring-agent pod.
-USpecify the user ID that the sum-chrome-agent or sum-api-monitoring-agent container should run as.
-GSpecify the group ID that the sum-chrome-agent or sum-api-monitoring-agent container should run as.
-NSpecify if the sum-chrome-agent or sum-api-monitoring-agent container should run as a non-root user. The default value is true.
-FSpecify the file system group ID of the sum-chrome-agent or sum-api-monitoring-agent container.
-OSpecify true to override the security context for Web and API monitoring. The default value is false.

PSA のモニター

Heimdall コンテナと Ignite コンテナの CPU とメモリの使用率をモニターするには、次のコマンドを実行します。

./monitoring_psa

PSA の手動展開

以下の手順を実行します。

  1. エージェント Docker イメージをプルします。
    docker pull appdynamics/heimdall-psa
    docker pull appdynamics/chrome-agent-psa
    docker pull appdynamics/api-monitoring-agent-psa
  2. ./docker-psa/appdynamics に移動して、onprem.yaml ファイル内の次の詳細を更新します。
    • シェパード URL
    • EUM ログイン情報
    • 登録ロケーション
    • エージェントタグ

      以下は、onprem.yaml ファイルで編集する必要がある設定キーと値のペアです。

      Web モニタリング PSA:

      設定キー
      chromeAgent > image<agent-tag>
      shepherd > urlシェパード URL
      shepherd > credentialsログイン情報
      shepherd > locationagent location
      proxyConfig > enabled

      true

      このフィールドは、プロキシサーバーを使用している場合にのみ指定してください。Heimdall にも同じ変更を加えます。

      proxyConfig > proxyServerプロキシ サーバ URL(Proxy server URL)

      API モニタリング PSA:

      設定キー
      apiMonitoringAgent > image<agent-tag>
      shepherd > urlシェパード URL
      shepherd > credentialsログイン情報
      shepherd > locationagent location
      proxyConfig > enabled

      true

      このフィールドは、プロキシサーバーを使用している場合にのみ指定してください。Heimdall にも同じ変更を加えます。

      proxyConfig > proxyServerプロキシ サーバ URL(Proxy server URL)
  3. ./docker-psa docker-compose.yaml に移動します。
    設定キー
    heimdall > image<heimdall-tag>
  4. Docker の作成を実行します。
    docker-compose up -d

PSA のアップグレード

PSA をアップグレードするには、次の手順を実行します。

  1. PSA インストール zip ファイルをダウンロードして解凍します。
    注: upgrade_psa -h コマンドは、指定できるパラメータを表示します。
  2. 以下のコマンドを実行します:
    ./upgrade_psa -d -v <PSA-release-tag>
次の表では、コマンドでのフラグの使用について説明します。説明のアスタリスク(*)は、必須パラメータを示しています。
フラグ説明
-dデバッグモード
-v

*PSA リリースタグ。

これは、アップグレードするバージョンです。たとえば、23.9.0 などです。

PSA のアンインストール

PSA をアンインストールするには、次のコマンドを実行します。

オペレーティングシステムコマンド
Linux および macOS
./uninstall_psa -e docker -p
Windows
  1. docker ps -a
  2. docker rm <heimdall-containerID>
    docker rm <ignite-containerID>