Refactoring PayloadLoggingServletFilter
[logging-analytics.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2017 Bell Canada & Amdocs Intellectual Property.  All rights reserved.
4
5 .. Links
6 .. _release-notes-label:
7
8 Log Enhancements Release Notes
9 ==============================
10 Version: 5.0.0 El Alto Early Drop Release
11 -----------------------------------------
12 El Alto Early Drop
13 ------------------
14    - logging-analytics Version: 1.5.0
15
16 :Release Date: 2019-08-16
17
18 **New Features**
19       None
20
21 **Bug Fixes**
22    - `LOG-1066 <https://jira.onap.org/browse/LOG-1066>`_ Vulnerability issue: upgrade org.apache.tomcat.embed.tomcat-embed-core to 8.5.42
23    - `LOG-1067 <https://jira.onap.org/browse/LOG-1067>`_ Vulnerability issue: confirm rather or not commons-codec is needed for logging projects
24
25 **Known Issues**
26
27 **Security Notes**
28
29 LOG code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/display/DW/El+Alto+Vulnerabilities>`_.
30
31 Quick Links:
32         - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
33
34         - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
35
36         - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=68541351>`_
37
38 **Upgrade Notes**
39       None
40
41 **Deprecation Notes**
42       None
43
44 **Other**
45       None
46
47
48 POMBA Release Notes
49 -------------------
50 POMBA is sub-project of the Logging Enhancements Project.
51
52 El Alto Early Drop
53 ------------------
54    - pomba-audit-common Version: 1.5.0
55    - pomba-aai-context-builder Version: 1.5.0
56    - pomba-context-aggregator Version: 1.5.0
57    - pomba-network-discovery-context-builder Version: 1.5.0
58    - pomba-sdc-context-builder Version: 1.5.0
59    - pomba-sdnc-context-builder Version: 1.5.0
60
61 :Release Date:  2019-08-16
62
63 **New Features**
64    - None
65
66 **Bug Fixes**
67    - `LOG-1066 <https://jira.onap.org/browse/LOG-1066>`_ Vulnerability issue: upgrade org.apache.tomcat.embed.tomcat-embed-core to 8.5.42
68    - `LOG-1067 <https://jira.onap.org/browse/LOG-1067>`_ Vulnerability issue: confirm rather or not commons-codec is needed for logging projects
69
70 **Known Issues**
71
72    - `LOG-1017 <https://jira.onap.org/browse/LOG-1017>`_ Violations are thrown on attributes that are same (or missing)
73    - `LOG-1016 <https://jira.onap.org/browse/LOG-1016>`_ When comparing attributes from multiple sources, violations thrown do not accurately show the issue.
74    - `LOG-836 <https://jira.onap.org/browse/LOG-836>`_ Logging/POMBA CLM: fix/address/red-flag glassfish bean-validator-2.4.0-b34.jar SEC
75    - `LOG-874 <https://jira.onap.org/browse/LOG-874>`_ Logging CLM: fix/address/red-flag License org.json:json-20140107.jar
76    - `LOG-832 <https://jira.onap.org/browse/LOG-832>`_ Logging/POMBA CLM: fix/address/red-flag SEC jackson-databind-2.4.5.jar - auditcommon - even 2.9.7 is still red
77    - `LOG-831 <https://jira.onap.org/browse/LOG-831>`_ Logging/POMBA CLM: fix/address/red-flag License javax.jms:jms-1.1.jar
78    - `LOG-769 <https://jira.onap.org/browse/LOG-769>`_ POMBA aai ctx pod reports HD full - but DF shows HD is OK
79    - `LOG-826 <https://jira.onap.org/browse/LOG-826>`_ Logging/POMBA CLM: fix/address/red-flag jackson-databind-2.8.11.3 SEC
80    - `LOG-1060 <https://jira.onap.org/browse/LOG-1060>`_ Logging CLM: fix/address/red-flag jackson-databind-2.8.6 SEC
81    - `LOG-1061 <https://jira.onap.org/browse/LOG-1061>`_ POMBA-AUDIT-COMMON CLM: fix/address/red-flag jackson-databind-2.4.5 SEC
82    - `LOG-1063 <https://jira.onap.org/browse/LOG-1063>`_ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag plexus-utils : 3.0.22 SEC
83    - `LOG-1064 <https://jira.onap.org/browse/LOG-1064>`_ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag commons-beanutils : 1.9.3 SEC
84    - `LOG-1062 <https://jira.onap.org/browse/LOG-1062>`_ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag struts-core : 1.3.8-2.4.5 SEC
85    - `LOG-827 <https://jira.onap.org/browse/LOG-827>`_ Logging/POMBA CLM: fix/address/red-flag handlebars-2.0.0.js SEC - upgrade to 4.0.0+
86    - `LOG-830 <https://jira.onap.org/browse/LOG-830>`_ Logging/POMBA CLM: fix/address/red-flag License org.json:json-20140107.jar
87
88 **Security Notes**
89    - all nodeports for Kibana, context builders and data-router are open by default for now
90
91 POMBA code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/display/DW/El+Alto+Vulnerabilities>`_.
92
93 Quick Links:
94    - `POMBA project page <https://wiki.onap.org/display/DW/POMBA>`_
95    - `See the result from LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
96    - `See the result from LOG <https://wiki.onap.org/pages/viewpage.action?pageId=68541351>`_
97
98 **Upgrade Notes**
99       None
100
101 **Deprecation Notes**
102       None
103
104 **Other**
105       None
106
107 Version: 4.0.0 Dublin Release
108 -----------------------------
109 Dublin
110 ------
111    - logging-analytics Version: 1.2.6
112
113 :Release Date: 2019-06-18
114
115 **New Features**
116
117 **Bug Fixes**
118    
119 **Known Issues**
120
121 **Security Notes**
122
123 LOG code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=64008625>`_.
124
125 Quick Links:
126         - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
127
128         - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
129
130         - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=51282493>`_
131
132 **Upgrade Notes**
133       None
134
135 **Deprecation Notes**
136       None
137
138 **Other**
139       None
140
141
142 POMBA Release Notes
143 -------------------
144 POMBA is sub-project of the Logging Enhancements Project.
145
146 Dublin
147 ------
148    - pomba-audit-common Version: 1.4.0
149    - pomba-aai-context-builder Version: 1.4.0
150    - pomba-context-aggregator Version: 1.4.0
151    - pomba-network-discovery-context-builder Version: 1.4.0
152    - pomba-sdc-context-builder Version: 1.4.0
153    - pomba-sdnc-context-builder Version: 1.4.0
154
155 :Release Date:  2019-06-18
156
157 **New Features**
158    - Version 2 of the audit common model
159    - Initial release of SDNC context builder
160
161 **Bug Fixes**
162
163
164 **Known Issues**
165
166    - `LOG-1017 <https://jira.onap.org/browse/LOG-1017>`_ Violations are thrown on attributes that are same (or missing)
167    - `LOG-1016 <https://jira.onap.org/browse/LOG-1016>`_ When comparing attributes from multiple sources, violations thrown do not accurately show the issue.
168    - `LOG-836 <https://jira.onap.org/browse/LOG-836>`_ Logging/POMBA CLM: fix/address/red-flag glassfish bean-validator-2.4.0-b34.jar SEC
169    - `LOG-874 <https://jira.onap.org/browse/LOG-874>`_ Logging CLM: fix/address/red-flag License org.json:json-20140107.jar
170    - `LOG-832 <https://jira.onap.org/browse/LOG-832>`_ Logging/POMBA CLM: fix/address/red-flag SEC jackson-databind-2.4.5.jar - auditcommon - even 2.9.7 is still red
171    - `LOG-831 <https://jira.onap.org/browse/LOG-831>`_ Logging/POMBA CLM: fix/address/red-flag License javax.jms:jms-1.1.jar
172    - `LOG-769 <https://jira.onap.org/browse/LOG-769>`_ POMBA aai ctx pod reports HD full - but DF shows HD is OK
173    - `LOG-826 <https://jira.onap.org/browse/LOG-826>`_ Logging/POMBA CLM: fix/address/red-flag jackson-databind-2.8.11.3 SEC
174    - `LOG-1060 <https://jira.onap.org/browse/LOG-1060>`_ Logging CLM: fix/address/red-flag jackson-databind-2.8.6 SEC
175    - `LOG-1061 <https://jira.onap.org/browse/LOG-1061>`_ POMBA-AUDIT-COMMON CLM: fix/address/red-flag jackson-databind-2.4.5 SEC
176    - `LOG-1063 <https://jira.onap.org/browse/LOG-1063>`_ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag plexus-utils : 3.0.22 SEC
177    - `LOG-1064 <https://jira.onap.org/browse/LOG-1064>`_ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag commons-beanutils : 1.9.3 SEC
178    - `LOG-1062 <https://jira.onap.org/browse/LOG-1062>`_ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag struts-core : 1.3.8-2.4.5 SEC
179    - `LOG-827 <https://jira.onap.org/browse/LOG-827>`_ Logging/POMBA CLM: fix/address/red-flag handlebars-2.0.0.js SEC - upgrade to 4.0.0+
180    - `LOG-830 <https://jira.onap.org/browse/LOG-830>`_ Logging/POMBA CLM: fix/address/red-flag License org.json:json-20140107.jar
181
182 **Security Notes**
183    - all nodeports for Kibana, context builders and data-router are open by default for now
184
185 POMBA code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=64008625>`_.
186
187 Quick Links:
188    - `POMBA project page <https://wiki.onap.org/display/DW/POMBA>`_
189    - `See the result from LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
190    - `See the result from LOG <https://wiki.onap.org/pages/viewpage.action?pageId=51282493>`_
191
192 **Upgrade Notes**
193       None
194
195 **Deprecation Notes**
196       None
197
198 **Other**
199       None
200
201 Version: 3.0.1 Casablanca Release
202 ---------------------------------
203 Casablanca
204 -----------
205    - logging-analytics Version: 1.2.6
206
207 --------------
208 :Release Date: 2019-02-08
209
210 **New Features**
211    - kubernetes installation upped to 1.11.5 in the Rancher 1.6.25 RI
212    - NFS support for AWS EFS
213
214 **Bug Fixes**
215    - `LOG-837 <https://jira.onap.org/browse/LOG-837>`_ Logging/POMBA CLM: fix/address/red-flag spring-mvc-5.1.2 pulls in spring-web-5.0.9
216
217 **Known Issues**
218
219    - `LOG-376 <https://jira.onap.org/browse/LOG-376>`_ Logstash load balancing is asymmetric wherever AAI is run
220    - `LOG-895 <https://jira.onap.org/browse/LOG-895>`_ Upgrade Rancher to 1.6.25 to address CVE-2018-1002105 and move to Kubernetes 1.11.5 (server side)
221
222 **Security Notes**
223
224 LOG code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45307852>`_.
225
226 Quick Links:
227         - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
228
229         - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
230
231         - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=45307852>`_
232
233 **Upgrade Notes**
234       None
235
236 **Deprecation Notes**
237       None
238
239 **Other**
240       None
241
242
243 POMBA Release Notes
244 -------------------
245 POMBA is sub-project of the Logging Enhancements Project.
246
247 Casablanca
248 ----------
249    - pomba-audit-common Version: 1.3.2
250    - pomba-aai-context-builder Version: 1.3.2
251    - pomba-context-aggregator Version: 1.3.4
252    - pomba-network-discovery-context-builder Version: 1.3.1
253    - pomba-sdc-context-builder Version: 1.3.2
254
255 --------------
256 :Release Date:  2019-02-08
257
258 **New Features**
259    - Version 1 of the audit common model
260    - Initial release of context aggregator and 3 context builders
261
262 **Bug Fixes**
263
264    - `LOG-892 <https://jira.onap.org/browse/LOG-892`_ PORT - POMBA Network Discovery Context Builder does not log
265
266 **Known Issues**
267
268    - `LOG-913 <https://jira.onap.org/browse/LOG-913>`_ POMBA: 1 of 11 pods failing on sequenced startup on 3.0.0-ONAP - pomba is 22 on the order - looks timing related
269    - `LOG-950 <https://jira.onap.org/browse/LOG-950>`_ LOG-950 upped the numbers from 10 to 30 – for intermittent deploy timing – this is an issue for several projects since 3.0.0-ONAP - the solution is a sequenced 5h deploy via `cd.sh <https://git.onap.org/logging-analytics/tree/deploy/cd.sh#n228>`_ and/or better vms for now until the `dependencies <https://wiki.onap.org/display/DW/Log+Streaming+Compliance+and+API#LogStreamingComplianceandAPI-DeploymentDependencyTree-Containerlevel>`_ and jobs are refactored into helm hooks
270
271 **Security Notes**
272    - all three nodeports for kibana, context builder and data-router are open by default for now
273
274 POMBA code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_.
275
276 Quick Links:
277    - `POMBA project page <https://wiki.onap.org/display/DW/POMBA>`_
278    - `See the result from LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
279    - `See the result from LOG <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_
280
281 **Upgrade Notes**
282       None
283
284 **Deprecation Notes**
285       None
286
287 **Other**
288       None
289
290
291 Version: 1.2.2 Casablanca
292 -------------------------
293
294 :Release Date: 2018-11-30
295
296 **New Features**
297    - Demo slf4j library with marker/mdc support along with kubernetes, docker, war support projects.
298
299 **Bug Fixes**
300
301
302 **Known Issues**
303    - `Logstash load balancing is asymmetric wherever AAI is run <https://jira.onap.org/browse/LOG-376>`_
304
305 **Security Notes**
306
307 LOG code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45307852>`_.
308
309 Quick Links:
310         - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
311
312         - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
313
314         - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=45307852>`_
315
316 **Upgrade Notes**
317       None
318
319 **Deprecation Notes**
320       None
321
322 **Other**
323       None
324
325
326 POMBA Release Notes
327 -------------------
328 POMBA is sub-project of the Logging Enhancements Project.
329
330 Casablanca
331 ----------
332    - pomba-audit-common Version: 1.3.1
333    - pomba-aai-context-builder Version: 1.3.1
334    - pomba-context-aggregator Version: 1.3.3
335    - pomba-network-discovery-context-builder Version: 1.3.0
336    - pomba-sdc-context-builder Version: 1.3.1
337
338
339 --------------
340
341 :Release Date: 2018-11-15
342
343 **New Features**
344    - Version 1 of the audit common model
345    - Initial release of context aggregator and 3 context builders
346
347 **Bug Fixes**
348
349
350 **Known Issues**
351
352
353 **Security Notes**
354    - all three nodeports for kibana, context builder and data-router are open by default for now
355
356 POMBA code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_.
357
358 Quick Links:
359    - `POMBA project page <https://wiki.onap.org/display/DW/POMBA>`_
360    - `See the result from LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
361    - `See the result from LOG <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_
362
363 **Upgrade Notes**
364       None
365
366 **Deprecation Notes**
367       None
368
369 **Other**
370       None
371
372 Version: Beijing
373 ----------------
374
375 :Release Date: 2018-06-07
376
377 **New Features**
378    - Logstash is a daemonset (clustered at 1 container per VM)
379    - `The following applications send logs to the ELK stack - <https://jira.onap.org/browse/LOG-230>`_
380
381 **Bug Fixes**
382
383
384 **Known Issues**
385    - Logstash load balancing is asymmetric
386
387 **Security Notes**
388    - all three nodeports for logstash, elasticsearch and kibana are open by default for now
389
390 LOG code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_.
391
392 Quick Links:
393         - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
394
395         - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
396
397         - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_
398
399 **Upgrade Notes**
400       None
401
402 **Deprecation Notes**
403       None
404
405 **Other**
406       Note: there was no released artifacts under 1.2.2 for Beijing - release was pushed to Casablanca
407
408
409
410 Version: 1.0.0
411 --------------
412
413 :Release Date: 2017-11-16
414
415 **New Features**
416
417 This release adds Elastic Stack analytics deployment to OOM, aligns logging provider configurations, and fixes issues with the propagation of transaction IDs and other contextual information.
418
419     - `LOG-1 <https://jira.onap.org/browse/LOG-1>`_ Transaction ID propagation.
420     - `LOG-2 <https://jira.onap.org/browse/LOG-2>`_ Standardized logging provider configuration.
421     - `LOG-3 <https://jira.onap.org/browse/LOG-3>`_ Elastic Stack reference analytics pipeline.
422     - `LOG-4 <https://jira.onap.org/browse/LOG-4>`_ Transaction ID conventions.
423
424 **Bug Fixes**
425
426     - `LOG-64 <https://jira.onap.org/browse/LOG-64>`_ Logger field has a length restriction of 36 which needs a fix.
427     - `LOG-74 <https://jira.onap.org/browse/LOG-74>`_ Extract componentName from the source path of log files.
428
429 **Known Issues**
430
431     - `LOG-43 <https://jira.onap.org/browse/LOG-43>`_
432       Unable to find logback xml for DMaaP component.
433       Logging file for DMaaP is available in this jar "eelf-core-0.0.1.jar".
434
435     - `LOG-65 <https://jira.onap.org/browse/LOG-65>`_
436       SO Logging Provider Config File need correction in Timestamp MDC.
437       Logging provider configuration file for SO i.e. logback files requires correction in Timestamp MDC for correct MDC generation in log.
438       The current pattern prints Timestamp as 2017-09-25 05:30:07,832. Expected  pattern is - 2017-09-25T05:30:07.832Z.
439
440     - `LOG-80 <https://jira.onap.org/browse/LOG-80>`_ Kibana does not seem to show all the logs from application pods.
441       The content of the log directories (/var/log/onap/mso) are not 100% reflected in Kibana.
442
443     - `LOG-88 <https://jira.onap.org/browse/LOG-88>`_
444       SO log format error during Health Check - blocking tracking jira for SO-246.
445
446 **Security Issues**
447       None
448
449 **Upgrade Notes**
450       None
451
452 **Deprecation Notes**
453       None
454
455 **Other**
456       None
457
458 ===========
459
460 End of Release Notes