-
Notifications
You must be signed in to change notification settings - Fork 8
/
rn-ki.html.md.erb
249 lines (193 loc) · 16 KB
/
rn-ki.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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
---
title: Release Notes and Known Issues
owner: Metrix
---
<p class="note"><strong>Note</strong>: Before v1.7.X, JMX Bridge was known as Ops Metrics. For Ops Metrics release notes and known issues, see <a href="https://docs.pivotal.io/pivotalcf/1-6/pcf-release-notes/p1-v1.6/opsmetrics_rn_1_6.html">Version 1.6.X</a>. </p>
##<a id='v1.8.24'></a>Version 1.8.24
**Release Date: October 13, 2017**
### Release Notes
* Maintenance update of the following product dependencies:
* OpenJDK now v1.8.0.144
* Golang now v1.9.1
* The stemcell for v1.8.24 remains v3363
### Known issues
* None
##<a id='v1.8.23'></a>Version 1.8.23
**Release Date: August 10, 2017**
### Release Notes
* Maintenance update of the following product dependencies:
* OpenJDK now v1.8.0.141
* Golang now v1.8.3
* Guava now v23.0
* Bouncy Castle now v1.57
* The stemcell for v1.8.23 remains v3363
### Known issues
* None
##<a id='v1.8.22'></a>Version 1.8.22
**Release Date: May 25, 2017**
### Release Notes
* Improvements to OpenTSDB Firehose Nozzle behavior during connectivity issues
* When the OpenTSDB Firehose nozzle had a connectivity issue to the maximus vm, the metrics queue could fill to capacity, leaving the nozzle unable to sufficiently recover once the endpoint connection was restored
* Because the product emphasizes transmission of only the latest metric values, in the case of a backup due to an inability to write to maximus, the firehose nozzle will now drop backed-up messages and will write out an error with the number of messages being dropped. This will allow the nozzle to better recover upon recovery of the endpoint connection
* Example log message output <code>2017/05/22 18:40:29 Could not write to maximus VM. Dropping 2942 messages.</code>
* The stemcell for v1.8.22 remains v3363
### Known issues
* None
##<a id='v1.8.21'></a>Version 1.8.21
**Release Date: May 12, 2017**
### Release Notes
* Maintenance update of the following product dependencies:
* OpenJDK now v1.8.0.131
* Golang now v1.8.1
* SLF4J now v1.7.25
* Logback now v1.1.11
* GRPC-ALL now v1.3.0
* Guava now v21.0
* Bouncy Castle bcprov-jdk15on now v1.56
* The stemcell for v1.8.21 remains v3363
### Known issues
* None
##<a id='v1.8.20'></a>Version 1.8.20
**Release Date: May 01, 2017**
### Release Notes
* Updates the stemcell required to v3363
### Known issues
* None
##<a id='v1.8.18'></a>Version 1.8.18
**Release Date: March 09, 2017**
### Release Notes
* Maintenance update of the following product dependencies:
* Updates the OpenJDK version used in the product to v1.8.0.121
* Updates the golang version used in the product to v1.8
* The stemcell for v1.8.18 remains v3263
### Known issues
* None
##<a id='v1.8.14'></a>Version 1.8.14
**Release Date: January 18, 2017**
### Release Notes
* JMX Bridge v1.8.14 — BUG FIX: Fixes the issue identified in earlier v1.8.x versions where the JMX Bridge smoke tests would show an SSL connection error when running with SSL enabled.
* The stemcell for v1.8.14 remains v3263
### Known issues
* None
##<a id='v1.8.12'></a>Version 1.8.12
**Release Date: January 5, 2017**
### Release Notes
* JMX Bridge v1.8.12 — This maintenance patch makes an improvement to how the firehose connection to the JMX provider is tested. The prior `SlowConsumer` metric was not a consistent enough indicator that the firehose nozzle may need to scale. This patch introduces a metric `opentsdb.nozzle.totalFirehoseDisconnects` that increments the number of JMX Bridge firehose disconnects and logs each disconnect to STDOUT.
* This metric can be used to help indicate a need to scale the product firehose nozzle. When experiencing truncated or dropped messages, first restart the Firehose Nozzle VM and check logs to validate it is connected. If several disconnects are logged, you should increase the number of OpenTSDB Firehose Nozzle instances in the tile Resource Config. Firehose reconnect attempts will show a delay of 5 seconds between attempts in order to reduce the risk of excessive calls to UAA. For more info on troubleshooting the firehose connection, see [troubleshooting](https://docs.pivotal.io/jmx-bridge/1-8/troubleshooting-uninstall-metrics.html#no-metrics).
* The stemcell for v1.8.12 remains v3263
### Known issues
* BUG IDENTIFIED: The integration tests will given an SSL connection error when running with SSL enabled. The resolution to this issue is to disable the smoke tests, or to upgrade to v1.8.14 which contains a fix to this bug.
##<a id='v1.8.11'></a>Version 1.8.11
**Release Date: December 15, 2016**
### Release Notes
* JMX Bridge v1.8.11 — **Enhancement**: A new optional feature to enable support of an External IP in a NAT'd customer environment has been added for operators within the tile config under JMX Provider
* Operators are able to set the NAT IP as the host IP, at which point the JMX Provider can be connected to at the specified IP
* This enhancement addresses usage of JMX Bridge in a NAT'd network, where the product provided endpoint would become unavailable. While a manual configuration was possible to overcome this, the manual change would not hold through subsequent environment updates
* This feature is disabled by default. Once enabled, it will continue to persist through future updates until operator disabled
* See [how to enable](https://docs.pivotal.io/jmx-bridge/1-8/deploy-metrics.html#config-nat)
* Release also includes a maintenance update of the following product dependencies:
* SLF4J now v1.7.21
* Logback now v1.1.7
* Guava now v20.0
* Bouncy Castle bcprov-jdk15on now v1.55
* The stemcell for v1.8.11 remains v3263
### Known issues
* BUG IDENTIFIED: The integration tests will given an SSL connection error when running with SSL enabled. The resolution to this issue is to disable the smoke tests, or to upgrade to v1.8.14 which contains a fix to this bug.
##<a id='v1.8.9'></a>Version 1.8.9
**Release Date: November 29, 2016**
### Release Notes
* JMX Bridge v1.8.9 — Earlier versions of Elastic Runtime v1.8 had an issue with the `provides_product_version` property. Elastic Runtime v1.8.17 and later correct this issue, which necessitated an update to how JMX Bridge v1.8 handles the property.
* We recommend you upgrade to Elastic Runtime 1.8.17 or later, however JMX Bridge v1.8.9 can support Elastic Runtime v1.8.0 or later
* Earlier versions of JMX Bridge (v1.8.2 through v1.8.8) will now only work with Elastic Runtime v1.8.0 through v1.8.16.
* The stemcell for v1.8.9 remains v3263
### Known issues
* BUG IDENTIFIED: The integration tests will given an SSL connection error when running with SSL enabled. The resolution to this issue is to disable the smoke tests, or to upgrade to v1.8.14 which contains a fix to this bug.
##<a id='v1.8.8'></a>Version 1.8.8
**Release Date: November 22, 2016**
### Release Notes
* JMX Bridge v1.8.8 — BUG FIX: Fixes the issue identified in v1.8.7 where the new integration tests would fail if the doppler instances were greater than 1. As of this version, the integration tests now correctly handle multiple doppler instances.
* Stemcell for v1.8.8 remains v3263
### Known issues
* BUG IDENTIFIED: The integration tests will given an SSL connection error when running with SSL enabled. The resolution to this issue is to disable the smoke tests, or to upgrade to v1.8.14 which contains a fix to this bug.
* JMX Bridge v1.8.2 through v1.8.8 will only work with Elastic Runtime v1.8.0 through v1.8.16
##<a id='v1.8.7'></a>Version 1.8.7
**Release Date: November 10, 2016**
### Release Notes
* JMX Bridge v1.8.7 - Now enforces the dependency stated in the product documentation to install <a href="https://network.pivotal.io/products/elastic-runtime">Elastic Runtime</a> before installing JMX Bridge
* Enforcing the correct installation order ensures a good connection between JMX Bridge and the firehose
* If installation of JMX Bridge is attempted before Elastic Runtime, the user will now receive an installation error stating the required dependency
* **Enhancement**: The firehose nozzle is now enabled by default on installation
* This enhancement addresses common feedback that the majority of use cases require the firehose to be enabled, and therefore eliminating the nozzle enablement step speeds product installation
* For product use cases that do not include firehose nozzle usage, the OpenTSDB nozzle may still be disabled
* OpenTSDB nozzle enabled/disabled preference will continue to be retained through future upgrades
* **Enhancement**: The tile now includes Smoke Tests which are executed via errand upon installation/upgrade
* Any errors resulting from the smoke tests will be summarized at the end of the log output, and can be referenced against the product <a href="https://docs.pivotal.io/jmx-bridge/1-8/troubleshooting-uninstall-metrics.html">troubleshooting</a> documentation
* Updates the OpenJDK version to v1.8.0.111
* Stemcell for v1.8.7 remains v3263
### Known issues
* BUG IDENTIFIED: The integration tests will fail if the doppler instances are greater than 1. The resolution to this issue is to disable the smoke tests, or to upgrade to v1.8.8 which contains a fix to this bug.
* BUG IDENTIFIED: The integration tests will given an SSL connection error when running with SSL enabled. The resolution to this issue is to disable the smoke tests, or to upgrade to v1.8.14 which contains a fix to this bug.
* JMX Bridge v1.8.2 through v1.8.8 will only work with Elastic Runtime v1.8.0 through v1.8.16
##<a id='v1.8.6'></a>Version 1.8.6
**Release Date: October 11, 2016**
### Release Notes
* JMX Bridge v1.8.6 — BUG FIX: As of PCF v1.8, the firehose began to send the dropsonde envelope index as a GUID instead of an integer.
The OpenTSDB nozzle, if enabled, continued to assume parsing by integer causing some null values to be output. As of v1.8.6, the OpenTSDB nozzle now correctly parses the index field as a GUID.
* Stemcell for v1.8.6 remains v3263
### Known issues
* There is nothing that prevents the user from turning on the Nozzle deployment when Elastic Runtime is not present.
* Enabling the nozzle when Elastic Runtime is not deployed or enabled will produce the following error:
* "RuntimeError — unknown product 'cf' in (( ..cf.cloud\_controller.system_domain.value ))"
* To fix this, reduce the number of nozzle counts to zero until Elastic Runtime is enabled.
* Because deploying the OpenTSDB firehose nozzle is optional and disabled by default, smoke tests for Elastic Runtime have been disabled until a later release.
* JMX Bridge v1.8.2 through v1.8.8 will only work with Elastic Runtime v1.8.0 through v1.8.16
##<a id='v1.8.4'></a>Version 1.8.4
**Release Date: September 22, 2016**
### Release Notes
* JMX Bridge v1.8.4 — now with stemcell v3263
### Known issues
* BUG IDENTIFIED: Prior versions of JMX v1.8.x before v1.8.6 did not properly account for a Firehose change (appearing as of PCF v1.8), where the Firehose (aka Loggregator) began to send the dropsonde envelope index as a GUID instead of an integer. When enabled, the OpenTSDB nozzle parsed the index field as an integer, causing parsing failure. As of JMX v1.8.6 and later, this OpenTSDB parsing now assumes GUID instead of integer.
* There is nothing that prevents the user from turning on the Nozzle deployment when Elastic Runtime is not present.
* Enabling the nozzle when Elastic Runtime is not deployed or enabled will produce the following error:
* "RuntimeError — unknown product 'cf' in (( ..cf.cloud\_controller.system_domain.value ))"
* To fix this, reduce the number of nozzle counts to zero until Elastic Runtime is enabled.
* Because deploying the OpenTSDB firehose nozzle is optional and disabled by default, smoke tests for Elastic Runtime have been disabled until a later release.
* JMX Bridge v1.8.2 through v1.8.8 will only work with Elastic Runtime v1.8.0 through v1.8.16
##<a id='v1.8.3'></a>Version 1.8.3
**Release Date: September 20, 2016**
### Major Features
* Access to the JMX endpoint is now logged to STDOUT by default. This security logging can be enabled/disabled in the JMX Bridge tile configuration by checking/unchecking "Enable Security Logging" under JMX Provider.
* 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.
### Release Notes
* JMX Bridge v1.8.3 — BUG FIX: Corrects issue in v1.8.2 where the new security logging feature was not available to the operator in the tile config.
* Stemcell for v1.8.3 remains v3262
### Known issues
* BUG IDENTIFIED: Prior versions of JMX v1.8.x before v1.8.6 did not properly account for a Firehose change (appearing as of PCF v1.8), where the Firehose (aka Loggregator) began to send the dropsonde envelope index as a GUID instead of an integer. When enabled, the OpenTSDB nozzle parsed the index field as an integer, causing parsing failure. As of JMX v1.8.6 and later, this OpenTSDB parsing now assumes GUID instead of integer.
* There is nothing that prevents the user from turning on the Nozzle deployment when Elastic Runtime is not present.
* Enabling the nozzle when Elastic Runtime is not deployed or enabled will produce the following error:
* "RuntimeError — unknown product 'cf' in (( ..cf.cloud\_controller.system_domain.value ))"
* To fix this, reduce the number of nozzle counts to zero until Elastic Runtime is enabled.
* Because deploying the OpenTSDB firehose nozzle is optional and disabled by default, smoke tests for Elastic Runtime have been disabled until a later release.
* JMX Bridge v1.8.2 through v1.8.8 will only work with Elastic Runtime v1.8.0 through v1.8.16
##<a id='v1.8.2'></a>Version 1.8.2
**Release Date: September 16, 2016**
### Release Notes
* JMX Bridge v1.8.2 is targeted for PCF v1.8.X
* Stemcell for v1.8.2 is v3262
### Known issues
* BUG IDENTIFIED: The new security logging feature expected in JMX Bridge v1.8.X was not available to the operator in the tile config in version v1.8.2. JMX Bridge v1.8.3 corrects this.
* BUG IDENTIFIED: Prior versions of JMX v1.8.x before v1.8.6 did not properly account for a Firehose change (appearing as of PCF v1.8), where the Firehose (aka Loggregator) began to send the dropsonde envelope index as a GUID instead of an integer. When enabled, the OpenTSDB nozzle parsed the index field as an integer, causing parsing failure. As of JMX v1.8.6 and later, this OpenTSDB parsing now assumes GUID instead of integer.
* There is nothing that prevents the user from turning on the Nozzle deployment when Elastic Runtime is not present.
* Enabling the nozzle when Elastic Runtime is not deployed or enabled will produce the following error:
* "RuntimeError — unknown product 'cf' in (( ..cf.cloud\_controller.system_domain.value ))"
* To fix this, reduce the number of nozzle counts to zero until Elastic Runtime is enabled.
* Because deploying the OpenTSDB firehose nozzle is optional and disabled by default, smoke tests for Elastic Runtime have been disabled until a later release.
* JMX Bridge v1.8.2 through v1.8.8 will only work with Elastic Runtime v1.8.0 through v1.8.16
## <a id='metricsprefix'></a>Metric Name Changes in PCF v1.8 ##
In JMX Bridge v1.8, [metrics](https://docs.pivotal.io/pivotalcf/1-8/loggregator/all_metrics.html) from a PCF deployment travel through two paths to the JMX Bridge endpoint: the Firehose and the BOSH Director.
In PCF v1.7 and JMX Bridge v1.7, the collector was still a metrics flow path for Cloud Controller, Gorouter, and ETCD metrics.
With PCF v1.8 and JMX Bridge v1.8, the collector was retired and these components now broadcast via the Firehose.
Some older metrics may have been retired or had their names updated, see [PCF v1.8 metrics](https://docs.pivotal.io/pivotalcf/1-8/loggregator/all_metrics.html) for more information on the individual component metrics.
In JMX Bridge, all metrics that travel through the JMX Bridge Firehose nozzle are prepended with the naming convention `opentsdb.nozzle.<metric>`
## <a id='minor1-7'></a>Past Minor Version 1.7.X
Release Notes for v1.7.X releases can be found [here](http://docs.pivotal.io/jmx-bridge/1-7/rn-ki.html).