OSDOCS#11515:Add MicroShift observability via OTEL integration #92758

tmalove · 2025-04-30T02:54:41Z

Version(s):
4.19+
Issue:
OSDOCS-11515 updated 5/30/25

Link to docs preview:
Using MicroShift Observability (Updated 6/12/25)
Installing and enabling MicroShift Observability (Updated 5/29/25)

QE review:

[x ] QE has approved this change.

ocpdocs-previewbot · 2025-04-30T03:05:37Z

🤖 Thu Jun 12 16:47:55 - Prow CI generated the docs preview:

https://92758--ocpdocs-pr.netlify.app/
https://92758--ocpdocs-pr.netlify.app/microshift/latest/microshift_install_rpm_opt/microshift-install-optional-rpms.html
https://92758--ocpdocs-pr.netlify.app/microshift/latest/microshift_running_apps/microshift-observability-service.html

modules/microshift-otel-config.adoc

tmalove · 2025-05-08T04:17:36Z

@pmtk the configuration for the medium and small service configs are not included in Jon's note document. Will you provide that information? Thanks!

tmalove · 2025-05-08T13:59:04Z

@pmtk What are your thoughts on including configs for all 3 of the service profiles? I included 'large' (default) just in case the config was set to another one and later needed to go back to large. Thx!

pmtk · 2025-05-08T14:37:40Z

@pmtk What are your thoughts on including configs for all 3 of the service profiles? I included 'large' (default) just in case the config was set to another one and later needed to go back to large. Thx!

We'll add the to the RPM as well, but I think it won't hurt to include them in the docs (though they might get outdated, so we need to remember about them...).

modules/microshift-otel-config-size.adoc

_topic_maps/_topic_map_ms.yml

modules/microshift-otel-install.adoc

modules/microshift-otel-config.adoc

microshift_configuring/microshift-telemetry-service.adoc

modules/microshift-otel-config-size.adoc

modules/microshift-otel-verify.adoc

_topic_maps/_topic_map_ms.yml

modules/microshift-otel-install.adoc

modules/microshift-otel-config.adoc

modules/microshift-otel-config-examples.adoc

tmalove · 2025-05-20T05:23:12Z

/test validate-asciidoc

tmalove · 2025-05-22T05:21:29Z

@pmtk I changed the order of a couple of modules for clarity. Will you verify that I captured your comments correctly for the various configurations? Thanks!

pmtk

Let's just change the variable name to match openshift/microshift#4903 and I think we're good

modules/microshift-otel-config.adoc

modules/microshift-otel-config-examples.adoc

tmalove · 2025-05-28T03:22:41Z

/retest

pmtk · 2025-05-28T06:58:53Z

/lgtm

abrennan89

Overall good work, but I have added some comments that should be addressed before merging, particularly around breaking up the large config module into multiple modules.

_topic_maps/_topic_map_ms.yml

modules/microshift-otel-verify.adoc

modules/microshift-otel-start-service.adoc

modules/microshift-otel-install.adoc

modules/microshift-otel-config.adoc

microshift_running_apps/microshift-observability-service.adoc

modules/microshift-otel-config-examples.adoc

tmalove · 2025-06-12T13:39:46Z

/label merge-review-needed

stevsmit · 2025-06-12T15:02:16Z

modules/microshift-otel-config.adoc

+[id="microshift-otel-config_{context}"]
+= Configuring {microshift-short} Observability
+
+You must configure {microshift-short} Observability after it is installed by specifying a valid endpoint. If an endpoint is not specified, {microshift-short} Observability will not start.


For future consideration:

Suggested change

You must configure {microshift-short} Observability after it is installed by specifying a valid endpoint. If an endpoint is not specified, {microshift-short} Observability will not start.

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.

https://spaces.redhat.com/display/CCSENABLE/Future+tense

stevsmit · 2025-06-12T15:22:17Z

modules/microshift-otel-config-examples.adoc

+
+The `opentelemetry-collector.yaml` file includes specific parameters that are used to collect data for monitoring the system resources. All warnings for cluster events are included in the collected data. {microshift-short} Observability collects and transmits data for the following resources:
+
+* CPU, memory, disk, and network metrics of containers, pods, and node


Probably plural?

Suggested change

* CPU, memory, disk, and network metrics of containers, pods, and node

* CPU, memory, disk, and network metrics of containers, pods, and nodes

Nope, MicroShift is single-node.

stevsmit · 2025-06-12T15:23:04Z

modules/microshift-otel-config-examples.adoc

+* Kubernetes events
+* Host CPU, memory, disk, and network metrics
+* System journals for certain {microshift-short} services, and dependencies
+* Metrics exposed by pods that have `prometheus.io/scrape`: `true` annotation


