forked from pivotal-cf/docs-jmx-bridge
-
Notifications
You must be signed in to change notification settings - Fork 0
/
deploy-metrics.html.md.erb
142 lines (88 loc) · 6.48 KB
/
deploy-metrics.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
---
title: Deploying JMX Bridge
owner: PCF Metrics
---
<strong><%= modified_date %></strong>
The JMX Bridge tool is a JMX extension for Elastic Runtime. Follow the instructions below to deploy JMX Bridge using the [Pivotal Cloud Foundry](https://network.pivotal.io/products/pcf-metrics) (PCF) Operations Manager.
## <a id='import'></a>Step 1: Install the JMX Bridge Tile ##
<p class="note"><strong>Note</strong>: To use the Firehose nozzle, you must install <a href="https://network.pivotal.io/products/elastic-runtime">Elastic Runtime</a> before installing JMX Bridge. If you install in reverse order, JMX will display numerous errors, and you may experience a bad connection between the Firehose nozzle and the JMX provider.</p>
1. [Download JMX Bridge](https://network.pivotal.io/products/ops-metrics).
1. Import JMX Bridge into Ops Manager by following the instructions for [Adding and Importing Products](https://docs.pivotal.io/pivotalcf/1-7/customizing/add-delete.html#add-import).
1. On the Installation Dashboard, click the **JMX Bridge** tile.
<%= image_tag("images/metrics-tile.png") %>
The orange bar on the **JMX Bridge** tile indicates that the
product requires configuration.
## <a id='config-az'></a>Step 2: Assign Availability Zones and Networks
1. Select **Assign AZs and Networks**. This section shows the Availability Zones that you [create](https://docs.pivotal.io/pivotalcf/1-7/customizing/vsphere-config.html#create-az) when configuring Ops Manager Director.
1. (**vSphere and Amazon Web Services Only**) Select an Availability Zone under **Place singleton jobs in**. Ops Manager runs Metrics jobs with a single instance in this Availability Zone.
1. (**vSphere and Amazon Web Services Only**) Select one or more Availability Zones under **Balance other jobs in**. Ops Manager balances instances of Metrics jobs with more than one instance across the Availability Zones that you specify.
<%= image_tag("images/assign-az.png") %>
1. Use the drop-down menu to select a Network.
<p class='note'><strong>Note</strong>: JMX Bridge uses the default Assigned Network if you do not select a different network.</p>
1. Click **Save**.
<p class="note"><strong>Note</strong>: When you save this form, a verification error displays because the PCF security group blocks ICMP. You can ignore this error.</p>
<%= image_tag("images/er-network-error.png") %>
## <a id='config-jmx-provider'></a>Step 3: Configure JMX Provider ##
1. Select **JMX Provider**.
1. Enter a new username and password into the **JMX Provider credentials** username and password fields.
1. Record these credentials. You use these to connect JMX clients to the JMX Provider.
## <a id='config-ssl'></a>(Optional) Step 4: Configure SSL ##
1. Select the **Enable SSL** checkbox.
Enabling SSL requires JMX clients to use SSL to connect to the JMX Provider.
If SSL is not enabled, JMX clients can connect to the JMX Provider without SSL
credentials.
<%= image_tag("images/ops-metrics-jmx-ssl.png") %>
If you select the **Enable SSL** checkbox, you must also provide an SSL
certificate and private key.
There are two ways to provide an SSL certificate and private key:
* If you are using a signed certificate, paste an X.509 certificate in the
**Certificate PEM** field and a PKCS#1 private key in the **Private Key**
field.
* If you want to use SSL but do not want to use a signed certificate, you
must perform the following actions:
1. Generate a self-signed certificate on the server.
1. Import the self-signed certificate to a trust store on the client.
1. Start jConsole, or another monitoring tool, with the trust store.
For more information, see [Using SSL with a Self-Signed Certificate](./self-signed-ssl.html).
<%= image_tag("images/ops-metrics-jmx-cert.png") %>
1. Once you have provided an SSL certificate and private key, click **Save**.
## <a id='config-ssl'></a>(Optional) Step 5: Disable/Enable Security Logging ##
1. Select the **Enable Security Logging** checkbox.
Access to the JMX endpoint is logged to STDOUT by default.
This security logging can be enabled/disabled in the JMX Bridge tile
configuration by checking/unchecking this checkbox.
This is enabled by default.
<%= image_tag("images/jmxbridge-enable-security-logging.png") %>
1. If you have enabled or disabled security logging, click **Save**.
<p class="note"><strong>Note</strong>:Related log output is made available by initiating a JMX Provider logs
download from the JMX Bridge tile configuration status tab, then
fetching the download from the logs tab.</p>
## <a id='resource-config'></a>Step 6: Resource Configuration ##
<p class="note"><strong>Note</strong>: Do not change the <strong>OpenTSDB Firehose Nozzle</strong> instance count unless you have a running Elastic Runtime installation.</p>
To receive metrics data from the PCF Elastic Runtime firehose, including Diego metrics, change the **OpenTSDB Firehose Nozzle** instance count from `0` to `1`.
## <a id='apply'></a>Step 7: Apply Changes ##
1. Navigate to the PCF Ops Manager Installation Dashboard.
1. In the Pending Changes view, click **Apply Changes** to install JMX Bridge.
<%= image_tag("images/ops-metrics-pending-changes.png") %>
1. When complete, a “Changes Applied” message appears.
## <a id='get-ip'></a>Step 8: Find the IP of the JMX Provider ##
1. Click **Return to Product Dashboard**.
1. Click the **JMX Bridge** tile and select the **Status** tab.
<%= image_tag("images/ops-metrics-jmx-ips.png") %>
1. Record the IP address of the **JMX Provider**.
<p class="note"><strong>Note</strong>: After installation, your JMX client connects to this IP address at port 44444 using the credentials that you supplied. Also ensure that TCP port 44445 is open.</p>
## <a id='config-ip'></a>Step 9: Configure the Metrics IP Address ##
1. Return to the **Installation Dashboard**.
Click the **Ops Manager Director** tile and select **Director Config**.
<%= image_tag("images/ops-metrics-director-ip.png") %>
1. In the **Metrics IP Address** field, enter the IP address of the JMX
Provider.
Click **Save**.
## <a id='complete'></a>Step 10: Complete Installation ##
1. In the Pending Changes view, click **Apply Changes**.
<%= image_tag("images/ops-metrics-pending-changes.png") %>
1. When complete, a "Changes Applied" message appears.
Click **Return to Product Dashboard**.
JMX Bridge is now installed and configured.
Once installed and configured, metrics for Cloud Foundry components
automatically report to the JMX endpoint.