diff --git a/modules/microshift-otel-config-large.adoc b/modules/microshift-otel-config-large.adoc index 13155f46e1..517332a015 100644 --- a/modules/microshift-otel-config-large.adoc +++ b/modules/microshift-otel-config-large.adoc @@ -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. \ No newline at end of file +. Restart {microshift-short} Observability to complete the configuration selection by entering the following command: ++ +[source,terminal] +---- +$ sudo systemctl restart microshift-observability +---- \ No newline at end of file diff --git a/modules/microshift-otel-config-medium.adoc b/modules/microshift-otel-config-medium.adoc index 569db4cf40..64e36a87e2 100644 --- a/modules/microshift-otel-config-medium.adoc +++ b/modules/microshift-otel-config-medium.adoc @@ -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. \ No newline at end of file +. Restart {microshift-short} Observability to complete the configuration selection by entering the following command: ++ +[source,terminal] +---- +$ sudo systemctl restart microshift-observability +---- \ No newline at end of file diff --git a/modules/microshift-otel-config-small.adoc b/modules/microshift-otel-config-small.adoc index c9a5b90517..cafa0f2e24 100644 --- a/modules/microshift-otel-config-small.adoc +++ b/modules/microshift-otel-config-small.adoc @@ -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. \ No newline at end of file +. Restart {microshift-short} Observability to complete the configuration selection by entering the following command: ++ +[source,terminal] +---- +$ sudo systemctl restart microshift-observability +---- \ No newline at end of file diff --git a/modules/microshift-otel-config.adoc b/modules/microshift-otel-config.adoc index d50a0d4f78..16c8510371 100644 --- a/modules/microshift-otel-config.adoc +++ b/modules/microshift-otel-config.adoc @@ -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. + diff --git a/modules/microshift-otel-start-service.adoc b/modules/microshift-otel-start-service.adoc deleted file mode 100644 index 8eabc7905b..0000000000 --- a/modules/microshift-otel-start-service.adoc +++ /dev/null @@ -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 ----- - \ No newline at end of file