Suggested change

* Metrics exposed by pods that have `prometheus.io/scrape`: `true` annotation

* Metrics exposed by pods that have the `prometheus.io/scrape`: `true` annotation

stevsmit · 2025-06-12T15:28:22Z

modules/microshift-otel-config-large.adoc

+:_mod-docs-content-type: PROCEDURE
+[id="microshift-otel-config-large_{context}"]
+= Selecting a large configuration
+


Because these are procedural modules, I think that they need an introductory paragraph: https://redhat-documentation.github.io/modular-docs/#con-creating-procedure-modules_writing-mod-docs

stevsmit · 2025-06-12T15:31:07Z

modules/microshift-otel-config-large.adoc

+                protocol: http/protobuf
+                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.


The above example, OTLP-compatible endpoint configuration, uses the same callout (<1>) so that it doesn't repeat the same information. In this example, you use 2 callouts (<1>, <2>), and then the same information is repeated.

Could you swap line 120 to <1> and then remove line 123?

stevsmit · 2025-06-12T15:32:06Z

modules/microshift-otel-config-medium.adoc

+:_mod-docs-content-type: PROCEDURE
+[id="microshift-otel-config-medium_{context}"]
+= Selecting a medium configuration
+


Same sentiments here about needing an introduction

stevsmit · 2025-06-12T15:32:29Z

modules/microshift-otel-config-medium.adoc

+                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.
+<2> 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.


Same sentiments here as above.

stevsmit · 2025-06-12T15:32:46Z

modules/microshift-otel-config-small.adoc

+:_mod-docs-content-type: PROCEDURE
+[id="microshift-otel-config-small_{context}"]
+= Selecting a small configuration
+


Same sentiment here about an introduction.

stevsmit · 2025-06-12T15:33:01Z

modules/microshift-otel-config-small.adoc

+                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.
+<2> 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.


Same thought here as above.

stevsmit · 2025-06-12T15:34:33Z

modules/microshift-otel-install.adoc

+$ sudo systemctl start microshift-observability
+----
+
+. Restart {microshift-short} after the initial installation.


Should we provide a command here? is it the same command as in "Restarting MicroShift Observability" ? But that module is commented out, so maybe some people wouldn't know how to do this.

Or maybe they would! Just a thought/comment.

openshift-ci · 2025-06-12T16:49:43Z

@tmalove: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

stevsmit · 2025-06-12T17:36:21Z

/cherry-pick enterprise-4.19

openshift-cherrypick-robot · 2025-06-12T17:37:09Z

@stevsmit: new pull request created: #94714

In response to this:

/cherry-pick enterprise-4.19

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-cherrypick-robot · 2025-06-12T17:37:09Z

@stevsmit: #92758 failed to apply on top of branch "enterprise-4.18":

Applying: add new file microshift-telemetry-service
.git/rebase-apply/patch:326: trailing whitespace.
----                
.git/rebase-apply/patch:419: trailing whitespace.
You can specify any OpenTelemetry Protocol (OTLP)-compatible endpoint for each configuration before starting {microshift-short}. 
.git/rebase-apply/patch:447: trailing whitespace.
# ...                
.git/rebase-apply/patch:448: trailing whitespace.
----  
.git/rebase-apply/patch:449: trailing whitespace.
<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.    
warning: squelched 5 whitespace errors
warning: 10 lines add whitespace errors.
Using index info to reconstruct a base tree...
M	_topic_maps/_topic_map_ms.yml
M	microshift_install_rpm_opt/microshift-install-optional-rpms.adoc
Falling back to patching base and 3-way merge...
Auto-merging microshift_install_rpm_opt/microshift-install-optional-rpms.adoc
CONFLICT (content): Merge conflict in microshift_install_rpm_opt/microshift-install-optional-rpms.adoc
Auto-merging _topic_maps/_topic_map_ms.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 add new file microshift-telemetry-service

In response to this:

/cherry-pick enterprise-4.18

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Apr 30, 2025

tmalove force-pushed the ms-osdocs-11515-tlove branch from 9b277d1 to da14a60 Compare May 5, 2025 03:34

pmtk reviewed May 5, 2025

View reviewed changes

modules/microshift-otel-config.adoc Outdated Show resolved Hide resolved

modules/microshift-otel-config.adoc Outdated Show resolved Hide resolved

tmalove force-pushed the ms-osdocs-11515-tlove branch from 74206fa to d9c409d Compare May 6, 2025 03:26

openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 6, 2025

