Skip to content

Commit 02231ac

Browse files
kalexand-rhkalexand-rh
authored
Merge pull request #84940 from libander/OBSDOCS-1372-rb
Logging 6.1 Release Branch Merge
2 parents ea5aff6 + 1f7550d commit 02231ac

21 files changed

+1339
-4
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2973,6 +2973,23 @@ Topics:
29732973
File: log6x-visual
29742974
# - Name: API reference 6.0
29752975
# File: log6x-api-reference
2976+
- Name: Logging 6.1
2977+
Dir: logging-6.1
2978+
Topics:
2979+
- Name: Release notes
2980+
File: log6x-release-notes-6.1
2981+
- Name: About logging 6.1
2982+
File: log6x-about-6.1
2983+
- Name: Configuring log forwarding
2984+
File: log6x-clf-6.1
2985+
- Name: Configuring LokiStack storage
2986+
File: log6x-loki-6.1
2987+
- Name: Configuring LokiStack for OTLP
2988+
File: log6x-configuring-lokistack-otlp-6.1
2989+
- Name: OpenTelemetry data model
2990+
File: log6x-opentelemetry-data-model-6.1
2991+
- Name: Visualization for logging
2992+
File: log6x-visual-6.1
29762993
- Name: Support
29772994
File: cluster-logging-support
29782995
- Name: Troubleshooting logging

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

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
// Module included in the following assemblies:
2+
//log6x-release-notes-6.1
3+
= Logging 6.1.0 Release Notes
4+
:_mod-docs-content-type: REFERENCE
5+
[id="logging-release-notes-6-1-0_{context}"]
6+
7+
This release includes link:https://access.redhat.com/errata/RHBA-2024:9038[{OCP-short}{logging} Release 6.1.0].
8+
9+
[id="openshift-logging-release-notes-6-1-0-enhancements"]
10+
== New Features and Enhancements
11+
12+
=== Log Collection
13+
14+
* 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])
15+
16+
* 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])
17+
18+
* 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])
19+
20+
=== Log Storage
21+
22+
* 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])
23+
24+
[id="logging-release-notes-6-1-0-technology-preview-features"]
25+
== Technology Preview
26+
27+
:FeatureName: The OpenTelemetry Protocol (OTLP) output log forwarder
28+
include::snippets/technology-preview.adoc[]
29+
30+
* With this update, OpenTelemetry logs can now be forwarded using the `OTel` (OpenTelemetry) data model to a Red Hat Managed LokiStack instance. To enable this feature, add the `observability.openshift.io/tech-preview-otlp-output: "enabled"` annotation to your `ClusterLogForwarder` configuration. For additional configuration information, see link:https://github.com/openshift/cluster-logging-operator/blob/master/docs/features/logforwarding/outputs/opentelemetry-lokistack-forwarding.adoc[OTLP Forwarding].
31+
32+
* 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].
33+
34+
[id="logging-release-notes-6-1-0-bug-fixes_{context}"]
35+
== Bug Fixes
36+
None.
37+
38+
[id="logging-release-notes-6-1-0-CVEs_{context}"]
39+
== CVEs
40+
41+
* link:https://access.redhat.com/security/cve/CVE-2024-6119[CVE-2024-6119]
42+
* link:https://access.redhat.com/security/cve/CVE-2024-6232[CVE-2024-6232]

‎modules/log6x-configuring-lokistack-otlp-data-ingestion.adoc

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/logging/logging-6.0/log6x-configuring-lokistack-otlp.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="log6x-configuring-lokistack-otlp-data-ingestion_{context}"]
7+
= Configuring LokiStack for OTLP data ingestion
8+
9+
:FeatureName: The OpenTelemetry Protocol (OTLP) output log forwarder
10+
include::snippets/technology-preview.adoc[]
11+
12+
To configure a `LokiStack` custom resource (CR) for OTLP ingestion, follow these steps:
13+
14+
.Prerequisites
15+
16+
* Ensure that your Loki setup supports structured metadata, introduced in schema version 13 to enable OTLP log ingestion.
17+
18+
.Procedure
19+
20+
. Set the schema version:
21+
+
22+
** When creating a new `LokiStack` CR, set `version: v13` in the storage schema configuration.
23+
+
24+
[NOTE]
25+
====
26+
For existing configurations, add a new schema entry with `version: v13` and an `effectiveDate` in the future. For more information on updating schema versions, see link:https://grafana.com/docs/loki/latest/configure/storage/#upgrading-schemas[Upgrading Schemas] (Grafana documentation).
27+
====
28+
29+
. Configure the storage schema as follows:
30+
+
31+
.Example configure storage schema
32+
[source,yaml]
33+
----
34+
# ...
35+
spec:
36+
storage:
37+
schemas:
38+
- version: v13
39+
effectiveDate: 2024-10-25
40+
----
41+
+
42+
Once the `effectiveDate` has passed, the v13 schema takes effect, enabling your `LokiStack` to store structured metadata.

