Web モニタリング PSA および API モニタリング PSA の設定

このページでは、Web モニタリング PSA と API モニタリング PSA の設定方法について説明します。

スクリプト内メタデータの設定

スクリプト測定として合成ジョブを実行する場合、スクリプト内メタデータを使用して特定の設定オプションを指定できます。これらの YAML ベースの設定は、コメントブロックの形式でスクリプトの先頭に含める必要があります。

合成スクリプトのカスタムユーザーエージェントの設定

デフォルトのブラウザ固有の user-agent ヘッダーをカスタム user-agent ヘッダーに変更するには、合成スクリプトの先頭に次のスクリプト内メタデータを追加します。

CODE
'''yml
requestHeader:
userAgent: "custom user agent"
'''
driver.get('http://127.0.0.1:20000/green.html')

合成トラフィックをブラウザ RUM トラフィックに含める

合成スクリプトの user-agent リクエストヘッダーには、要求がブラウザ RUM ページに含まれないようにするためのタグが付けられます。tagUserAgentfalse に設定すると、ブラウザ RUM ページに合成トラフィックを含めることができます。

合成スクリプトの先頭に次のスクリプト内メタデータを入力します。

CODE
'''yml
requestHeader:
userAgent: "custom user agent"
tagUserAgent: false
'''
driver.get('http://127.0.0.1:20000/green.html')

Kubernetes Configuration

After you set up the Kubernetes cluster, push the images to the Docker registry, and deploy the Web Monitoring PSA or API Monitoring PSA using sum-psa-heimdall.tgz Helm chart, a values.yaml file is generated. Use the values.yaml file to dynamically configure the values while deploying the Web Monitoring PSA and API Monitoring PSA.

Key-Value Pairs Configuration

You can replace the optional configuration values in the values.yaml file with the values in the table:

Configuration Key-Value Pair Description
Heimdall replica count heimdall > replicaCount Indicates the Heimdall replica count.
Heimdall Resource allocations
  • heimdallResources > min_cpu
  • heimdallResources > max_cpu
  • heimdallResources > min_mem
  • heimdallResources > max_mem
Indicates the Heimdall Resource allocation.
Measurement Container Resource allocations

Web Monitoring PSA:

  • chromeAgentResources > min_cpu
  • chromeAgentResources > max_cpu
  • chromeAgentResources > min_mem
  • chromeAgentResources > max_mem

API Monitoring PSA:

  • apiMonitoringAgentResources > min_cpu
  • apiMonitoringAgentResources > max_cpu
  • apiMonitoringAgentResources > min_mem
  • apiMonitoringAgentResources > max_mem
Indicates the measurement container resource allocations.
Logging level logging > level to ERROR, WARN, INFO, DEBUG, or TRACE Indicates the logging level. The default value is DEBUG .
Node selectors
  • heimdallNodeSelector >
  • agentNodeSelector >
Apply Node selectors for Heimdall and measurement containers to schedule these components on specific nodes.
Proxy

Heimdall:

heimdall: enabled: false server: "<proxy server address>"

Web Monitoring PSA:

browserMonitoringAgent: enabled: false server: "<proxy server address>" bypassList: "<specify the domain URLs that you want to bypass separated by semicolon>"

API Monitoring PSA:

apiMonitoringAgent: enabled: false server: "<proxy server address>"

Configure the PSA to use a proxy for all requests leaving the cluster. Set the enabled true

<scheme>://<hostname>:<port>

You can configure the same proxy server for all components or different proxy servers for each component.

注: This configuration is set to the deployment level and applies to all the domains or tests for that particular EUM license.If you have multiple proxy servers, you can use one proxy server for Web monitoring and another for API monitoring. All the tests will go through the configured proxy server irrespective of the domain.

Connect Agent to the Synthetic Server

When deploying the Web Monitoring PSA or API Monitoring PSA in the Kubernetes cluster, you must specify the agent registration information in the values.yaml file. Heimdall uses this information to register itself with the Synthetic Server. Once registered, you can view the agent in the Controller and run measurements.

Shepherd URL

To connect the agent to a hosted Synthetic Cloud region, enter one of these shepherd URLs in the values.yaml file:

To connect the agent to your on-premises Synthetic Server, enter the shepherd URL (http://<on-premises-synthetic-server-host>:10101) in the values.yaml file.

注: On-premises Synthetic Server versions >= 21.4.1 are supported. If you are on an older version, you must upgrade Synthetic Server to connect to the Linux-based PSA.

EUM Account and License Key

To connect the agent to the Controller, you need the EUM account and license key.

Follow the given steps to obtain this information:

  1. Navigate to the SaaS Controller.
  2. Click User Profile icon(User Profile) > License.
  3. Scroll down to the User Experience section. Enter Account Name and License Key in the values.yaml file.

    Configuration Key Configuration Value
    shepherd > credentials > eumAccount Account Name
    shepherd > credentials > eumKey License Key

Location Information

To identify the location of the agent, enter the following shepherd > location details in the values.yaml file:

  • name - A user-friendly string for the location.

  • code - A unique alphanumeric string with four to ten characters that identifies the location where the agent is running. You must create this ID based on the location name.

  • latitude, longitude - Navigate to the GPS Coordinates with Google Maps to get the latitude and longitude of your location.