tmalove force-pushed the ms-osdocs-11515-tlove branch from 10b5495 to ceab112 Compare May 8, 2025 05:12

tmalove force-pushed the ms-osdocs-11515-tlove branch from ceab112 to 1ec7ca7 Compare May 12, 2025 04:10

pmtk reviewed May 13, 2025

View reviewed changes

pmtk mentioned this pull request May 14, 2025

OCPBUGS-56157: Use large OTEL config example as default + descriptions tweaks openshift/microshift#4903

Merged

pmtk reviewed May 14, 2025

View reviewed changes

tmalove force-pushed the ms-osdocs-11515-tlove branch from 35d0cd9 to bea03e5 Compare May 16, 2025 03:59

pmtk reviewed May 16, 2025

View reviewed changes

tmalove force-pushed the ms-osdocs-11515-tlove branch 2 times, most recently from 2a14454 to f3d8592 Compare May 22, 2025 05:05

pmtk reviewed May 22, 2025

View reviewed changes

tmalove force-pushed the ms-osdocs-11515-tlove branch from ff49ccf to ae47bdb Compare May 23, 2025 02:56

pmtk reviewed May 23, 2025

View reviewed changes

modules/microshift-otel-config-examples.adoc Outdated Show resolved Hide resolved

pmtk reviewed May 26, 2025

View reviewed changes

modules/microshift-otel-config-examples.adoc Outdated Show resolved Hide resolved

pmtk reviewed May 26, 2025

View reviewed changes

modules/microshift-otel-config-examples.adoc Outdated Show resolved Hide resolved

pmtk reviewed May 26, 2025

View reviewed changes

modules/microshift-otel-config-examples.adoc Outdated Show resolved Hide resolved

openshift-ci bot assigned pmtk May 28, 2025

abrennan89 self-assigned this Jun 9, 2025

abrennan89 reviewed Jun 10, 2025

View reviewed changes

abrennan89 added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Jun 10, 2025

tmalove force-pushed the ms-osdocs-11515-tlove branch from 63cbb7e to 8301baa Compare June 12, 2025 00:12

openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Jun 12, 2025

stevsmit added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Jun 12, 2025

stevsmit reviewed Jun 12, 2025

View reviewed changes

tmalove force-pushed the ms-osdocs-11515-tlove branch from 8301baa to be1fead Compare June 12, 2025 15:20

stevsmit reviewed Jun 12, 2025

View reviewed changes

tmalove force-pushed the ms-osdocs-11515-tlove branch from be1fead to fb0e4ce Compare June 12, 2025 15:22

stevsmit reviewed Jun 12, 2025

View reviewed changes

add new file microshift-telemetry-service

bd5a6b4

tmalove force-pushed the ms-osdocs-11515-tlove branch from 60ea6cb to bd5a6b4 Compare June 12, 2025 16:27

stevsmit added the lgtm Indicates that a PR is ready to be merged. label Jun 12, 2025

stevsmit merged commit a2ad03a into openshift:main Jun 12, 2025
2 checks passed

openshift-cherrypick-robot mentioned this pull request Jun 12, 2025

[enterprise-4.19] OSDOCS#11515:Add MicroShift observability via OTEL integration #94714

Merged

	You must configure {microshift-short} Observability after it is installed by specifying a valid endpoint. If an endpoint is not specified, {microshift-short} Observability will not start.
	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.


		The `opentelemetry-collector.yaml` file includes specific parameters that are used to collect data for monitoring the system resources. All warnings for cluster events are included in the collected data. {microshift-short} Observability collects and transmits data for the following resources:

		* CPU, memory, disk, and network metrics of containers, pods, and node

	* Metrics exposed by pods that have `prometheus.io/scrape`: `true` annotation
	* Metrics exposed by pods that have the `prometheus.io/scrape`: `true` annotation

OSDOCS#11515:Add MicroShift observability via OTEL integration #92758

OSDOCS#11515:Add MicroShift observability via OTEL integration #92758

Uh oh!

Conversation

tmalove commented Apr 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Apr 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tmalove commented May 8, 2025

Uh oh!

tmalove commented May 8, 2025

Uh oh!

pmtk commented May 8, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tmalove commented May 20, 2025

Uh oh!

tmalove commented May 22, 2025

Uh oh!

pmtk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tmalove commented May 28, 2025

Uh oh!

pmtk commented May 28, 2025

Uh oh!

abrennan89 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tmalove commented Apr 30, 2025 •

edited

Loading

ocpdocs-previewbot commented Apr 30, 2025 •

edited

Loading

stevsmit Jun 12, 2025 •

edited

Loading

stevsmit Jun 12, 2025 •

edited

Loading