The App Visibility server includes the following components:
For a very small environment or a test environment, you can install the portal, one collector, and one proxy on the same computer. When the App Visibility portal and collector components are installed on the same computer, they share the same database. For instructions, see Installing more than one App Visibility server component on the same computer.
For most production environments, you install one App Visibility portal on one computer, several App Visibility collectors (each on a separate computer), and App Visibility proxies on separate computers that are in the network's demilitarized zone (DMZ).
Install the portal before the other server components because the collector and proxy reference the portal during installation. The App Visibility agents also reference the portal during installation. The portal includes a small database for configuration and connection information. If you install a portal and a collector on the same computer, they share the same database.
You can install several collectors, depending on the volume of your transactions. Install each collector on a separate computer. Each collector includes a database for App Visibility data.
Install each proxy on a separate computer in the network's demilitarized zone (DMZ), or behind a firewall or network gateway that handles the secured communication and certificates with end-users' browsers. The proxy uses SSL-encrypted beacons and injection requests, and therefore, requires a KeyStore with a certificate that is trusted by the end-users’ browsers. You can import the KeyStore during proxy installation or after installation.
The silent installation obtains the required user inputs from the adop-silent-option file, which is bundled along with the installer.
Installation of the App Visibility server consists of these tasks:
I. Setting options for the App Visibility portal
II. Setting options for the App Visibility collector
III. Setting options for the App Visibility proxy
IV. Installing the App Visibility server silently
V. Verifying the App Visibility server installation
VI. Configuring the network settings
To set options for silent installation of the App Visibility portal
Click here to expand steps.
Login to the host computer on which you want to install the app Visibility portal, and delete all the files from the temporary directory:
- (Windows) %temp%
- (Linux) /tmp
- Extract the downloaded files to a temporary directory.
- On the computer where you want to install the App Visibility portal, open the adop-silent-option file in edit mode.
Specify a valid installation directory. Ensure that the specified directory has no files or folders in it and that the directory path uses only ASCII characters.
-P installLocation=<directory>
<directory> is the installation location.
The following values are the default:
Under the Install Features section, add a hash character (#) before the server components that you do not want to install, so that only the portal component is indicated for installation.
# Install App Visibility Portal
-A bmc_application_diagnostics_portal
# Install App Visibility Collector
# -A bmc_application_diagnostics_collector
# Install App Visibility Proxy
# -A bmc_application_diagnostics_proxy
Under the Portal Configuration section, enter the portal connection details.
Ensure that the App Visibility portal ports are available and can receive communication from the App Visibility agents. Specifically, ensure that your firewall enables this communication.
The default values are displayed below:
-J portal_ip=localhost
-J portal_communication_port=8100
-J portal_integration_supportability_port=8101
Parameter descriptions for the portal configuration
Parameter | Description |
---|
portal_ip | The App Visibility portal must use the default value, localhost . |
portal_communication_port | Listening port of the App Visibility portal The default port is 8100. |
portal_integration_supportability_port | Listening port of the portal support console. A support console to help detect issues is automatically activated with one-way SSL authentication. The default port is 8101. |
Modify the parameter values under the Database Configuration section, as necessary.
-J db_port=8800
-J db_retention_time=35
-J db_max_size=100
Parameter descriptions for the portal database
Parameter | Description |
---|
db_port | Listening port of the App Visibility database The default port is 8800. |
db_retention_time | Number of days before the historical data on the App Visibility component database is overwritten. The default time is 35 days. The overwrite function launches automatically when the system reaches the specified retention time. |
db_max_size | Maximum disk space allowed for data storage. The default size is 100 GB. For information about sizing considerations for the portal database, see Sizing App Visibility Manager and Synthetic TEA Agent components . When the database reaches the maximum size, historical data is overwritten, regardless of the value defined in the database retention time parameter. |
- Save and close the options file.
To set options for silent installation of an App Visibility collector
Click here to expand steps.
- On the computer where you want to install the App Visibility collector, open the adop-silent-option file in edit mode.
Specify a valid installation directory.
Ensure that the specified directory has no files or folders in it and that the directory path uses only ASCII characters.
-P installLocation=<directory>
<directory> is the installation location.
The following values are the default:
Under the Install Features section, add a hash character (#) before the server components that you do not want to install, so that only the collector component is indicated for installation.
# Install App Visibility Portal
# -A bmc_application_diagnostics_portal
# Install App Visibility Collector
-A bmc_application_diagnostics_collector
# Install App Visibility Proxy
# -A bmc_application_diagnostics_proxy
Under the Portal Configuration section, enter the details to connect to the portal.
Ensure that your firewall enables communication with the portal.
The default values are displayed below:
-J portal_ip=myPortalHost
-J portal_communication_port=8100
Parameter descriptions for the portal configuration
Parameter | Description |
---|
portal_ip | Enter the host name or IP address of the portal. If a load balancing server manages access to the portal, enter the host name or IP address of the load balancer. The default value is localhost . |
portal_communication_port | Listening port of the App Visibility portal If a load balancing server manages access to the portal, enter the port number of the load balancer. The default port is 8100. |
Modify the parameter values under the Collector Configuration section, as necessary.
Ensure that the App Visibility collector ports are available and can receive communication from the App Visibility agents. Specifically, ensure that your firewall enables communication with the portal.
The default values are displayed below:
-J collector_communication_port=8200
-J collector_supportability_port=8201
Parameter descriptions for the collector configuration
Parameter | Description |
---|
collector_communication_port | Listening port of the App Visibility collector The default port is 8200. |
collector_supportability_port | Listening port of the collector support console. A support console to help detect issues is automatically activated with one-way SSL authentication. The default port is 8201. |
Under the Address Configuration section, configure the listening address (host name or IP address) of the computer on which you are installing the App Visibility collector.
The App Visibility components use this address to contact the computer on which you are installing.
-J callback_address=
Modify the parameter values under the Database Configuration section, as necessary.
-J db_port=8800
-J db_retention_time=35
-J db_max_size=100
Parameter descriptions for the collector database
Parameter | Description |
---|
db_port | Listening port of the App Visibility database The default port is 8800. |
db_retention_time | Number of days before the historical data on the App Visibility collector database is deleted. The default time is 35 days. The delete function launches automatically when the system reaches the specified retention time. |
db_max_size | Maximum disk space allowed for data storage. The default size is 100 GB. For information about sizing considerations for the collector database, see
Sizing App Visibility Manager and Synthetic TEA Agent components
. When the database reaches the maximum size, historical data is deleted, regardless of the value defined in the database retention time parameter. |
- Save and close the options file.
To set options for silent installation of an App Visibility proxy
Click here to expand steps.
Encrypt a password to specify in the options file.
The Maintenance Tool enables you to create an encrypted password, which the Diagnostic Server requires for importing a KeyStore. You must use an encrypted password so that the KeyStore password is not exposed in the adop-silent-option file.
You can run the Maintenance Tool in a wizard interface or from the command-line interface (CLI).
To encrypt a password by using the Maintenance Tool wizard
- To open the Maintenance Tool, go to the temporaryDirectory/Disk/utility directory where you downloaded the installation files.
- Run the ADOPServerMaintenanceTool utility and click the Encrypt tab.
- Enter your password in the Password and Confirm Password fields and click Encrypt.
- Copy and paste the value from the Encrypted Password field to the adop-silent-option file for the
proxy_keystore_password_enc
parameter.
For example, if the encrypted password output is DES\:d70cbe3669602717ce66af37cce7ecf0, modify the proxy_keystore_password_enc
parameter as follows:
-J proxy_keystore_password_enc
=DES\:d70cbe3669602717ce66af37cce7ecf0
To encrypt a password by using a CLI
- To open the Maintenance Tool, go to the temporaryDirectory\Disk\utility directory where you downloaded the installation files.
Run the following command, entering your password for the -password
and -confirm_password
options:
(Windows) ADOPServerMaintenanceTool.cmd -silent -encrypt -encrypt -password=<password> -confirm_password=<password>
(Linux) ./ADOPServerMaintenanceTool.sh -silent -encrypt -encrypt -password=<password> -confirm_password=<password>
Copy and paste the output to the adop-silent-option file for your silent installation.
For example, if the encrypted password output is DES\:d70cbe3669602717ce66af37cce7ecf0, modify the proxy_keystore_password_enc
parameter as follows:
-J proxy_keystore_password_enc
=DES\:d70cbe3669602717ce66af37cce7ecf0
- On the computer where you want to install the App Visibility proxy, open the adop-silent-option file in edit mode.
Specify a valid installation directory.
Ensure that the specified directory has no files or folders in it and that the directory path uses only ASCII characters.
-P installLocation=<directory>
<directory> is the installation location.
The following values are the default:
Under the Install Features section, add a hash character (#) before the server components that you do not want to install, so that only the proxy component is indicated for installation.
# Install App Visibility Portal
# -A bmc_application_diagnostics_portal
# Install App Visibility Collector
# -A bmc_application_diagnostics_collector
# Install App Visibility Proxy
-A bmc_application_diagnostics_proxy
Under the Portal Configuration section, enter the details to connect to the portal.
You must provide App Visibility portal configuration details, even if you are not currently installing the portal component.
Ensure that your firewall enables communication with the portal from other components.
The default values are displayed below:
-J portal_ip=myPortalHost
-J portal_communication_port=8100
Parameter descriptions for the portal configuration
Parameter | Description |
---|
portal_ip | Enter the host name or IP address of the portal. If a load balancing server manages access to the portal, enter the host name or IP address of the load balancer. The default value is localhost . |
portal_communication_port | Listening port of the App Visibility portal If a load balancing server manages access to the portal, enter the port number of the load balancer. The default port is 8100. |
Modify the parameter values under the Proxy Configuration section, as necessary.
If required, modify the port numbers for the relevant communication protocol. Ensure that the port numbers are available.
-J proxy_communication_port=8300
-J proxy_supportability_port=8301
-J proxy_storage_http_port=8302
-J proxy_storage_transport_port=8303
-J proxy_beacon_receiver_http_port=8304
-J proxy_beacon_receiver_https_port=8305
-J proxy_storage_transport_ip=192.0.2.24
Parameter descriptions for the proxy configuration
Parameter | Description |
---|
proxy_communication_port | Listening port of the proxy for communication from the portal and collector The default port is 8300. |
proxy_supportability_port | Listening port of the proxy support console. A support console to help detect issues is automatically activated with one-way SSL authentication. The default port is 8301. |
proxy_storage_http_port | Listening port of the App Visibility proxy database The default port is 8302. |
proxy_storage_transport_port | Port for TCP communication between App Visibility proxy database nodes in a cluster The default port is 8303. |
proxy_beacon_receiver_http_port | Listening port of the beacon receiver for HTTP communication from the end-user's browser The default port is 8304. |
proxy_beacon_receiver_https_port | Listening port of the beacon receiver for HTTPS communication from the end-user's browser The default port is 8305. |
proxy_storage_transport_ip | Used for communication between the different nodes in the storage cluster The IP address must be available from other App Visibility proxy nodes. If you do not provide a value, the default IP address is the first received by the system. |
The App Visibility proxy requires a security certificate for use with SSL-encrypted beacons and injected requests. You can provide the location of the keystore file now, or you can
import or replace the keystore after installation
.
-J import_proxy_keystore_now=false
-J proxy_keystore_type=
-J proxy_keystore_path=
-J proxy_keystore_alias=
-J proxy_keystore_password_enc=
Parameter descriptions for the proxy keystore
Parameter | Description |
---|
import_proxy_keystore_now | If false (default), import the keystore post-installation. To import the keystore file now, set to true and provide values for the other parameters. |
proxy_keystore_type | One of the following keystore types: JKS or PKCS12 |
proxy_keystore_path | Full path to the keystore, which must be on a local drive, including the file name and file extension If the path has spaces, enclose the entire path with quotation marks. |
proxy_keystore_alias | Keystore alias |
proxy_keystore_password_enc | Encrypted password, if one exists, from the Maintenance Tool. The keystore password cannot contain the following characters: | ^ ; " < > , |
Under the Address Configuration section, configure the listening address (host name or IP address) of the computer on which you are installing the App Visibility proxy.
The App Visibility components use this address to contact the computer on which you are installing.
-J callback_address=
- Save and close the options file.
To install the App Visibility server silently
Click here to see the verifying steps
- In a command line window, navigate to the \ADOPServer\Disk1 folder in the installation file structure.
- Run the silent installation of the App Visibility server with the following command:
However, installation occurs in the background.
If the installation is successful, an indication is displayed in the command window.
To verify the App Visibility server installation
Click here to see the steps
Access the adopserver_install_log file:
(Windows) %temp%
(Linux) /tmp
Check for warnings or errors.
If no error messages are present, the installation was successful.
According to what you installed, verify that the App Visibility server components are running:
- (Windows) Run services.msc and verify that the services are running:
For Collector and Portal
- App Visibility Collector
- App Visibility Portal
- App Visibility PostgreSQL
For Proxy
- App Visibility Proxy
- App Visibility Elasticsearch
Check for errors reported in the App Visibility log files in the following locations:
- Windows
- server_installationDirectory\collector\logs\collector.log
- server_installationDirectory\portal\logs\portal.log
- server_installationDirectory\apm-proxy\logs\apm-proxy.log
- Linux
Click here to expand
As the system administrator, configure your network to ensure that the App Visibility proxy can collect end-user browser data, and pass it on to the App Visibility collector and portal.
After you install the App Visibility server components, configure the following properties for the portal and the proxy:
- collectors.load.balancer.address. If the App Visibility portal and App Visibility collector are behind a load balancing or reverse proxy server, update the value of this property value to redirect App Visibility agent communication through the intermediary server and forward requests to the assigned App Visibility collectors. For instructions, see
Changing App Visibility portal settings
.
callback.address. If the App Visibility proxy that is behind a load balancing or reverse proxy server, update the value of this property to redirect end-user browser data through the intermediary server and forward requests to the App Visibility proxy. For instructions, see
Changing App Visibility proxy settings.
Details about configuring load balancing servers varies among vendors. To properly configure your load balancing server, refer to your vendor's documentation.
Comments
Log in or register to comment.