openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity

RHDEVDOCS-4897 - Logging 5.7.0 Release Notes.

Browse Source
This commit is contained in:
libander
2023-05-10 13:29:31 -05:00
committed by openshift-cherrypick-robot
parent 84f24b7a52
commit c1fcedfbf8
10 changed files with 167 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
_topic_maps/_topic_map.yml
View File

@@ -607,7 +607,7 @@ Topics:
- Name: Updating a cluster using the web console
File: updating-cluster-within-minor
- Name: Updating a cluster using the CLI
File: updating-cluster-cli
File: updating-cluster-cli
- Name: Migrating to a cluster with multi-architecture compute machines
File: migrating-to-multi-payload
- Name: Performing update using canary rollout strategy
@@ -2436,20 +2436,20 @@ Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Release notes
File: cluster-logging-release-notes
#- Name: Logging 5.7
# Dir: v5_7
# Distros: openshift-enterprise,openshift-origin
# Topics:
# Name: Logging 5.7 Release Notes
# File: logging-5-7-release-notes
# Name: Getting started with logging
# File: logging-5-7-getting-started
# Name: Understanding Logging
# File: logging-5-7-architecture
# Name: Configuring Logging
# File: logging-5-7-configuration
# Name: Administering Logging
# File: logging-5-7-administration
- Name: Logging 5.7
Dir: v5_7
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Logging 5.7 Release Notes
File: logging-5-7-release-notes
- Name: Getting started with logging
File: logging-5-7-getting-started
- Name: Understanding Logging
File: logging-5-7-architecture
- Name: Configuring Logging
File: logging-5-7-configuration
- Name: Administering Logging
File: logging-5-7-administration
# Name: Logging Reference
# File: logging-5-7-reference
- Name: Logging 5.6
@@ -2462,8 +2462,8 @@ Topics:
File: logging-5-6-getting-started
- Name: Understanding Logging
File: logging-5-6-architecture
# - Name: Configuring Logging
# File: logging-5-6-configuration
- Name: Configuring Logging
File: logging-5-6-configuration
- Name: Administering Logging
File: logging-5-6-administration
- Name: Logging Reference

2
logging/cluster-logging-release-notes.adoc
View File

@@ -11,6 +11,8 @@ include::snippets/logging-compatibility-snip.adoc[]
include::snippets/logging-stable-updates-snip.adoc[]
include::modules/cluster-logging-rn-5.7.0.adoc[leveloffset=+1]
include::modules/cluster-logging-rn-5.6.5.adoc[leveloffset=+1]
include::modules/cluster-logging-rn-5.6.4.adoc[leveloffset=+1]

2
logging/v5_5/logging-5-5-configuration.adoc
View File

@@ -9,3 +9,5 @@ toc::[]
include::snippets/logging-crs-by-operator-snip.adoc[]
include::snippets/logging-supported-config-snip.adoc[]
include::modules/logging-multiline-except.adoc[leveoffset=+1]

4
logging/v5_6/logging-5-6-configuration.adoc
View File

@@ -10,4 +10,6 @@ include::snippets/logging-crs-by-operator-snip.adoc[]
include::snippets/logging-supported-config-snip.adoc[]
include::modules/logging-loki-retention.adoc[leveloffset=+1]
include::modules/logging-loki-retention.adoc[leveoffset=+1]
include::modules/logging-multiline-except.adoc[leveoffset=+1]

4
logging/v5_7/logging-5-7-architecture.adoc
View File

@@ -6,5 +6,7 @@ include::_attributes/common-attributes.adoc[]
toc::[]
:context: logging-5-7-architecture
:context: logging-5-7-architecture-overview
include::modules/logging-architecture-overview.adoc[lines=9..31]
include::modules/logging-support-considerations.adoc[leveloffset=+1]

8
logging/v5_7/logging-5-7-configuration.adoc
View File

@@ -10,10 +10,6 @@ include::snippets/logging-crs-by-operator-snip.adoc[]
include::snippets/logging-supported-config-snip.adoc[]
include::modules/logging-loki-retention.adoc[leveloffset=+1]
include::modules/logging-loki-retention.adoc[leveoffset=+1]
//include::modules/logging-loki-alerts.adoc[leveloffset=+1]
//[role="_additional-resources"]
//.Additional resources
//* 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]
include::modules/logging-multiline-except.adoc[leveoffset=+1]

