This document explains how to install and configure a Cloud Transaction Perspective (CTxP) private agent.
Requirements and recommendations
CTxP is installed as a virtual appliance using VMware tools on server class hardware. The CTxP VM requires a 64-bit host running VMware software such as VMware vSphere, vSphere ESXi, Workstation Player and Workstation Pro. An understanding of VMware administration is required.
The customer must provide a Windows 2008 Server license for the virtual machine during setup. The activation grace period for Windows Server software is 30 days.
The default configuration of a CTxP virtual machine is 6 GB of memory with four processors; the host should have enough memory and processors to run itself as well as the virtual machine. With the default configuration, you should be able to run 8 concurrent measurements. However, if you were to scale hardware down to, for example, 2 CPUs and 4 GB of memory, the number of concurrent measurements possible will be closer to 2. Please consult with a Dynatrace Keynote representative for sizing assistance.
Deploying the CTxP OVA
The CTxP agent is provided to you as an Open Virtualization Archive (OVA) file. Deployment procedures will vary depending on the VMware product being used. This section explains how to use vSphere to deploy the CTxP OVA.
The CTxP installation OVA file can be downloaded from http://download.keynote.com/CTxP.ova. The uncompressed contents require at least 10 GB of disk space; the amount of disk space used during operation will be larger.
In the vSphere tool, select File >Deploy OVF Template.
Provide the URL or file location for the Keynote CTxP OVA or browse to the OVA. Click Next.
Provide a name and location for the deployed OVA.
Select the host or cluster.
If your host uses resource pools, a screen appears where you can select one for the OVA.
Select a Datastore where you want to deploy the CTxP OVA.
Select the thin or thick provisioned format.
Select a destination network from the list of your available networks.
A screen appears showing your selected options. You can click Back to change options, Cancel the deployment, or Finish the deployment.
Adjust VM settings for the host environment. The default configuration of the VM is 6 GB of memory with four processors; the host should have enough memory and processors to run itself as well as the VM.
Next, power on the CTxP virtual machine by selecting the CTxP guest and clicking Power On.
Once the machine is powered on, select Open Console.
Choose the initial Windows Server 2008 settings for country or region, time and currency, and keyboard layout. English is the only language supported by CTxP.
Accept the Microsoft Windows license terms.
Enter the default username
CTxPAdmin!. Use RDP to connect if the machine is not local.
Using the Windows Initial Tasks Information screen:
- Activate Windows using a Windows Server 2008 R2 Product key (obtained separately by the customer). The activation grace period is 30 days.
- Configure networking.
- It is highly recommended that you update the server (Windows Update).
- Enable the Windows firewall.
- Set the time zone.
knadminaccount must be configured for automatic login. To do so, click the KN_LogAuto icon and enter a new password for the
knadminaccount. Clicking OK configures the account for automatic login.
You can also open a command prompt and type
MyNewPasswordis a new password for the
CommonAgentservices must be configured to start automatically. To do so, use either the Windows Services tool, or the Keynote Common Agent Manager in the notification area of the Windows taskbar.
Keynote Common Agent Manager
Windows Services Manager
The CTxP installation is now complete. You can now use the CTxP Configuration Tool to configure the agent with the correct settings and restart it.
CTxP Configuration Tool
After installation is completed, a shortcut for the CTxP Configuration Tool is available on your desktop.
Paste the configuration string provided when the CTxP agent was requested in Keynote Service Center (KSC). Each CTxP agent requires its own unique configuration string.
You can reduce the maximum number of concurrent measurements that the CTxP agent can perform from the default number (20 ) to 5.
Optionally, configure proxy settings (shown below).
Click Start to restart the CTxP agent with the correct settings on your system.
Set up rebooting
We recommend that users set up the Windows system containing the CTxP VM to reboot periodically. This must be set up in the agent configuration file (
agentconf.ini) installed in
C:\Program Files\Keynote Systems\Keynote Agent\Config.
Refer to Private Agent (Cloud and Hardware ApP and TxP) Rebooting for details.
Testing the connection
After starting the CTxP software, click Test Connection in the configuration tool to test the connection between the CTxP agent and Dynatrace Keynote servers.
If the test does not succeed, an error message is displayed. See Error Messages below for explanations of the standard error messages.
Stopping or starting the CTxP Agent
You should already have configured the
CommonAgent services of the CTxP Agent to start up automatically as part of the installation procedure.
If you need to stop and start the CTxP Agent manually at any time, you can use Start Common Agent Services and Stop Common Agent Services icons located on your desktop.
After the CTxP agent is installed, you can use Keynote Service Center (KSC) to set up measurements using the agent. CTxP agents are created as a Transaction Perspective measurements in both KITE and KSC.
If you need to use a proxy to connect to the Internet, use the Proxy drop-down menu in the CTxP configuration tool to choose the proxy type, enter the required values, and click Save Settings. You might need to contact your IT support to determine the correct proxy settings for your system.
Proxy setup can also be accomplished by directly editing the agent configuration file,
AgentConf.ini, created when you install the agent.
Configuring proxy using the CTxP Configuration Tool
The CTxP Configuration Tool provides these proxy options:
- No Proxy —No proxy will be used.
- Internet Explorer Settings —The proxy settings currently set in Internet Explorer are used. You are asked to specify a username and password, and optionally add URLs to the Bypass List that you don't want to connect to using a proxy, such as intranet URLs. See Proxy Bypass List below for more information.
- Proxy Settings —This option lets you specify a Proxy URL (followed by a colon and the port number), Username, Password, and, optionally, add URLs to the Bypass List (see Proxy Bypass List below). If you select Encrypt Settings , the username and password you enter will be encrypted in the
- Configuration Script —This option lets you specify the URL for a PAC (Proxy Auto-Config) file. Only this type of proxy configuration script is supported. (For more information about PAC files, see http://en.wikipedia.org/wiki/Proxy_auto-config.) You can also add URLs to the Proxy Bypass List.
- Automatically Detect Settings —Use this option to automatically detect DHCP and/or DNS.
We recommend either Proxy Settings (where you specify a Proxy URL) or Configuration Script (where you specify a URL or PAC file). When you choose either of these options, you can set whichever proxy URL is already in your Internet Explorer settings.
Be sure to Save Settings after you have selected proxy settings.
Modifying AgentConfig.ini file manually
AgentConfig.ini file is installed in
C:\Program Files\Keynote Systems\Keynote Agent\Config. The
\[Proxy\] section specifies how the common agent can communicate back to Dynatrace Keynote infrastructure to report measurement data and retrieve the measurement schedule.
[Proxy] ProxyType=0 AutoDetectDHCP=0 AutoDetectDNS=0 ConfigScriptURL= ProxyURL= ProxyUsername= ProxyPassword= ProxyAuthenticate= ProxyByPass=
Proxy field definitions
||Enter the URL for a PAC (Proxy Auto-Config) file. For more information about PAC files, see http://en.wikipedia.org/wiki/Proxy_auto-config.|
||Specify a Proxy Server URL (followed by a colon and the port number).|
||Enter the proxy username.|
||Enter the proxy password.|
||Encrypted username and password (If Encrypt Settings is selected for Proxy Settings in the CTxP Configuration Tool, an encrypted version of the username and password are entered in this field. The user cannot supply this encrypted version.)|
||A list of URLs for which the proxy server will be bypassed—see Proxy Bypass List below.|
Proxy bypass list
You can use the Proxy Bypass list to specify URLs for which the proxy server will be bypassed. Proxy Bypass allows a wildcard (*) to be used in the place of zero or more characters.
To bypass servers, you can:
- Enter a wildcard at the beginning of an Internet address, IP address, or domain name with a common ending. For example, use
*.example.comto bypass any entries ending in
- Enter a wildcard in the middle of an Internet address, IP address, or domain name with a common beginning and ending. For example, the entry
www.*.commatches any entry that starts with
wwwand ends with
- Enter a wildcard at the ending of an Internet address, IP address, or domain name with a common beginning. For example, use
www.example.*to bypass any entries that begin with
www. example.org, and
To bypass addresses with similar patterns, use multiple wildcards. For example, use
123.1*.66.* to bypass addresses such as
Below is a list of errors that may be reported when the connection is tested.
|Missing configuration string||Configuration string is empty. Please enter configuration string supplied by Dynatrace Keynote in the CTxP Configuration Tool and try again.|
|Invalid or unknown target preference URL||DNS resolution for Dynatrace Keynote servers failed. Please try again. If the problem persists, contact Dynatrace Keynote Support.|
|Empty target preference URL||Preference server URLs are empty. Please try again. If the problem persists, contact Dynatrace Keynote Support.|
|Incorrect data delivery URL||Error code 403—Unable to deliver measurement data to the Dynatrace Keynote server. Please try again. If the problem persists, contact Dynatrace Keynote Support.|
|Missing data delivery URL||Data server URLs are empty. If the problem persists, please contact Dynatrace Keynote Support.|
|Data delivery is set to Inactive||Data delivery is currently disabled. Please click Yes to re-enable.|
|Missing preference file||The preference file is missing. Click Yes to create one. A manual restart is necessary. (See Stopping or Starting the CTxP Agent above for information.)|
|Missing preference file, no error||Target preferences are currently disabled. Click Yes to re-enable.|
|Incorrect proxy username and password||Error code 407—Local Proxy Authentication failed. Please enter correct user name and password and try again.|
|Incorrect proxy URL||Error code 12029—A connection with the server could not be established. Please supply the correct proxy URL and try again.|
|Incorrect proxy password||Please provide the correct proxy password and try again.|
|Incorrect system IP address||Error code 403—Unable to deliver measurement data to the Dynatrace Keynote server. Please try again. If the problem persists, contact Dynatrace Keynote Support.|
|Unable to find measurement instructions for this agent||Error code 404—The target profile for this agent was not found. Please contact Dynatrace Keynote Support.|