Skip to content
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.

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

Add section about OCP dashboards #75

Merged
merged 1 commit into from
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions .mdox.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,12 @@ transformations:
title: "{{ .Origin.FirstHeader }}"
lastmod: "{{ .Origin.LastMod }}"
weight: 20
- glob: "Products/OpenshiftMonitoring/dashboards.md"
frontMatter:
template: |
title: "{{ .Origin.FirstHeader }}"
lastmod: "{{ .Origin.LastMod }}"
weight: 25
- glob: "Products/OpenshiftMonitoring/telemetry.md"
frontMatter:
template: |
Expand Down
10 changes: 6 additions & 4 deletions content/Products/OpenshiftMonitoring/alerting.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
weight: 20
---
# Alerting

# Alerting guidelines
## Targeted audience

This document is intended for OpenShift developers that want to write alerting rules for their operators and operands.

## Guidelines

Please refer to the [Alerting Consistency](https://github.com/openshift/enhancements/blob/master/enhancements/monitoring/alerting-consistency.md) OpenShift enhancement proposal for the recommendations applying to OCP built-in alerting rules.

Expand Down
9 changes: 5 additions & 4 deletions content/Products/OpenshiftMonitoring/collecting_metrics.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
weight: 10
---

# Collecting metrics with Prometheus

This document explains how to ingest metrics into the OpenShift Platform monitoring stack. **It only applies for the OCP core components and Red Hat certified operators.**
Expand Down Expand Up @@ -250,3 +246,8 @@ spec:
## Configuring Prometheus rules

In a similar way, you can configure the Prometheus pods with recording and alerting rules based on the metrics being collected. To do so, you should create `PrometheusRule` objects in your operator/operand namespace which will also be picked up by the Prometheus operator.

## Next steps

* [Configure alerting](alerting.md) with Prometheus.
* [Send Telemetry metrics](telemetry.md).
11 changes: 11 additions & 0 deletions content/Products/OpenshiftMonitoring/dashboards.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Dashboards

## Targeted audience

This document is intended for OpenShift developers that want to add visualization dashboards for their operators and operands in the OCP administrator console.

## Getting started

Please refer to the [document](https://docs.google.com/document/d/1UwHwkL-YtrRJYm-A922IeW3wvKEgCR-epeeeh3CBOGs/edit) written by the Observability UI team.

The team can also be found in the `#forum-observability-ui` Slack channel.
4 changes: 0 additions & 4 deletions content/Products/OpenshiftMonitoring/faq.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
weight: 40
---

# Frequently asked questions

This serves as a collection of resources that relate to FAQ around configuring/debugging the in-cluster monitoring stack. Particularly it applies to two OpenShift Projects:
Expand Down
1 change: 1 addition & 0 deletions content/Products/OpenshiftMonitoring/instrumentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,4 @@ You can find an example of this pattern in the [github.com/prometheus-operator/p

* [Collect metrics](collecting_metrics.md) with Prometheus.
* [Configure alerting](alerting.md) with Prometheus.
* [Add dashboards](dashboards.md) to the OCP console.
4 changes: 0 additions & 4 deletions content/Products/OpenshiftMonitoring/telemetry.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
weight: 30
---

# Sending metrics via Telemetry

## Targeted audience
Expand Down
Loading