Skip to content

Commit 959d1c6

Browse files
kalexand-rhkalexand-rh
authored
Merge pull request #91760 from briandooley/logging-docs-6.2
Merging 6.2 into main
2 parents 27c094c + 18de382 commit 959d1c6

File tree

53 files changed

+1517
-157
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+1517
-157
lines changed

‎_topic_maps/_topic_map.yml

+23
Original file line numberDiff line numberDiff line change
@@ -3016,15 +3016,38 @@ Topics:
30163016
# File: logging-5-8-release-notes
30173017
# - Name: Logging 5.7
30183018
# File: logging-5-7-release-notes
3019+
- Name: Logging 6.2
3020+
Dir: logging-6.2
3021+
Topics:
3022+
- Name: Support
3023+
File: log62-cluster-logging-support
3024+
- Name: Release notes
3025+
File: log6x-release-notes-6.2
3026+
- Name: About logging 6.2
3027+
File: log6x-about-6.2
3028+
- Name: Configuring log forwarding
3029+
File: log6x-clf-6.2
3030+
- Name: Configuring the logging collector
3031+
File: 6x-cluster-logging-collector-6.2
3032+
- Name: Configuring LokiStack storage
3033+
File: log6x-loki-6.2
3034+
- Name: Configuring LokiStack for OTLP
3035+
File: log6x-configuring-lokistack-otlp-6.2
3036+
- Name: Visualization for logging
3037+
File: log6x-visual-6.2
30193038
- Name: Logging 6.1
30203039
Dir: logging-6.1
30213040
Topics:
3041+
- Name: Support
3042+
File: log61-cluster-logging-support
30223043
- Name: Release notes
30233044
File: log6x-release-notes-6.1
30243045
- Name: About logging 6.1
30253046
File: log6x-about-6.1
30263047
- Name: Configuring log forwarding
30273048
File: log6x-clf-6.1
3049+
- Name: Configuring the logging collector
3050+
File: 6x-cluster-logging-collector-6.1
30283051
- Name: Configuring LokiStack storage
30293052
File: log6x-loki-6.1
30303053
- Name: Configuring LokiStack for OTLP

‎modules/cluster-logging-maintenance-support-list-6x.adoc

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/logging/logging-6.0/log60-cluster-logging-support.adoc
4+
// * observability/logging/logging-6.1/log61-cluster-logging-support.adoc
5+
// * observability/logging/logging-6.2/log62-cluster-logging-support.adoc
6+
7+
:_mod-docs-content-type: REFERENCE
8+
[id="cluster-logging-maintenance-support-list_{context}"]
9+
= Unsupported configurations
10+
11+
You must set the Red{nbsp}Hat OpenShift Logging Operator to the `Unmanaged` state to modify the following components:
12+
13+
* The collector configuration file
14+
15+
* The collector daemonset
16+
17+
Explicitly unsupported cases include:
18+
19+
* *Configuring the logging collector using environment variables*. You cannot use environment variables to modify the log collector.
20+
21+
* *Configuring how the log collector normalizes logs*. You cannot modify default log normalization.

‎modules/cluster-logging-maintenance-support-list.adoc

+2-7
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,14 @@
77

88
You must set the Red{nbsp}Hat OpenShift Logging Operator to the `Unmanaged` state to modify the following components:
99

10-
* The `Elasticsearch` custom resource (CR)
11-
12-
* The Kibana deployment
13-
1410
* The `fluent.conf` file
1511

1612
* The Fluentd daemon set
1713

18-
You must set the OpenShift Elasticsearch Operator to the `Unmanaged` state to modify the Elasticsearch deployment files.
14+
* The `vector.toml` file for Vector collector deployments
1915

20-
Explicitly unsupported cases include:
2116

22-
* *Configuring default log rotation*. You cannot modify the default log rotation configuration.
17+
Explicitly unsupported cases include:
2318

2419
* *Configuring the collected log location*. You cannot change the location of the log collector output file, which by default is `/var/log/fluentd/fluentd.log`.
2520

‎modules/log-collector-http-server.adoc

+4-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
//
33
// * observability/logging/log_collection_forwarding/cluster-logging-collector.adoc
44