2
logging/v5_7/logging-5-7-release-notes.adoc
View File

@@ -9,3 +9,5 @@ toc::[]
include::snippets/logging-compatibility-snip.adoc[]
include::snippets/logging-stable-updates-snip.adoc[]
include::modules/logging-rn-5.7.0.adoc[leveloffset=+1]

24
modules/cluster-logging-rn-5.7.0.adoc Normal file
View File

@@ -0,0 +1,24 @@
//module included in cluster-logging-release-notes.adoc
:content-type: REFERENCE
[id="cluster-logging-release-notes-5-7-0{context}"]
= Logging 5.7.0
This release includes link:https://access.redhat.com/errata/RHBA-2023:2133[OpenShift Logging Bug Fix Release 5.7.0].
[id="openshift-logging-5-7-enhancements"]
== Enhancements
With this update, you can enable logging to detect multi-line exceptions and reassemble them into a single log entry.
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`.
[id="openshift-logging-5-7-known-issues"]
== Known Issues
None.
[id="openshift-logging-5-7-0-bug-fixes"]
== Bug fixes
* 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])
[id="openshift-logging-5-7-0-CVEs"]
== CVEs
* link:https://access.redhat.com/security/cve/CVE-2023-1999[CVE-2023-1999]
* link:https://access.redhat.com/security/cve/CVE-2023-28617[CVE-2023-28617]

88
modules/logging-multiline-except.adoc Normal file
View File

@@ -0,0 +1,88 @@
// Module included in the following assemblies:
//
:_content-type: PROCEDURE
[id="logging-multiline-except_{context}"]
= Enabling multi-line exception detection
Enables multi-line error detection of container logs.
[WARNING]
====
Enabling this feature could have performance implications and may require additional computing resources or alternate logging solutions.
====
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.
.Example java exception
[,text]
----
java.lang.NullPointerException: Cannot invoke "String.toString()" because "<param1>" is null
at testjava.Main.handle(Main.java:47)
at testjava.Main.printMe(Main.java:19)
at testjava.Main.main(Main.java:10)
----
* 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`.
.Example ClusterLogForwarder CR
[source,yaml]
----
apiVersion: logging.openshift.io/v1
kind: ClusterLogForwarder
metadata:
name: instance
namespace: openshift-logging
spec:
pipelines:
- name: my-app-logs
inputRefs:
- application
outputRefs:
- default
detectMultilineErrors: true
----
== Details
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.
.Supported languages per collector:
|===
|Language | Fluentd | Vector
|Java | ✓ | ✓
|JS | ✓ | ✓
|Ruby | ✓ | ✓
|Python | ✓ | ✓
|Golang | ✓ | ✓
|PHP | ✓ |
|Dart | ✓ | ✓
|===
== Troubleshooting
When enabled, the collector configuration will include a new section with type: `detect_exceptions`
.Example vector configuration section
----
[transforms.detect_exceptions_app-logs]
type = "detect_exceptions"
inputs = ["application"]
languages = ["All"]
group_by = ["kubernetes.namespace_name","kubernetes.pod_name","kubernetes.container_name"]
expire_after_ms = 2000
multiline_flush_interval_ms = 1000
----
.Example fluentd config section
----
<label @MULTILINE_APP_LOGS>
<match kubernetes.**>
@type detect_exceptions
remove_tag_prefix 'kubernetes'
message message
force_line_breaks true
multiline_flush_interval .2
</match>
</label>
----

24
modules/logging-rn-5.7.0.adoc Normal file
View File

@@ -0,0 +1,24 @@
//module included in logging-5-7-release-notes.adoc
:content-type: REFERENCE
[id="logging-release-notes-5-7-0{context}"]
= Logging 5.7.0
This release includes link:https://access.redhat.com/errata/RHBA-2023:2133[OpenShift Logging Bug Fix Release 5.7.0].
[id="logging-5-7-enhancements"]
== Enhancements
With this update, you can enable logging to detect multi-line exceptions and reassemble them into a single log entry.
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`.
[id="logging-5-7-known-issues"]
== Known Issues
None.
[id="logging-5-7-0-bug-fixes"]
== Bug fixes
* 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])
[id="logging-5-7-0-CVEs"]
== CVEs
* link:https://access.redhat.com/security/cve/CVE-2023-1999[CVE-2023-1999]
* link:https://access.redhat.com/security/cve/CVE-2023-28617[CVE-2023-28617]