Skip to content

Commit 1531ca7

Browse files
libanderlibander
committed
RHDEVDOCS-4897 - Logging 5.7.0 Release Notes.
1 parent 343c5e5 commit 1531ca7

10 files changed

+167
-25
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -607,7 +607,7 @@ Topics:
607607
- Name: Updating a cluster using the web console
608608
File: updating-cluster-within-minor
609609
- Name: Updating a cluster using the CLI
610-
File: updating-cluster-cli
610+
File: updating-cluster-cli
611611
- Name: Migrating to a cluster with multi-architecture compute machines
612612
File: migrating-to-multi-payload
613613
- Name: Performing update using canary rollout strategy
@@ -2437,20 +2437,20 @@ Distros: openshift-enterprise,openshift-origin
24372437
Topics:
24382438
- Name: Release notes
24392439
File: cluster-logging-release-notes
2440-
#- Name: Logging 5.7
2441-
# Dir: v5_7
2442-
# Distros: openshift-enterprise,openshift-origin
2443-
# Topics:
2444-
# Name: Logging 5.7 Release Notes
2445-
# File: logging-5-7-release-notes
2446-
# Name: Getting started with logging
2447-
# File: logging-5-7-getting-started
2448-
# Name: Understanding Logging
2449-
# File: logging-5-7-architecture
2450-
# Name: Configuring Logging
2451-
# File: logging-5-7-configuration
2452-
# Name: Administering Logging
2453-
# File: logging-5-7-administration
2440+
- Name: Logging 5.7
2441+
Dir: v5_7
2442+
Distros: openshift-enterprise,openshift-origin
2443+
Topics:
2444+
- Name: Logging 5.7 Release Notes
2445+
File: logging-5-7-release-notes
2446+
- Name: Getting started with logging
2447+
File: logging-5-7-getting-started
2448+
- Name: Understanding Logging
2449+
File: logging-5-7-architecture
2450+
- Name: Configuring Logging
2451+
File: logging-5-7-configuration
2452+
- Name: Administering Logging
2453+
File: logging-5-7-administration
24542454
# Name: Logging Reference
24552455
# File: logging-5-7-reference
24562456
- Name: Logging 5.6
@@ -2463,8 +2463,8 @@ Topics:
24632463
File: logging-5-6-getting-started
24642464
- Name: Understanding Logging
24652465
File: logging-5-6-architecture
2466-
# - Name: Configuring Logging
2467-
# File: logging-5-6-configuration
2466+
- Name: Configuring Logging
2467+
File: logging-5-6-configuration
24682468
- Name: Administering Logging
24692469
File: logging-5-6-administration
24702470
- Name: Logging Reference

‎logging/cluster-logging-release-notes.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ include::snippets/logging-compatibility-snip.adoc[]
1111

1212
include::snippets/logging-stable-updates-snip.adoc[]
1313

14+
include::modules/cluster-logging-rn-5.7.0.adoc[leveloffset=+1]
15+
1416
include::modules/cluster-logging-rn-5.6.5.adoc[leveloffset=+1]
1517

1618
include::modules/cluster-logging-rn-5.6.4.adoc[leveloffset=+1]

‎logging/v5_5/logging-5-5-configuration.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,5 @@ toc::[]
99
include::snippets/logging-crs-by-operator-snip.adoc[]
1010

1111
include::snippets/logging-supported-config-snip.adoc[]
12+
13+
include::modules/logging-multiline-except.adoc[leveoffset=+1]

‎logging/v5_6/logging-5-6-configuration.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,6 @@ include::snippets/logging-crs-by-operator-snip.adoc[]
1010

1111
include::snippets/logging-supported-config-snip.adoc[]
1212

13-
include::modules/logging-loki-retention.adoc[leveloffset=+1]
13+
include::modules/logging-loki-retention.adoc[leveoffset=+1]
14+
15+
include::modules/logging-multiline-except.adoc[leveoffset=+1]