5+
6+
//This file is for Logging 5.x
7+
58
:_mod-docs-content-type: PROCEDURE
69
[id="log-collector-http-server_{context}"]
710
= Configuring the collector to receive audit logs as an HTTP server
@@ -23,7 +26,7 @@ You can configure your log collector to listen for HTTP connections and receive
2326
.Example `ClusterLogForwarder` CR if you are using a multi log forwarder deployment
2427
[source,yaml]
2528
----
26-
apiVersion: logging.openshift.io/v1beta1
29+
apiVersion: logging.openshift.io/v1
2730
kind: ClusterLogForwarder
2831
metadata:
2932
# ...

‎modules/log-collector-rsyslog-server.adoc

-84
This file was deleted.

‎modules/log6x-6-2-0-rn.adoc

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/logging/logging-6.2/log6x-release-notes-6.2.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="logging-release-notes-6-2-0_{context}"]
7+
= Logging 6.2.0 Release Notes
8+
9+
////
10+
TOFIX
11+
This release includes link:https://access.redhat.com/errata/RHBA-2024:9038[{logging-uc} {for} Bug Fix Release 6.2.0].
12+
////
13+
14+
[id="openshift-logging-release-notes-6-2-0-enhancements_{context}"]
15+
== New Features and Enhancements
16+
17+
////
18+
TOFIX:
19+
=== Log Collection
20+
21+
* This enhancement adds the source `iostream` to the attributes sent from collected container logs. The value is set to either `stdout` or `stderr` based on how the collector received it. (link:https://issues.redhat.com/browse/LOG-5292[LOG-5292])
22+
23+
* With this update, the default memory limit for the collector increases from 1024 Mi to 2048 Mi. Users should adjust resource limits based on their cluster’s specific needs and specifications. (link:https://issues.redhat.com/browse/LOG-6072[LOG-6072])
24+
25+
* With this update, users can now set the syslog output delivery mode of the `ClusterLogForwarder` CR to either `AtLeastOnce` or `AtMostOnce.` (link:https://issues.redhat.com/browse/LOG-6355[LOG-6355])
26+
27+
=== Log Storage
28+
29+
* With this update, the new `1x.pico` LokiStack size supports clusters with fewer workloads and lower log volumes (up to 50GB/day). (link:https://issues.redhat.com/browse/LOG-5939[LOG-5939])
30+
31+
////
32+
33+
[id="logging-release-notes-6-2-0-technology-preview-features_{context}"]
34+
== Technology Preview
35+
36+
:FeatureName: The OpenTelemetry Protocol (OTLP) output log forwarder
37+
include::snippets/technology-preview.adoc[]
38+
39+
////
40+
* With this update, a `dataModel` field has been added to the `lokiStack` output specification. Set the `dataModel` to `Otel` to configure log forwarding using the OpenTelemetry data format. The default is set to `Viaq`. For information about data mapping see link:https://opentelemetry.io/docs/specs/otlp/[OTLP Specification].
41+
42+
////
43+
44+
[id="logging-release-notes-6-2-0-bug-fixes_{context}"]
45+
== Bug Fixes
46+
////
47+
TOFIX:
48+
None.
49+
////
50+
51+
[id="logging-release-notes-6-2-0-CVEs_{context}"]
52+
== CVEs
53+
////
54+
TOFIX:
55+
* link:https://access.redhat.com/security/cve/CVE-2024-6119[CVE-2024-6119]
56+
* link:https://access.redhat.com/security/cve/CVE-2024-6232[CVE-2024-6232]
57+
////

‎modules/log6x-cluster-logging-collector-limits.adoc

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/logging/cluster-logging-collector.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="log6x-cluster-logging-collector-limits_{context}"]
7+
= Configure log collector CPU and memory limits
8+
9+
Use the log collector to adjust the CPU and memory limits.
10+
11+
.Procedure
12+
13+
* Edit the `ClusterLogForwarder` custom resource (CR):
14+
+
15+
[source,terminal]
16+
----
17+
$ oc -n openshift-logging edit ClusterLogging instance
18+
----
19+
+
20+
[source,yaml]
21+
----
22+
apiVersion: observability.openshift.io/v1
23+
kind: ClusterLogForwarder
24+
metadata:
25+
name: instance
26+
namespace: openshift-logging
27+
spec:
28+
collector:
29+
resources:
30+
limits: <1>
31+
memory: 736Mi
32+
requests:
33+
cpu: 100m
34+
memory: 736Mi
35+
# ...
36+
----
37+
<1> Specify the CPU and memory limits and requests as needed. The values shown are the default values.

0 commit comments

Comments
 (0)