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

Update log6x-quickstart-opentelemetry.adoc

Browse Source 
- Here is the link:
https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/logging/logging-6-1#quick-start-opentelemetry_logging-6x-6.1

- Problems:

  - Prerequisites are missing.
  - Operators names are not highlighted.
  - Step 4, namespace name is missing from the command
  - Step 5, namespace name is missing from the command

- We are performing the following changes through this PR:

  - Added required Prerequisites.
  - Highlighted the Operator's names in Step 1.
  - Namespace name is added in the Step 4
  - Removed $ oc project openshift-logging, and added namespace in the remaining 3 commands.

1-Update modules/log6x-quickstart-opentelemetry.adoc

16 - * You installed the {oc-first}.
16 + * You have installed the {oc-first}.

Co-authored-by: Agil Antony <61876435+agantony@users.noreply.github.com>

2- Update modules/log6x-quickstart-opentelemetry.adoc

- * Verify that OTLP is functioning correctly by going to *Observe* -> *OpenShift Logging* -> *LokiStack* -> *Writes* in the OpenShift web console, and checking *Distributor - Structured Metadata*.
+ * To verify that OTLP is functioning correctly, complete the following steps:
+ .. In the OpenShift web console, click *Observe* -> *OpenShift Logging* -> *LokiStack* -> *Writes*.
+ .. Check the *Distributor - Structured Metadata* section.

Co-authored-by: Agil Antony <61876435+agantony@users.noreply.github.com>
This commit is contained in:
Prithviraj Patil
2025-04-24 23:42:09 +05:30
committed by openshift-cherrypick-robot
parent 704a706c11
commit 73a190a714
1 changed files with 12 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
modules/log6x-quickstart-opentelemetry.adoc
View File

@@ -12,11 +12,13 @@ include::snippets/technology-preview.adoc[]
To configure OTLP ingestion and enable the OpenTelemetry data model, follow these steps:
.Prerequisites
* Cluster administrator permissions
* You have access to an {product-title} cluster with `cluster-admin` permissions.
* You have installed the {oc-first}.
* You have access to a supported object store. For example, AWS S3, Google Cloud Storage, {azure-short}, Swift, Minio, or {rh-storage}.
.Procedure
. Install the {clo}, {loki-op}, and {coo-first} from OperatorHub.
. Install the `{clo}`, `{loki-op}`, and `{coo-first}` from OperatorHub.
. Create a `LokiStack` custom resource (CR) in the `openshift-logging` namespace:
+
@@ -58,7 +60,7 @@ $ oc create sa collector -n openshift-logging
+
[source,terminal]
----
$ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z collector
$ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z collector -n openshift-logging
----
+
[NOTE]
@@ -66,26 +68,21 @@ $ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z collec
The `ClusterRole` resource is created automatically during the Cluster Logging Operator installation and does not need to be created manually.
====
. Allow the collector's service account to collect logs:
. To collect logs, use the service account of the collector by running the following commands:
+
[source,terminal]
----
$ oc project openshift-logging
$ oc adm policy add-cluster-role-to-user collect-application-logs -z collector -n openshift-logging
----
+
[source,terminal]
----
$ oc adm policy add-cluster-role-to-user collect-application-logs -z collector
$ oc adm policy add-cluster-role-to-user collect-audit-logs -z collector -n openshift-logging
----
+
[source,terminal]
----
$ oc adm policy add-cluster-role-to-user collect-audit-logs -z collector
----
+
[source,terminal]
----
$ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z collector
$ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z collector -n openshift-logging
----
+
[NOTE]
@@ -155,4 +152,6 @@ You cannot use `lokiStack.labelKeys` when `dataModel` is `Otel`. To achieve simi
====
.Verification
* Verify that OTLP is functioning correctly by going to *Observe* -> *OpenShift Logging* -> *LokiStack* -> *Writes* in the OpenShift web console, and checking *Distributor - Structured Metadata*.
* To verify that OTLP is functioning correctly, complete the following steps:
.. In the OpenShift web console, click *Observe* -> *OpenShift Logging* -> *LokiStack* -> *Writes*.
.. Check the *Distributor - Structured Metadata* section.