Update Release Notes
[logging-analytics.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3 Log Enhancements Release Notes
4 ==============================
5
6 Version: 1.2.2 Casablanca
7 --------------
8
9 :Release Date: 2018-11-30
10
11 **New Features**
12    - Demo slf4j library with marker/mdc support along with kubernetes, docker, war support projects.
13
14 **Bug Fixes**
15
16
17 **Known Issues**
18    - `Logstash load balancing is asymmetric wherever AAI is run <https://jira.onap.org/browse/LOG-376>`_
19
20 **Security Notes**
21
22 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>`_.
23
24 Quick Links:
25         - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
26
27         - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
28
29         - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=45307852>`_
30
31 **Upgrade Notes**
32       None
33
34 **Deprecation Notes**
35       None
36
37 **Other**
38       None
39
40
41 Version: Beijing
42 --------------
43
44 :Release Date: 2018-06-07
45
46 **New Features**
47    - Logstash is a daemonset (clustered at 1 container per VM)
48    - `The following applications send logs to the ELK stack - <https://jira.onap.org/browse/LOG-230>`_
49
50 **Bug Fixes**
51
52
53 **Known Issues**
54    - Logstash load balancing is asymmetric
55
56 **Security Notes**
57    - all three nodeports for logstash, elasticsearch and kibana are open by default for now
58
59 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>`_.
60
61 Quick Links:
62         - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
63
64         - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
65
66         - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_
67
68 **Upgrade Notes**
69       None
70
71 **Deprecation Notes**
72       None
73
74 **Other**
75       Note: there was no released artifacts under 1.2.2 for Beijing - release was pushed to Casablanca
76
77
78
79 Version: 1.0.0
80 --------------
81
82 :Release Date: 2017-11-16
83
84 **New Features**
85
86 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.
87
88     - `LOG-1 <https://jira.onap.org/browse/LOG-1>`_ Transaction ID propagation.
89     - `LOG-2 <https://jira.onap.org/browse/LOG-2>`_ Standardized logging provider configuration.
90     - `LOG-3 <https://jira.onap.org/browse/LOG-3>`_ Elastic Stack reference analytics pipeline.
91     - `LOG-4 <https://jira.onap.org/browse/LOG-4>`_ Transaction ID conventions.
92
93 **Bug Fixes**
94
95     - `LOG-64 <https://jira.onap.org/browse/LOG-64>`_ Logger field has a length restriction of 36 which needs a fix.
96     - `LOG-74 <https://jira.onap.org/browse/LOG-74>`_ Extract componentName from the source path of log files.
97
98 **Known Issues**
99
100     - `LOG-43 <https://jira.onap.org/browse/LOG-43>`_
101       Unable to find logback xml for DMaaP component.
102       Logging file for DMaaP is available in this jar "eelf-core-0.0.1.jar".
103
104     - `LOG-65 <https://jira.onap.org/browse/LOG-65>`_
105       SO Logging Provider Config File need correction in Timestamp MDC.
106       Logging provider configuration file for SO i.e. logback files requires correction in Timestamp MDC for correct MDC generation in log.
107       The current pattern prints Timestamp as 2017-09-25 05:30:07,832. Expected  pattern is - 2017-09-25T05:30:07.832Z.
108
109     - `LOG-80 <https://jira.onap.org/browse/LOG-80>`_ Kibana does not seem to show all the logs from application pods.
110       The content of the log directories (/var/log/onap/mso) are not 100% reflected in Kibana.
111
112     - `LOG-88 <https://jira.onap.org/browse/LOG-88>`_
113       SO log format error during Health Check - blocking tracking jira for SO-246.
114
115 **Security Issues**
116       None
117
118 **Upgrade Notes**
119       None
120
121 **Deprecation Notes**
122       None
123
124 **Other**
125       None
126
127 ===========
128
129 End of Release Notes