mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
52 lines
2.0 KiB
Plaintext
52 lines
2.0 KiB
Plaintext
// Module included in the following assemblies:
|
|
//
|
|
// microshift_running_apps/microshift-observability-service.adoc
|
|
|
|
:_mod-docs-content-type: PROCEDURE
|
|
[id="microshift-otel-config_{context}"]
|
|
= Configuring {microshift-short} Observability
|
|
|
|
[role="_abstract"]
|
|
You must configure {microshift-short} Observability after it is installed by specifying a valid endpoint. If an endpoint is not specified, {microshift-short} Observability does not start. You can specify any OpenTelemetry Protocol (OTLP)-compatible endpoint for each configuration before starting {microshift-short}.
|
|
|
|
.Procedure
|
|
|
|
. Update the `/etc/microshift/observability/opentelemetry-collector.yaml` file to specify an OTLP-compatible endpoint with the following information. The endpoint must link to an IP address or host name, and port number of an OTLP service.
|
|
+
|
|
.OTLP-compatible endpoint configuration
|
|
[source,yaml]
|
|
----
|
|
# ...
|
|
exporters:
|
|
otlp:
|
|
sending_queue:
|
|
storage: file_storage
|
|
endpoint: ${env:OTEL_BACKEND}:4317 <1>
|
|
tls:
|
|
insecure: true
|
|
# ...
|
|
service:
|
|
# ...
|
|
telemetry:
|
|
metrics:
|
|
readers:
|
|
- periodic:
|
|
exporter:
|
|
otlp:
|
|
protocol: http/protobuf
|
|
endpoint: http://${env:OTEL_BACKEND}:4318 <2>
|
|
# ...
|
|
----
|
|
<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.
|
|
+
|
|
Restart {microshift-short} Observability by entering the following command:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ sudo systemctl restart microshift-observability
|
|
----
|
|
|