‎logging/v5_7/logging-5-7-architecture.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,7 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
:context: logging-5-7-architecture
9+
:context: logging-5-7-architecture-overview
1010
include::modules/logging-architecture-overview.adoc[lines=9..31]
11+
12+
include::modules/logging-support-considerations.adoc[leveloffset=+1]

‎logging/v5_7/logging-5-7-configuration.adoc

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,6 @@ include::snippets/logging-crs-by-operator-snip.adoc[]
1010

1111
include::snippets/logging-supported-config-snip.adoc[]
1212

13-
include::modules/logging-loki-retention.adoc[leveloffset=+1]
13+
include::modules/logging-loki-retention.adoc[leveoffset=+1]
1414

15-
//include::modules/logging-loki-alerts.adoc[leveloffset=+1]
16-
17-
//[role="_additional-resources"]
18-
//.Additional resources
19-
//* xref:../../monitoring/enabling-alert-routing-for-user-defined-projects.html#enabling-a-separate-alertmanager-instance-for-user-defined-alert-routing_enabling-alert-routing-for-user-defined-projects[Enabling a separate alertmanager instance]
15+
include::modules/logging-multiline-except.adoc[leveoffset=+1]

‎logging/v5_7/logging-5-7-release-notes.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,5 @@ toc::[]
99
include::snippets/logging-compatibility-snip.adoc[]
1010

1111
include::snippets/logging-stable-updates-snip.adoc[]
12+
13+
include::modules/logging-rn-5.7.0.adoc[leveloffset=+1]

