forked from pivotal-cf/docs-appdynamics-apm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathinstalling.html.md.erb
189 lines (122 loc) · 10.4 KB
/
installing.html.md.erb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
---
title: Installing and Configuring AppDynamics
owner: Partners
---
<p class="note"><strong>Note:</strong> For instructions for installing AppDynamics v1.x, see <a href="./installing_1_x.html">(Deprecated) Installing and Configuring AppDynamics APM (1.x version)</a>.</p>
This topic describes how to install and configure Appdynamics APM monitoring in Pivotal Cloud Foundry (PCF).
## <a id='before-you-start'></a> Before You Start
Do the following:
1. Create a [Pivotal Network](https://network.pivotal.io) account if you do not have one.
1. [Configure SSL](./installing.html#SSL).
1. [Set up the AppDynamics Controller](./installing.html#set-up-appd-controller).
## <a id='SSL'></a> Configuring SSL
If you are planning to use SSL, do the following based on the Controller type.
### <a id='SAAS'></a> SSL for SAAS AppDynamics Controllers
AppDynamics SAAS controller use DigiCert Global Root CA. The tile automatically imports the DigiCert Global Root CA into the keystore used by AppDynamics Machine agent and the dashboard application, if present.
Check the SSL checkbox in AppDynamics Machine agent configuration.
### <a id='OnPrem'></a> SSL for OnPremise AppDynamics Controllers
For OnPremise Controller deployments, upload the root certificate for the internal CA that signed the Controller certificate for your OnPremise Controller in the secutiry configuration of the OpsManager Director.
For an example, see the [Security Page](https://docs.pivotal.io/pivotalcf/2-0/customizing/vsphere-config.html#security-config) section of the _Configuring Ops Manager Director on vSphere_ topic in the PCF documentation.
Make sure to follow the exact format below while entering multiple certificates.
<pre class='terminal'>
-----BEGIN CERTIFICATE-----
ABCDEFGH12345678ABCDEFGH12345678ABCDEFGH12345678AB
EFGH12345678ABCDEFGH12345678ABCDEFGH12345678ABCDEF
GH12345678ABCDEFGH12345678ABCDEFGH12345678...
------END CERTIFICATE------
-----BEGIN CERTIFICATE-----
BCDEFGH12345678ABCDEFGH12345678ABCDEFGH12345678ABB
EFGH12345678ABCDEFGH12345678ABCDEFGH12345678ABCDEF
GH12345678ABCDEFGH12345678ABCDEFGH12345678...
------END CERTIFICATE------
-----BEGIN CERTIFICATE-----
CDEFGH12345678ABCDEFGH12345678ABCDEFGH12345678ABBB
EFGH12345678ABCDEFGH12345678ABCDEFGH12345678ABCDEF
GH12345678ABCDEFGH12345678ABCDEFGH12345678...
------END CERTIFICATE------
</pre>
## <a id='set-up-appd-controller'></a> Set Up the AppDynamics Controller
Do the following:
1. [Define an Application and Tier in the Controller](./installing.html#define-app-and-tier).
1. [Determine the Tier ID](./installing.html#determine-app-id).
### <a id='define-app-and-tier'></a> Define an Application and Tier in the Controller
1. Log in to the Controller.
1. Go to the Applications page. At the top of the table, click **Create Application**.
1. In the Create Application dialog box, click **Create an Application manually**, enter the application name, and click **OK**.<br>
1. In the Application Dashboard for the new app, go to **Tiers & Nodes**.
1. Click the Actions button at the top of the table and choose **Create App Server Tier**.
1. Select the application type and click **Next**.
1. Enter the tier name and description and click **Finish**.
* Note the Application Name and Tier Name before proceeding. You will need this information when you set up the Service Broker tile.
### <a id='determine-app-id'></a> Determine the Tier ID
1. In the Tiers & Nodes table for the application you just created, right-click on the tier and choose **View**.
1. Examine the page URL and look for the "component=<number>" string. This number is the tier ID.
* Note the Tier ID before proceeding. You will need this information when you set up the Service Broker tile.
### <a id='dashboard-user'></a> Set Permissions for AppDynamics User Account to Publish Dashboards
1. In the AppDynamics Controller UI, choose Settings (gear icon, top right) > Administration.
1. Go to the **Roles** tab and create a role with a descriptive name such as "PCF KPI Role."
1. Go to the **Applications** sub-tab and do the following:
1. Add the application you defined previously in [Define an Application and Tier in the Controller](./installing.html#define-app-and-tier).
1. Under **Custom Permissions for Applications/Tiers**, add the application you defined previously.
1. Check the **View** option for the application.
1. Click the **Edit** link for the application. In Edit Permissions, select **Configure Health Rules**.
1. Go to the **Dashboards** sub-tab and select the **Can Create Dashboards** option.
1. Save the role.
1. Go to the **Users** tab, select the user of interest, and add the role you just created.
## <a id='set-up-the-service-broker-tile'></a> Set Up the Service Broker Tile
1. Log in to Ops Manager.
1. If the AppDynamics Service Broker tile does not appear in the Installation Dashboard, click **Import a Product** in the left-side menu and import the AppDynamics tile.
1. Double-click the **AppDynamics** tile in the Installation Dashboard.
### <a id='appd-controller-config'></a> AppDynamics Controller Setup
<!--
[//]: # TODO -- Update the following screenshot
TODO -- include an example
TODO -- Pavan/Jeft to review revised descriptions
-->
1. In the **Settings** tab, click **AppDynamics Controller Configuration**. Then click **Add**.
1. Enter the following Service Plan options. All of these fields are required.
* **Controller Configuration Name** -- A user-friendly name for this configuration profile. This name should include the Controller to which the Standalone Machine Agent reports.
* **Controller Configuration Description** -- A more complete description of this configuration profile.
* **Account Name** -- The account name used to access the Controller. You must specify an account with a valid App Agent license. To check this, do the following:
* In the Controller, click the gear icon (top right) and choose **License > Account > License**.
* In the **Account Usage** tab, under **APM Usage**, verify that the account has at least one available license unit for the type of application you are monitoring (Java, .NET, etc.).
* **Account Access Key** -- The account access key used to authenticate with the Controller. In the Controller, click the gear icon (top right) and choose **License > Account > Access Key**.
* **Controller Host** -- The host name or the IP address of the AppDynamics Controller. Example values are 192.168.1.22 or myhost or myhost.example.com. This is the same host that you use to access the AppDynamics browser-based user interface. For an on-premises Controller, use the value for Application Server Host Name that was configured when the Controller was installed. If you are using the AppDynamics SaaS Controller service, see the Welcome email from AppDynamics.
* **Controller Port** -- The HTTP (unencrypted) port used to access the AppDynamics Controller web interface. Defaults are 8090 (on-premise Controllers) and 80 (SaaS Controllers).
* **SSL Port** -- The HTTPS (encrypted) port used to access the AppDynamics Controller web interface. Defaults are 8181 (on-premise Controllers) and 443 (SaaS Controllers).
1. You can add multiple controller configurations by repeating steps 4 and 5. This will enable applications to bind to any of the entered configurations.
1. Click **Save** to save the changes and return to the Installation Dashboard.
### <a id='appd-machine-agent-config'></a> AppDynamics Machine Agent Setup
<!--
[//]: # TODO -- Needs some context. When do you want to set up the Machine Agent? When you use the Firehose Dashboard? Other cases?
-->
1. In the **Settings** tab, click **AppDynamics Machine Agent Configuration**.
1. Enter the following options. All of these fields are required.
1. **Account Name** -- The account name used to access the Controller. You must specify an account with a valid App Agent license. To check this, do the following:
* In the Controller, click the gear icon (top right) and choose **License > Account > License**.
* In the **Account Usage** tab, under **APM Usage**, verify that the account has at least one available license unit for the type of application you are monitoring (Java, .NET, etc.).
1. **Account Access Key** -- The account access key used to authenticate with the Controller. In the Controller, click the gear icon (top right) and choose **License > Account > Access Key**.
1. **Controller Host** -- The host name or the IP address of the AppDynamics Controller. Example values are 192.168.1.22 or myhost or myhost.example.com. This is the same host that you use to access the AppDynamics browser-based user interface.
1. **Controller Port** -- Port on which controller is listening (e.g: `8090`).
1. **SSL Enabled**: Disabled by default. Enable this if you have SSL enabled on the controller. The controller port must be `443` if enabled.
1. **Application Name**, **Tier Name**, and **Tier ID** -- Enter the application name, tier name, and tier ID you defined previously in [Define an Application and Tier in the Controller](./installing.html#define-app-and-tier).
1. **Node Name** -- Enter a name that corresponds to the Application Name, such as **_app-name_-node**.
1. **User Name** -- Must be an AppDynamics user account that has permissions to create both custom metric dashboards and custom Health Rules in the target application.
1. **Password** -- Password for the above AppDynamics user account.
1. Click **Save** to save the changes and return to the Installation Dashboard.
<!--
[//]: # TODO -- # Previous screenshot is outdated. Also, some options have been removed. Pavan will give latest tile, Doug to update
-->
### <a id='appd-machine-agent-config'></a> AppDynamics Analytics Agent Setup
If you have an AppDynamics Analytics license, and want to and view transaction analytics on the AppDynamics controller, install the Analytics Agent as described in [Configuring Transaction Analytics] (./transaction_analytics.html).
### <a id='appd-machine-agent-config'></a> Apply All Updated Settings
1. In the Installation Dashboard, click **Apply Changes** and wait for all the changes to get applied.