Skip to content

Commit 0c803ed

Browse files
smunje1briandooley
authored andcommitted
OBSDOCS-1361
1 parent a2ef3ae commit 0c803ed

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed
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+
====

observability/logging/logging-6.0/log6x-clf.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ syslog:: Forwards logs to an external syslog server.
8888

8989
Each output type has its own configuration fields.
9090

91+
include::modules/log6x-configuring-otlp-output.adoc[leveloffset=+1]
92+
9193
=== Pipelines
9294

9395
Pipelines are configured in an array under `spec.pipelines`. Each pipeline must have a unique name and consists of:

0 commit comments

Comments
 (0)