‎modules/cluster-logging-rn-5.7.0.adoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
//module included in cluster-logging-release-notes.adoc
2+
:content-type: REFERENCE
3+
[id="cluster-logging-release-notes-5-7-0{context}"]
4+
= Logging 5.7.0
5+
This release includes link:https://access.redhat.com/errata/RHBA-2023:2133[OpenShift Logging Bug Fix Release 5.7.0].
6+
7+
[id="openshift-logging-5-7-enhancements"]
8+
== Enhancements
9+
With this update, you can enable logging to detect multi-line exceptions and reassemble them into a single log entry.
10+
11+
To enable logging to detect multi-line exceptions and reassemble them into a single log entry, ensure that the `ClusterLogForwarder` Custom Resource (CR) contains a `detectMultilineErrors` field, with a value of `true`.
12+
13+
[id="openshift-logging-5-7-known-issues"]
14+
== Known Issues
15+
None.
16+
17+
[id="openshift-logging-5-7-0-bug-fixes"]
18+
== Bug fixes
19+
* Before this update, the `nodeSelector` attribute for the Gateway component of the LokiStack did not impact node scheduling. With this update, the `nodeSelector` attribute works as expected. (link:https://issues.redhat.com/browse/LOG-3713[LOG-3713])
20+
21+
[id="openshift-logging-5-7-0-CVEs"]
22+
== CVEs
23+
* link:https://access.redhat.com/security/cve/CVE-2023-1999[CVE-2023-1999]
24+
* link:https://access.redhat.com/security/cve/CVE-2023-28617[CVE-2023-28617]

‎modules/logging-multiline-except.adoc

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
// Module included in the following assemblies:
2+
//
3+
:_content-type: PROCEDURE
4+
[id="logging-multiline-except_{context}"]
5+
6+
= Enabling multi-line exception detection
7+
Enables multi-line error detection of container logs.
8+
9+
[WARNING]
10+
====
11+
Enabling this feature could have performance implications and may require additional computing resources or alternate logging solutions.
12+
====
13+
14+
Log parsers often incorrectly identify separate lines of the same exception as separate exceptions. This leads to extra log entries and an incomplete or inaccurate view of the traced information.
15+
16+
.Example java exception
17+
[,text]
18+
----
19+
java.lang.NullPointerException: Cannot invoke "String.toString()" because "<param1>" is null
20+
at testjava.Main.handle(Main.java:47)
21+
at testjava.Main.printMe(Main.java:19)
22+
at testjava.Main.main(Main.java:10)
23+
----
24+
25+
* To enable logging to detect multi-line exceptions and reassemble them into a single log entry, ensure that the `ClusterLogForwarder` Custom Resource (CR) contains a `detectMultilineErrors` field, with a value of `true`.
26+
27+
28+
.Example ClusterLogForwarder CR
29+
[source,yaml]
30+
----
31+
apiVersion: logging.openshift.io/v1
32+
kind: ClusterLogForwarder
33+
metadata:
34+
name: instance
35+
namespace: openshift-logging
36+
spec:
37+
pipelines:
38+
- name: my-app-logs
39+
inputRefs:
40+
- application
41+
outputRefs:
42+
- default
43+
detectMultilineErrors: true
44+
----
45+
46+
== Details
47+
When log messages appear as a consecutive sequence forming an exception stack trace, they are combined into a single, unified log record. The first log message's content is replaced with the concatenated content of all the message fields in the sequence.
48+
49+
.Supported languages per collector:
50+
|===
51+
|Language | Fluentd | Vector
52+
53+
|Java | ✓ | ✓
54+
|JS | ✓ | ✓
55+
|Ruby | ✓ | ✓
56+
|Python | ✓ | ✓
57+
|Golang | ✓ | ✓
58+
|PHP | ✓ |
59+
|Dart | ✓ | ✓
60+
|===
61+
62+
== Troubleshooting
63+
When enabled, the collector configuration will include a new section with type: `detect_exceptions`
64+
65+
.Example vector configuration section
66+
----
67+
[transforms.detect_exceptions_app-logs]
68+
type = "detect_exceptions"
69+
inputs = ["application"]
70+
languages = ["All"]
71+
group_by = ["kubernetes.namespace_name","kubernetes.pod_name","kubernetes.container_name"]
72+
expire_after_ms = 2000
73+
multiline_flush_interval_ms = 1000
74+
----
75+
76+
.Example fluentd config section
77+
----
78+
<label @MULTILINE_APP_LOGS>
79+
<match kubernetes.**>
80+
@type detect_exceptions
81+
remove_tag_prefix 'kubernetes'
82+
message message
83+
force_line_breaks true
84+
multiline_flush_interval .2
85+
</match>
86+
</label>
87+
88+
----

‎modules/logging-rn-5.7.0.adoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
//module included in logging-5-7-release-notes.adoc
2+
:content-type: REFERENCE
3+
[id="logging-release-notes-5-7-0{context}"]
4+
= Logging 5.7.0
5+
This release includes link:https://access.redhat.com/errata/RHBA-2023:2133[OpenShift Logging Bug Fix Release 5.7.0].
6+
7+
[id="logging-5-7-enhancements"]
8+
== Enhancements
9+
With this update, you can enable logging to detect multi-line exceptions and reassemble them into a single log entry.
10+
11+
To enable logging to detect multi-line exceptions and reassemble them into a single log entry, ensure that the `ClusterLogForwarder` Custom Resource (CR) contains a `detectMultilineErrors` field, with a value of `true`.
12+
13+
[id="logging-5-7-known-issues"]
14+
== Known Issues
15+
None.
16+
17+
[id="logging-5-7-0-bug-fixes"]
18+
== Bug fixes
19+
* Before this update, the `nodeSelector` attribute for the Gateway component of the LokiStack did not impact node scheduling. With this update, the `nodeSelector` attribute works as expected. (link:https://issues.redhat.com/browse/LOG-3713[LOG-3713])
20+
21+
[id="logging-5-7-0-CVEs"]
22+
== CVEs
23+
* link:https://access.redhat.com/security/cve/CVE-2023-1999[CVE-2023-1999]
24+
* link:https://access.redhat.com/security/cve/CVE-2023-28617[CVE-2023-28617]

0 commit comments

Comments
 (0)