‎modules/log6x-configuring-otlp-output.adoc

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/logging/logging-6.0/log6x-clf.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="log6x-configuring-otlp-output_{context}"]
7+
= Configuring OTLP output
8+
9+
Cluster administrators can use the OpenTelemetry Protocol (OTLP) output to collect and forward logs to OTLP receivers. The OTLP output uses the specification defined by the https://opentelemetry.io/docs/specs/otlp/[OpenTelemetry Observability framework] to send data over HTTP with JSON encoding.
10+
11+
:FeatureName: The OpenTelemetry Protocol (OTLP) output log forwarder
12+
include::snippets/technology-preview.adoc[]
13+
14+
.Procedure
15+
16+
* Create or edit a `ClusterLogForwarder` custom resource (CR) to enable forwarding using OTLP by adding the following annotation:
17+
+
18+
.Example `ClusterLogForwarder` CR
19+
[source,yaml]
20+
----
21+
apiVersion: observability.openshift.io/v1
22+
kind: ClusterLogForwarder
23+
metadata:
24+
annotations:
25+
observability.openshift.io/tech-preview-otlp-output: "enabled" # <1>
26+
name: clf-otlp
27+
spec:
28+
serviceAccount:
29+
name: <service_account_name>
30+
outputs:
31+
- name: otlp
32+
type: otlp
33+
otlp:
34+
tuning:
35+
compression: gzip
36+
deliveryMode: AtLeastOnce
37+
maxRetryDuration: 20
38+
maxWrite: 10M
39+
minRetryDuration: 5
40+
url: <otlp_url> # <2>
41+
pipelines:
42+
- inputRefs:
43+
- application
44+
- infrastructure
45+
- audit
46+
name: otlp-logs
47+
outputRefs:
48+
- otlp
49+
----
50+
<1> Use this annotation to enable the OpenTelemetry Protocol (OTLP) output, which is a Technology Preview feature.
51+
<2> This URL must be absolute and is a placeholder for the OTLP endpoint where logs are sent.
52+
53+
[NOTE]
54+
====
55+
The OTLP output uses the OpenTelemetry data model, which is different from the ViaQ data model that is used by other output types. It adheres to the OTLP using https://opentelemetry.io/docs/specs/semconv/[OpenTelemetry Semantic Conventions] defined by the OpenTelemetry Observability framework.
56+
====

‎modules/log6x-loki-sizing.adoc

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
// Module is included in the following assemblies:
2+
// * observability/logging/logging-6.1/log6x-loki-6.1.adoc
3+
4+
:_mod-docs-content-type: CONCEPT
5+
[id="log6x-loki-sizing_{context}"]
6+
= Loki deployment sizing
7+
8+
Sizing for Loki follows the format of `1x.<size>` where the value `1x` is number of instances and `<size>` specifies performance capabilities.
9+
10+
The `1x.pico` configuration defines a single Loki deployment with minimal resource and limit requirements, offering high availability (HA) support for all Loki components. This configuration is suited for deployments that do not require a single replication factor or auto-compaction.
11+
12+
Disk requests are similar across size configurations, allowing customers to test different sizes to determine the best fit for their deployment needs.
13+
14+
15+
[IMPORTANT]
16+
====
17+
It is not possible to change the number `1x` for the deployment size.
18+
====
19+
20+
.Loki sizing
21+
[cols="1h,5*",options="header"]
22+
|===
23+
|
24+
|1x.demo
25+
|1x.pico [6.1+ only]
26+
|1x.extra-small
27+
|1x.small
28+
|1x.medium
29+
30+
|Data transfer
31+
|Demo use only
32+
|50GB/day
33+
|100GB/day
34+
|500GB/day
35+
|2TB/day
36+
37+
|Queries per second (QPS)
38+
|Demo use only
39+
|1-25 QPS at 200ms
40+
|1-25 QPS at 200ms
41+
|25-50 QPS at 200ms
42+
|25-75 QPS at 200ms
43+
44+
|Replication factor
45+
|None
46+
|2
47+
|2
48+
|2
49+
|2
50+
51+
|Total CPU requests
52+
|None
53+
|7 vCPUs
54+
|14 vCPUs
55+
|34 vCPUs
56+
|54 vCPUs
57+
58+
|Total CPU requests if using the ruler
59+
|None
60+
|8 vCPUs
61+
|16 vCPUs
62+
|42 vCPUs
63+
|70 vCPUs
64+
65+
|Total memory requests
66+
|None
67+
|17Gi
68+
|31Gi
69+
|67Gi
70+
|139Gi
71+
72+
73+
|Total memory requests if using the ruler
74+
|None
75+
|18Gi
76+
|35Gi
77+
|83Gi
78+
|171Gi
79+
80+
|Total disk requests
81+
|40Gi
82+
|590Gi
83+
|430Gi
84+
|430Gi
85+
|590Gi
86+
87+
|Total disk requests if using the ruler
88+
|80Gi
89+
|910Gi
90+
|750Gi
91+
|750Gi
92+
|910Gi
93+
|===

0 commit comments

Comments
 (0)