Skip to content

Commit 79f9ed2

Browse files
committed
[SRVCOM-2451] Log config docs for Serving and Eventing
Fix table in module for SRVCOM-2451 Fix trailing spaces in topic map for SRVCOM-2451 Fix trailing spaces in topic map again for SRVCOM-2451 QE feedback for SRVCOM-2451 EOF newline PR feedback SRVCOM-2451 PR feedback for SRVCOM-2451 Add warning for SRVCOM-2451 Fix newline for SRVCOM-2451 MR feedback for SRVCOM-2451
1 parent ad01cda commit 79f9ed2

File tree

4 files changed

+109
-0
lines changed

4 files changed

+109
-0
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -419,6 +419,8 @@ Topics:
419419
File: serverless-tracing-open-telemetry
420420
- Name: Using Jaeger distributed tracing
421421
File: serverless-tracing-jaeger
422+
- Name: Configuring log settings for Serving and Eventing
423+
File: serverless-config-log-settings
422424
---
423425
# Integrations
424426
Name: Integrations
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+
// * serverless/observability/serverless-config-log-settings.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="serverless-config-log-settings-serving-eventing_{context}"]
7+
= Configuring log settings
8+
9+
You can configure logging for Serving and Eventing in the `KnativeServing` custom resource (CR) and `KnativeEventing` CR.
10+
11+
.Procedure
12+
13+
* Configure the log settings for Serving and Eventing by setting or modifying the `loglevel` value in the `KnativeServing` and `KnativeEventing` CR respectively. Here are two example configurations with all possible logging options set to level `info`:
14+
+
15+
.KnativeServing CR
16+
[source,yaml]
17+
----
18+
apiVersion: operator.knative.dev/v1beta1
19+
kind: KnativeServing
20+
metadata:
21+
name: knative-serving
22+
namespace: knative-serving
23+
spec:
24+
config:
25+
logging:
26+
loglevel.controller: "info"
27+
loglevel.autoscaler: "info"
28+
loglevel.queueproxy: "info"
29+
loglevel.webhook: "info"
30+
loglevel.activator: "info"
31+
loglevel.hpaautoscaler: "info"
32+
loglevel.net-certmanager-controller: "info"
33+
loglevel.net-istio-controller: "info"
34+
loglevel.net-kourier-controller: "info"
35+
----
36+
+
37+
.KnativeEventing CR
38+
[source,yaml]
39+
----
40+
apiVersion: operator.knative.dev/v1beta1
41+
kind: KnativeEventing
42+
metadata:
43+
name: knative-eventing
44+
namespace: knative-eventing
45+
spec:
46+
config:
47+
logging:
48+
loglevel.controller: "info"
49+
loglevel.eventing-webhook: "info"
50+
loglevel.inmemorychannel-dispatcher: "info"
51+
loglevel.inmemorychannel-webhook: "info"
52+
loglevel.mt-broker-controller: "info"
53+
loglevel.mt_broker_filter: "info"
54+
loglevel.mt_broker_ingress: "info"
55+
loglevel.pingsource-mt-adapter: "info"
56+
----
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * serverless/observability/serverless-config-log-settings.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="serverless-config-log-supported-log-levels_{context}"]
7+
= Supported log levels
8+
9+
The following `loglevel` values are supported:
10+
11+
.Supported log levels
12+
[cols=2*,options="header"]
13+
|===
14+
|Log level
15+
|Description
16+
17+
|`debug`
18+
|Fine-grained debugging
19+
20+
|`info`
21+
|Normal logging
22+
23+
|`warn`
24+
|Unexpected but non-critical errors
25+
26+
|`error`
27+
|Critical errors; unexpected during normal operation
28+
29+
30+
|`dpanic`
31+
|In debug mode, trigger a panic (crash)
32+
33+
|===
34+
35+
[WARNING]
36+
====
37+
Using the `debug` level for production might negatively affect performance.
38+
====
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="serverless-config-log-setting"]
4+
= Configuring log settings for Serving and Eventing
5+
:context: serverless-config-log-setting
6+
7+
toc::[]
8+
9+
You can configure logging for OpenShift Serverless Serving and OpenShift Serverless Eventing using the `KnativeServing` and `KnativeEventing` custom resource (CR). The level of logging is determined by the specified `loglevel` value.
10+
11+
include::modules/serverless-config-log-supported-log-levels.adoc[leveloffset=+1]
12+
13+
include::modules/serverless-config-log-settings-serving-eventing.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)