Skip to content

PR for OBSDOCS-2785: Modularize otel-configuring-otelcol-metrics.adoc #102327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

PR for OBSDOCS-2785: Modularize otel-configuring-otelcol-metrics.adoc #102327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
413aaa2
OBSDOCS-2785: converted OpenTelemetry Collector metrics assembly into…
Nov 12, 2025
0417db3
OBSDOCS-2785: context variable was missing
Nov 12, 2025
596ab1b
OBSDOCS-2785: xref link trial
Nov 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions _topic_maps/_topic_map.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3243,8 +3243,6 @@ Topics:
File: otel-configuring-metrics-for-monitoring-stack
- Name: Forwarding telemetry data
File: otel-forwarding-telemetry-data
- Name: Configuring the Collector metrics
File: otel-configuring-otelcol-metrics
- Name: Gathering the observability data from multiple clusters
File: otel-config-multicluster
- Name: Troubleshooting the Red Hat build of OpenTelemetry
Expand Down
12 changes: 8 additions & 4 deletions ...tel/otel-configuring-otelcol-metrics.adoc → ...s/otel-configuring-collector-metrics.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
:_mod-docs-content-type: ASSEMBLY
include::_attributes/common-attributes.adoc[]
[id="otel-configuring-metrics"]
// Module included in the following assemblies:
//
// * observability/otel/otel-configuration-of-otel-collector.adoc

:_mod-docs-content-type: PROCEDURE
[id="otel-configuring-collector-metrics'_{context}"]
= Configuring the OpenTelemetry Collector metrics
:context: otel-configuring-metrics

[role="_abstract"]
The following list shows some of these metrics:

* Collector memory usage
Expand Down Expand Up @@ -49,5 +52,6 @@ You can use the *Administrator* view of the web console to verify successful con
. Filter by *Source: User*.
. Check that the *ServiceMonitors* or *PodMonitors* in the `opentelemetry-collector-<instance_name>` format have the *Up* status.

[role="_additional-resources"]
.Additional resources
* xref:../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects]
Copy link
Collaborator

@ocpdocs-vale-bot ocpdocs-vale-bot Nov 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies.

6 changes: 4 additions & 2 deletions observability/otel/otel-collector/otel-collector-configuration-intro.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:_mod-docs-content-type: ASSEMBLY
[id="otel-configuration-of-otel-collector"]
= Configuring the Collector
include::_attributes/common-attributes.adoc[]
Copy link
Collaborator

@ocpdocs-vale-bot ocpdocs-vale-bot Nov 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.AuthorLine: Author lines are not supported for topics.

:context: otel-configuration-of-otel-collector
[id="otel-configuration-of-otel-collector_{context}"]
= Configuring the Collector

toc::[]

Expand All @@ -15,4 +15,6 @@ include::modules/otel-collector-config-options.adoc[leveloffset=+1]

include::modules/otel-creating-required-RBAC-resources-automatically.adoc[leveloffset=+1]

include::modules/otel-configuring-collector-metrics.adoc[leveloffset=+1]

include::modules/otel-target-allocator.adoc[leveloffset=+1]