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