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

updated the config topics and deleted the otel-start-service module

Browse Source
This commit is contained in:
Tami Love
2025-06-18 22:31:27 -04:00
committed by openshift-cherrypick-robot
parent c60a6f7740
commit efd6465f60
5 changed files with 36 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
modules/microshift-otel-config-large.adoc
View File

@@ -8,6 +8,8 @@
You can configure {microshift-short} Observability to collect the maximum amount of performance and resource information, from the maximum number of sources, by updating the YAML file.
.Procedure
. Select a large configuration by adding the following information to the `/etc/microshift/observability/opentelemetry-collector.yaml` file. `Large` is the default configuration.
+
[source,yaml]
@@ -119,8 +121,14 @@ service:
exporter:
otlp:
protocol: http/protobuf
endpoint: http://${env:OTEL_BACKEND}:4318 <1>
endpoint: http://${env:OTEL_BACKEND}:4318 <2>
----
<1> Replace the variable `${env:OTEL_BACKEND}` with the IP address or host name of the remote back end. This IP address resolves to the local node's host name. Any unreachable endpoint is reported in the `microshift-observability` service logs.
<1> Replace the variable `${env:OTEL_BACKEND}` with the IP address or hostname of the remote back end. This IP address resolves to the local node's hostname. Any unreachable endpoint is reported in the `microshift-observability` service logs.
<2> Replace the variable `${env:OTEL_BACKEND}` with the IP address or hostname of the remote back end. This IP address resolves to the local node's hostname. Any unreachable endpoint is reported in the `microshift-observability` service logs.
. Restart {microshift-short} Observability to complete the configuration selection.
. Restart {microshift-short} Observability to complete the configuration selection by entering the following command:
+
[source,terminal]
----
$ sudo systemctl restart microshift-observability
----

14
modules/microshift-otel-config-medium.adoc
View File

@@ -8,6 +8,8 @@
You can configure {microshift-short} Observability to collect performance and resource information from various sources by updating the YAML file.
.Procedure
. Select a medium configuration by adding the following information to the `/etc/microshift/observability/opentelemetry-collector.yaml` file:
+
[source,yaml]
@@ -68,8 +70,14 @@ service:
exporter:
otlp:
protocol: http/protobuf
endpoint: http://${env:OTEL_BACKEND}:4318 <1>
endpoint: http://${env:OTEL_BACKEND}:4318 <2>
----
<1> Replace the variable `${env:OTEL_BACKEND}` with the IP address or host name of the remote back end. This IP address resolves to the local node's host name. Any unreachable endpoint is reported in the `microshift-observability` service logs.
<1> Replace the variable `${env:OTEL_BACKEND}` with the IP address or hostname of the remote back end. This IP address resolves to the local node's hostname. Any unreachable endpoint is reported in the `microshift-observability` service logs.
<2> Replace the variable `${env:OTEL_BACKEND}` with the IP address or hostname of the remote back end. This IP address resolves to the local node's hostname. Any unreachable endpoint is reported in the `microshift-observability` service logs.
. Restart {microshift-short} Observability to complete the configuration selection.
. Restart {microshift-short} Observability to complete the configuration selection by entering the following command:
+
[source,terminal]
----
$ sudo systemctl restart microshift-observability
----

14
modules/microshift-otel-config-small.adoc
View File

@@ -8,6 +8,8 @@
You can configure {microshift-short} Observability to collect the smallest amount of performance and resource information from various sources by updating the YAML file.
.Procedure
. Select a small configuration by adding the following information to the `/etc/microshift/observability/opentelemetry-collector.yaml` file:
+
[source,yaml]
@@ -60,8 +62,14 @@ service:
exporter:
otlp:
protocol: http/protobuf
endpoint: http://${env:OTEL_BACKEND}:4318 <1>
endpoint: http://${env:OTEL_BACKEND}:4318 <2>
----
<1> Replace the variable `${env:OTEL_BACKEND}` with the IP address or host name of the remote back end. This IP address resolves to the local node's host name. Any unreachable endpoint is reported in the {microshift-short} service logs.
<1> Replace the variable `${env:OTEL_BACKEND}` with the IP address or hostname of the remote back end. This IP address resolves to the local node's hostname. Any unreachable endpoint is reported in the {microshift-short} service logs.
<2> Replace the variable `${env:OTEL_BACKEND}` with the IP address or hostname of the remote back end. This IP address resolves to the local node's hostname. Any unreachable endpoint is reported in the {microshift-short} service logs.
. Restart {microshift-short} Observability to complete the configuration selection.
. Restart {microshift-short} Observability to complete the configuration selection by entering the following command:
+
[source,terminal]
----
$ sudo systemctl restart microshift-observability
----

5
modules/microshift-otel-config.adoc
View File

@@ -35,10 +35,11 @@ service:
exporter:
otlp:
protocol: http/protobuf
endpoint: http://${env:OTEL_BACKEND}:4318 <1>
endpoint: http://${env:OTEL_BACKEND}:4318 <2>
# ...
----
<1> Replace `${env:OTEL_BACKEND}` with the IP address or host name of the remote back end. This IP address resolves to the local node's host name. An unreachable endpoint is reported in the {microshift-short} service logs.
<1> Replace `${env:OTEL_BACKEND}` with the IP address or hostname of the remote back end. This IP address resolves to the local node's hostname. An unreachable endpoint is reported in the {microshift-short} service logs.
<2> Replace `${env:OTEL_BACKEND}` with the IP address or hostname of the remote back end. This IP address resolves to the local node's hostname. An unreachable endpoint is reported in the {microshift-short} service logs.
. Each time that you update the `opentelemetry-collector.yaml` file, you must restart {microshift-short} Observability to apply the updates.
+

18
modules/microshift-otel-start-service.adoc
View File

@@ -1,18 +0,0 @@
// Module included in the following assemblies:
//
// * microshift_running_apps/microshift-observability-service.adoc
// This module is no longer used and will be deleted in OCP 4.20
:_mod-docs-content-type: PROCEDURE
[id="microshift-otel-start-service_{context}"]
= Restarting {microshift-short} Observability
Each time you update the configuration file, you must restart the {microshift-short} Observability service.
. Restart the service by entering the following command:
[source,terminal]
----
$ sudo systemctl restart microshift-observability
----