mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-3949: Describe data sent off-cluster in ROSA/OSD docs
This commit is contained in:
bmcelvee
@@ -353,4 +353,4 @@ AddCharset utf-8 .atom .css .js .json .rss .vtt .xml
|
||||
Order allow,deny
|
||||
Deny from all
|
||||
Satisfy All
|
||||
</FilesMatch>
|
||||
</FilesMatch>
|
||||
@@ -130,28 +130,15 @@ Topics:
|
||||
Topics:
|
||||
- Name: Accessing the service logs
|
||||
File: osd-accessing-the-service-logs
|
||||
- Name: Monitoring user-defined projects
|
||||
Dir: osd_monitoring
|
||||
Distros: openshift-dedicated
|
||||
Topics:
|
||||
- Name: Understanding the monitoring stack
|
||||
File: osd-understanding-the-monitoring-stack
|
||||
- Name: Accessing monitoring for user-defined projects
|
||||
File: osd-accessing-monitoring-for-user-defined-projects
|
||||
- Name: Configuring the monitoring stack
|
||||
File: osd-configuring-the-monitoring-stack
|
||||
- Name: Enabling alert routing for user-defined projects
|
||||
File: osd-enabling-alert-routing-for-user-defined-projects
|
||||
- Name: Managing metrics
|
||||
File: osd-managing-metrics
|
||||
- Name: Managing alerts
|
||||
File: osd-managing-alerts
|
||||
- Name: Reviewing monitoring dashboards
|
||||
File: osd-reviewing-monitoring-dashboards
|
||||
- Name: Troubleshooting monitoring issues
|
||||
File: osd-troubleshooting-monitoring-issues
|
||||
---
|
||||
Name: Cluster security
|
||||
Name: Security and compliance
|
||||
Dir: security
|
||||
Distros: openshift-dedicated
|
||||
Topics:
|
||||
- Name: Viewing audit logs
|
||||
File: audit-log-view
|
||||
---
|
||||
Name: Authentication and authorization
|
||||
Dir: authentication
|
||||
Distros: openshift-dedicated
|
||||
Topics:
|
||||
@@ -346,6 +333,27 @@ Topics:
|
||||
- Name: Exported fields
|
||||
File: cluster-logging-exported-fields
|
||||
---
|
||||
Name: Monitoring user-defined projects
|
||||
Dir: monitoring
|
||||
Distros: openshift-dedicated
|
||||
Topics:
|
||||
- Name: Understanding the monitoring stack
|
||||
File: osd-understanding-the-monitoring-stack
|
||||
- Name: Accessing monitoring for user-defined projects
|
||||
File: osd-accessing-monitoring-for-user-defined-projects
|
||||
- Name: Configuring the monitoring stack
|
||||
File: osd-configuring-the-monitoring-stack
|
||||
- Name: Enabling alert routing for user-defined projects
|
||||
File: osd-enabling-alert-routing-for-user-defined-projects
|
||||
- Name: Managing metrics
|
||||
File: osd-managing-metrics
|
||||
- Name: Managing alerts
|
||||
File: managing-alerts
|
||||
- Name: Reviewing monitoring dashboards
|
||||
File: osd-reviewing-monitoring-dashboards
|
||||
- Name: Troubleshooting monitoring issues
|
||||
File: osd-troubleshooting-monitoring-issues
|
||||
---
|
||||
Name: Serverless
|
||||
Dir: serverless
|
||||
Distros: openshift-dedicated
|
||||
|
||||
@@ -219,26 +219,17 @@ Topics:
|
||||
Distros: openshift-rosa
|
||||
- Name: About autoscaling nodes on a cluster
|
||||
File: rosa-nodes-about-autoscaling-nodes
|
||||
- Name: Monitoring user-defined projects
|
||||
Dir: rosa_monitoring
|
||||
Distros: openshift-rosa
|
||||
Topics:
|
||||
- Name: Understanding the monitoring stack
|
||||
File: rosa-understanding-the-monitoring-stack
|
||||
- Name: Accessing monitoring for user-defined projects
|
||||
File: rosa-accessing-monitoring-for-user-defined-projects
|
||||
- Name: Configuring the monitoring stack
|
||||
File: rosa-configuring-the-monitoring-stack
|
||||
- Name: Enabling alert routing for user-defined projects
|
||||
File: rosa-enabling-alert-routing-for-user-defined-projects
|
||||
- Name: Managing metrics
|
||||
File: rosa-managing-metrics
|
||||
- Name: Managing alerts
|
||||
File: rosa-managing-alerts
|
||||
- Name: Reviewing monitoring dashboards
|
||||
File: rosa-reviewing-monitoring-dashboards
|
||||
- Name: Troubleshooting monitoring issues
|
||||
File: rosa-troubleshooting-monitoring-issues
|
||||
---
|
||||
Name: Security and compliance
|
||||
Dir: security
|
||||
Distros: openshift-rosa
|
||||
Topics:
|
||||
- Name: Viewing audit logs
|
||||
File: audit-log-view
|
||||
# - Name: Security
|
||||
# File: rosa-security
|
||||
# - Name: Application and cluster compliance
|
||||
# File: rosa-app-security-compliance
|
||||
---
|
||||
Name: Authentication and authorization
|
||||
Dir: authentication
|
||||
@@ -248,10 +239,6 @@ Topics:
|
||||
File: assuming-an-aws-iam-role-for-a-service-account
|
||||
- Name: Managing security context constraints
|
||||
File: managing-security-context-constraints
|
||||
# - Name: Security
|
||||
# File: rosa-security
|
||||
# - Name: Application and cluster compliance
|
||||
# File: rosa-app-security-compliance
|
||||
---
|
||||
Name: Upgrading
|
||||
Dir: upgrading
|
||||
@@ -454,6 +441,27 @@ Topics:
|
||||
- Name: Exported fields
|
||||
File: cluster-logging-exported-fields
|
||||
---
|
||||
Name: Monitoring user-defined projects
|
||||
Dir: monitoring
|
||||
Distros: openshift-rosa
|
||||
Topics:
|
||||
- Name: Understanding the monitoring stack
|
||||
File: rosa-understanding-the-monitoring-stack
|
||||
- Name: Accessing monitoring for user-defined projects
|
||||
File: rosa-accessing-monitoring-for-user-defined-projects
|
||||
- Name: Configuring the monitoring stack
|
||||
File: rosa-configuring-the-monitoring-stack
|
||||
- Name: Enabling alert routing for user-defined projects
|
||||
File: rosa-enabling-alert-routing-for-user-defined-projects
|
||||
- Name: Managing metrics
|
||||
File: rosa-managing-metrics
|
||||
- Name: Managing alerts
|
||||
File: managing-alerts
|
||||
- Name: Reviewing monitoring dashboards
|
||||
File: rosa-reviewing-monitoring-dashboards
|
||||
- Name: Troubleshooting monitoring issues
|
||||
File: rosa-troubleshooting-monitoring-issues
|
||||
---
|
||||
Name: Service Mesh
|
||||
Dir: service_mesh
|
||||
Distros: openshift-rosa
|
||||
@@ -939,6 +947,11 @@ Name: Troubleshooting
|
||||
Dir: rosa_support
|
||||
Distros: openshift-rosa
|
||||
Topics:
|
||||
- Name: Remote health monitoring with connected clusters
|
||||
Dir: remote_health_monitoring
|
||||
Topics:
|
||||
- Name: Showing data collected by remote health monitoring
|
||||
File: showing-data-collected-by-remote-health-monitoring
|
||||
- Name: Troubleshooting expired offline access tokens
|
||||
File: rosa-troubleshooting-expired-tokens
|
||||
- Name: Troubleshooting installations
|
||||
|
||||
@@ -1,9 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * monitoring/managing-alerts.adoc
|
||||
// * monitoring/osd-managing-alerts.adoc
|
||||
// * osd_cluster_admin/osd_monitoring/osd-managing-alerts.adoc
|
||||
// * rosa_cluster_admin/rosa_monitoring/rosa-managing-alerts.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="applying-a-custom-configuration-to-alertmanager-for-user-defined-alert-routing_{context}"]
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
//
|
||||
// * monitoring/enabling-alert-routing-for-user-defined-projects.adoc
|
||||
// * monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
|
||||
// * osd_cluster_admin/osd_monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
|
||||
// * rosa_cluster_admin/rosa_monitoring/rosa-enabling-alert-routing-for-user-defined-projects.adoc
|
||||
// * monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
|
||||
// * monitoring/rosa-enabling-alert-routing-for-user-defined-projects.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="enabling-a-separate-alertmanager-instance-for-user-defined-alert-routing_{context}"]
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
//
|
||||
// * monitoring/enabling-alert-routing-for-user-defined-projects.adoc
|
||||
// * monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
|
||||
// * osd_cluster_admin/osd_monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
|
||||
// * rosa_cluster_admin/rosa_monitoring/rosa-enabling-alert-routing-for-user-defined-projects.adoc
|
||||
// * monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
|
||||
// * monitoring/rosa-enabling-alert-routing-for-user-defined-projects.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="granting-users-permission-to-configure-alert-routing-for-user-defined-projects_{context}"]
|
||||
|
||||
@@ -1,9 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * monitoring/managing-alerts.adoc
|
||||
// * monitoring/osd-managing-alerts.adoc
|
||||
// * osd_cluster_admin/osd_monitoring/osd-managing-alerts.adoc
|
||||
// * rosa_cluster_admin/rosa_monitoring/rosa-managing-alerts.adoc
|
||||
|
||||
:_content-type: PROCEDURE
|
||||
[id="listing-alerting-rules-for-all-projects-in-a-single-view_{context}"]
|
||||
|
||||
@@ -14,7 +14,7 @@ In {product-title} {product-version}, you can create, view, edit, and remove ale
|
||||
ifdef::openshift-rosa,openshift-dedicated[]
|
||||
[IMPORTANT]
|
||||
====
|
||||
Managing alerting rules for user-defined projects is only available in {product-title} version 4.11 and up.
|
||||
Managing alerting rules for user-defined projects is only available in {product-title} version 4.11 and later.
|
||||
====
|
||||
endif::[]
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
|
||||
// * osd_cluster_admin/osd_monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
|
||||
// * rosa_cluster_admin/rosa_monitoring/rosa-enabling-alert-routing-for-user-defined-projects.adoc
|
||||
// * monitoring/osd-enabling-alert-routing-for-user-defined-projects.adoc
|
||||
// * monitoring/rosa-enabling-alert-routing-for-user-defined-projects.adoc
|
||||
|
||||
:_content-type: CONCEPT
|
||||
[id="osd-understanding-alert-routing-for-user-defined-projects_{context}"]
|
||||
|
||||
@@ -10,7 +10,14 @@ You can view the cluster and components time series data captured by Telemetry.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have installed the {product-title} CLI (`oc`).
|
||||
* You have installed the
|
||||
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
|
||||
{product-title}
|
||||
endif::openshift-enterprise,openshift-webscale,openshift-origin[]
|
||||
ifndef::openshift-enterprise,openshift-webscale,openshift-origin[]
|
||||
OpenShift Container Platform
|
||||
endif::openshift-enterprise,openshift-webscale,openshift-origin[]
|
||||
CLI (`oc`).
|
||||
* You have access to the cluster as a user with the `cluster-admin` role or the `cluster-monitoring-view` role.
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -49,12 +49,16 @@ include::modules/monitoring-optimizing-alerting-for-user-defined-projects.adoc[l
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* See the link:https://prometheus.io/docs/practices/alerting/[Prometheus alerting documentation] for further guidelines on optimizing alerts
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
* See xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] for details about {product-title} {product-version} monitoring architecture
|
||||
endif::[]
|
||||
|
||||
include::modules/monitoring-creating-alerting-rules-for-user-defined-projects.adoc[leveloffset=+2]
|
||||
include::modules/monitoring-reducing-latency-for-alerting-rules-that-do-not-query-platform-metrics.adoc[leveloffset=+2]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
* See xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] for details about {product-title} {product-version} monitoring architecture.
|
||||
endif::[]
|
||||
|
||||
include::modules/monitoring-accessing-alerting-rules-for-your-project.adoc[leveloffset=+2]
|
||||
include::modules/monitoring-listing-alerting-rules-for-all-projects-in-a-single-view.adoc[leveloffset=+2]
|
||||
@@ -72,7 +76,9 @@ include::modules/monitoring-creating-new-alerting-rules.adoc[leveloffset=+2]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
* See xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] for details about {product-title} {product-version} monitoring architecture.
|
||||
endif::[]
|
||||
* See the link:https://prometheus.io/docs/alerting/alertmanager/[Alertmanager documentation] for information about alerting rules.
|
||||
* See the link:https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config[Prometheus relabeling documentation] for information about how relabeling works.
|
||||
* See the link:https://prometheus.io/docs/practices/alerting/[Prometheus alerting documentation] for further guidelines on optimizing alerts.
|
||||
@@ -98,9 +104,11 @@ include::modules/monitoring-applying-a-custom-configuration-to-alertmanager-for-
|
||||
* See link:https://www.pagerduty.com/[the PagerDuty official site] for more information on PagerDuty.
|
||||
* See link:https://www.pagerduty.com/docs/guides/prometheus-integration-guide/[the PagerDuty Prometheus Integration Guide] to learn how to retrieve the `service_key`.
|
||||
* See link:https://prometheus.io/docs/alerting/configuration/[Alertmanager configuration] for configuring alerting through different alert receivers.
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
* See xref:../monitoring/enabling-alert-routing-for-user-defined-projects.adoc#enabling-alert-routing-for-user-defined-projects[Enabling alert routing for user-defined projects] to learn how to enable a dedicated instance of Alertmanager for user-defined alert routing.
|
||||
|
||||
|
||||
== Next steps
|
||||
|
||||
* xref:../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[Reviewing monitoring dashboards]
|
||||
endif::[]
|
||||
|
||||
@@ -6,9 +6,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
By default, centralized monitoring for user-defined projects and platform monitoring are enabled. You can monitor your own projects in {product-title} without the need for an additional monitoring solution.
|
||||
|
||||
The monitoring of user-defined projects cannot be disabled.
|
||||
When you install an {product-title} cluster, monitoring for user-defined projects is enabled by default. With monitoring for user-defined projects enabled, you can monitor your own {product-title} projects without the need for an additional monitoring solution.
|
||||
|
||||
The `dedicated-admin` user has default permissions to configure and access monitoring for user-defined projects.
|
||||
|
||||
@@ -17,7 +15,9 @@ The `dedicated-admin` user has default permissions to configure and access monit
|
||||
Custom Prometheus instances and the Prometheus Operator installed through Operator Lifecycle Manager (OLM) can cause issues with user-defined project monitoring if it is enabled. Custom Prometheus instances are not supported.
|
||||
====
|
||||
|
||||
Optionally, you can disable monitoring for user-defined projects during or after a cluster installation.
|
||||
|
||||
[id="accessing-user-defined-monitoring-next-steps"]
|
||||
== Next steps
|
||||
|
||||
* xref:../monitoring/osd-managing-metrics.adoc#osd-managing-metrics[Managing metrics]
|
||||
* xref:../monitoring/osd-configuring-the-monitoring-stack.adoc#osd-configuring-the-monitoring-stack[Configuring the monitoring stack]
|
||||
|
||||
@@ -79,4 +79,4 @@ include::modules/osd-monitoring-setting-log-levels-for-monitoring-components.ado
|
||||
[id="configuring-the-monitoring-stack-next-steps"]
|
||||
== Next steps
|
||||
|
||||
* xref:../monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]
|
||||
* xref:../monitoring/osd-managing-metrics.adoc#osd-managing-metrics[Managing metrics]
|
||||
|
||||
@@ -7,7 +7,14 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
toc::[]
|
||||
|
||||
[role="_abstract"]
|
||||
In {product-title}, a cluster administrator can enable alert routing for user-defined projects. This process consists of two general steps:
|
||||
In {product-title}, a cluster administrator can enable alert routing for user-defined projects.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
Managing alerting rules for user-defined projects is only available in {product-title} version 4.11 and later.
|
||||
====
|
||||
|
||||
This process consists of two general steps:
|
||||
|
||||
* Enable alert routing for user-defined projects to use a separate Alertmanager instance.
|
||||
* Grant additional users permission to configure alert routing for user-defined projects.
|
||||
@@ -26,5 +33,5 @@ include::modules/monitoring-granting-users-permission-to-configure-alert-routing
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc[Accessing monitoring for user-defined projects]
|
||||
* xref:../monitoring/osd-managing-alerts.adoc#creating-alert-routing-for-user-defined-projects_managing-alerts.adoc#creating-alerting-rules-for-user-defined-projects_osd-managing-alerts[Creating alert routing for user-defined projects]
|
||||
* xref:../monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]
|
||||
* xref:../monitoring/managing-alerts.adoc#creating-alerting-rules-for-user-defined-projects_managing-alerts[Creating alert routing for user-defined projects]
|
||||
|
||||
@@ -20,7 +20,7 @@ include::modules/osd-monitoring-specifying-how-a-service-is-monitored.adoc[level
|
||||
.Additional resources
|
||||
|
||||
* See the link:https://github.com/openshift/prometheus-operator/blob/release-4.7/Documentation/api.md[Prometheus Operator API documentation] for more information on `ServiceMonitor` and `PodMonitor` resources.
|
||||
* xref:../../osd_cluster_admin/osd_monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects].
|
||||
* xref:../monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects].
|
||||
|
||||
// Querying metrics
|
||||
include::modules/osd-monitoring-querying-metrics.adoc[leveloffset=+1]
|
||||
@@ -31,7 +31,7 @@ include::modules/osd-monitoring-querying-metrics-for-user-defined-projects-as-a-
|
||||
.Additional resources
|
||||
|
||||
* See the link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus query documentation] for more information about creating PromQL queries.
|
||||
* See the xref:../../osd_cluster_admin/osd_monitoring/osd-managing-metrics.adoc#querying-metrics-for-user-defined-projects-as-a-developer_osd-managing-metrics[Querying metrics for user-defined projects as a developer] for details on accessing non-cluster metrics as a developer or a privileged user
|
||||
* See the xref:../monitoring/osd-managing-metrics.adoc#querying-metrics-for-user-defined-projects-as-a-developer_osd-managing-metrics[Querying metrics for user-defined projects as a developer] for details on accessing non-cluster metrics as a developer or a privileged user
|
||||
// TODO: The above additional resource points to the same module that it's an additional resource of
|
||||
|
||||
include::modules/osd-monitoring-exploring-the-visualized-metrics.adoc[leveloffset=+2]
|
||||
@@ -39,11 +39,10 @@ include::modules/osd-monitoring-exploring-the-visualized-metrics.adoc[leveloffse
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* See the xref:../../osd_cluster_admin/osd_monitoring/osd-managing-metrics.adoc#querying-metrics_osd-managing-metrics[Querying metrics] section on using the PromQL interface
|
||||
* xref:../../osd_cluster_admin/osd_monitoring/osd-troubleshooting-monitoring-issues.adoc#osd-troubleshooting-monitoring-issues[Troubleshooting monitoring issues]
|
||||
* See the xref:../monitoring/osd-managing-metrics.adoc#querying-metrics_osd-managing-metrics[Querying metrics] section on using the PromQL interface
|
||||
* xref:../monitoring/osd-troubleshooting-monitoring-issues.adoc#osd-troubleshooting-monitoring-issues[Troubleshooting monitoring issues]
|
||||
|
||||
[id="managing-metrics-next-steps"]
|
||||
== Next steps
|
||||
* xref:../../osd_cluster_admin/osd_monitoring/osd-managing-alerts.adoc#osd-managing-alerts[Alerts]
|
||||
* xref:../monitoring/managing-alerts.adoc#managing-alerts[Alerts]
|
||||
|
||||
// TODO: Why is alerts a next step if alerts aren't supported? Can this be removed?
|
||||
@@ -30,4 +30,4 @@ include::modules/osd-monitoring-targets-for-user-defined-projects.adoc[leveloffs
|
||||
[id="understanding-the-monitoring-stack-next-steps"]
|
||||
== Next steps
|
||||
|
||||
* xref:../monitoring/osd-configuring-the-monitoring-stack.adoc#osd-configuring-the-monitoring-stack[Configuring the monitoring stack]
|
||||
* xref:../monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]
|
||||
|
||||
@@ -20,4 +20,4 @@ Optionally, you can disable monitoring for user-defined projects during or after
|
||||
[id="accessing-user-defined-monitoring-next-steps"]
|
||||
== Next steps
|
||||
|
||||
* xref:../../rosa_cluster_admin/rosa_monitoring/rosa-configuring-the-monitoring-stack.adoc#rosa-configuring-the-monitoring-stack[Configuring the monitoring stack]
|
||||
* xref:../monitoring/rosa-configuring-the-monitoring-stack.adoc#rosa-configuring-the-monitoring-stack[Configuring the monitoring stack]
|
||||
@@ -80,4 +80,4 @@ include::modules/osd-monitoring-setting-log-levels-for-monitoring-components.ado
|
||||
[id="configuring-the-monitoring-stack-next-steps"]
|
||||
== Next steps
|
||||
|
||||
* xref:../../rosa_cluster_admin/rosa_monitoring/rosa-managing-metrics.adoc#rosa-managing-metrics[Managing metrics]
|
||||
* xref:../monitoring/rosa-managing-metrics.adoc#rosa-managing-metrics[Managing metrics]
|
||||
@@ -11,7 +11,7 @@ In {product-title}, a cluster administrator can enable alert routing for user-de
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
Managing alerting rules for user-defined projects is only available in {product-title} version 4.11 and up.
|
||||
Managing alerting rules for user-defined projects is only available in {product-title} version 4.11 and later.
|
||||
====
|
||||
|
||||
This process consists of two general steps:
|
||||
@@ -33,5 +33,5 @@ include::modules/monitoring-granting-users-permission-to-configure-alert-routing
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../rosa_cluster_admin/rosa_monitoring/rosa-accessing-monitoring-for-user-defined-projects.adoc#rosa-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]
|
||||
* xref:../../rosa_cluster_admin/rosa_monitoring/rosa-managing-alerts.adoc#creating-alerting-rules-for-user-defined-projects_rosa-managing-alerts[Creating alert routing for user-defined projects]
|
||||
* xref:../monitoring/rosa-accessing-monitoring-for-user-defined-projects.adoc#rosa-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]
|
||||
* xref:../monitoring/managing-alerts.adoc#creating-alerting-rules-for-user-defined-projects_managing-alerts[Creating alert routing for user-defined projects]
|
||||
@@ -39,12 +39,12 @@ include::modules/monitoring-optimizing-alerting-for-user-defined-projects.adoc[l
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* See the link:https://prometheus.io/docs/practices/alerting/[Prometheus alerting documentation] for further guidelines on optimizing alerts
|
||||
* See xref:../../rosa_cluster_admin/rosa_monitoring/rosa-understanding-the-monitoring-stack.adoc#rosa-understanding-the-monitoring-stack[Monitoring overview] for details about {product-title} {product-version} monitoring architecture
|
||||
* See xref:../monitoring/rosa-understanding-the-monitoring-stack.adoc#rosa-understanding-the-monitoring-stack[Monitoring overview] for details about {product-title} {product-version} monitoring architecture
|
||||
|
||||
include::modules/monitoring-creating-alerting-rules-for-user-defined-projects.adoc[leveloffset=+2]
|
||||
include::modules/monitoring-reducing-latency-for-alerting-rules-that-do-not-query-platform-metrics.adoc[leveloffset=+2]
|
||||
|
||||
* See xref:../../rosa_cluster_admin/rosa_monitoring/rosa-understanding-the-monitoring-stack.adoc#rosa-understanding-the-monitoring-stack[Monitoring overview] for details about {product-title} {product-version} monitoring architecture.
|
||||
* See xref:../monitoring/rosa-understanding-the-monitoring-stack.adoc#rosa-understanding-the-monitoring-stack[Monitoring overview] for details about {product-title} {product-version} monitoring architecture.
|
||||
|
||||
include::modules/monitoring-accessing-alerting-rules-for-your-project.adoc[leveloffset=+2]
|
||||
include::modules/monitoring-listing-alerting-rules-for-all-projects-in-a-single-view.adoc[leveloffset=+2]
|
||||
@@ -57,7 +57,7 @@ include::modules/monitoring-removing-alerting-rules-for-user-defined-projects.ad
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* See xref:../../rosa_cluster_admin/rosa_monitoring/rosa-understanding-the-monitoring-stack.adoc#rosa-understanding-the-monitoring-stack[Monitoring overview] for details about {product-title} monitoring architecture.
|
||||
* See xref:../monitoring/rosa-understanding-the-monitoring-stack.adoc#rosa-understanding-the-monitoring-stack[Monitoring overview] for details about {product-title} monitoring architecture.
|
||||
* See the link:https://prometheus.io/docs/alerting/alertmanager/[Alertmanager documentation] for information about alerting rules.
|
||||
* See the link:https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config[Prometheus relabeling documentation] for information about how relabeling works.
|
||||
* See the link:https://prometheus.io/docs/practices/alerting/[Prometheus alerting documentation] for further guidelines on optimizing alerts.
|
||||
@@ -74,4 +74,4 @@ include::modules/monitoring-applying-a-custom-configuration-to-alertmanager-for-
|
||||
|
||||
[id="alerts-next-steps"]
|
||||
== Next steps
|
||||
* xref:../../rosa_cluster_admin/rosa_monitoring/rosa-reviewing-monitoring-dashboards.adoc#rosa-reviewing-monitoring-dashboards[Reviewing monitoring dashboards]
|
||||
* xref:../monitoring/rosa-reviewing-monitoring-dashboards.adoc#rosa-reviewing-monitoring-dashboards[Reviewing monitoring dashboards]
|
||||
@@ -19,7 +19,7 @@ include::modules/osd-monitoring-specifying-how-a-service-is-monitored.adoc[level
|
||||
.Additional resources
|
||||
|
||||
// * See the link:https://github.com/openshift/prometheus-operator/blob/release-4.7/Documentation/api.md[Prometheus Operator API documentation] for more information on `ServiceMonitor` and `PodMonitor` resources.
|
||||
* xref:../../rosa_cluster_admin/rosa_monitoring/rosa-accessing-monitoring-for-user-defined-projects.adoc#rosa-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects].
|
||||
* xref:../monitoring/rosa-accessing-monitoring-for-user-defined-projects.adoc#rosa-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects].
|
||||
|
||||
// Querying metrics
|
||||
include::modules/osd-monitoring-querying-metrics.adoc[leveloffset=+1]
|
||||
@@ -29,18 +29,18 @@ include::modules/osd-monitoring-querying-metrics-for-user-defined-projects-as-a-
|
||||
.Additional resources
|
||||
|
||||
* See the link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus query documentation] for more information about creating PromQL queries.
|
||||
* See xref:../../rosa_cluster_admin/rosa_monitoring/rosa-managing-metrics.adoc#querying-metrics-for-user-defined-projects-as-a-developer_rosa-managing-metrics[Querying metrics for user-defined projects as a developer] for details on accessing non-cluster metrics as a developer or a privileged user
|
||||
* See xref:../monitoring/rosa-managing-metrics.adoc#querying-metrics-for-user-defined-projects-as-a-developer_rosa-managing-metrics[Querying metrics for user-defined projects as a developer] for details on accessing non-cluster metrics as a developer or a privileged user
|
||||
// TODO: The above additional resource points to the same module that it's an additional resource of
|
||||
|
||||
include::modules/osd-monitoring-exploring-the-visualized-metrics.adoc[leveloffset=+2]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* See the xref:../../rosa_cluster_admin/rosa_monitoring/rosa-managing-metrics.adoc#querying-metrics_rosa-managing-metrics[Querying metrics] section on using the PromQL interface
|
||||
* xref:../../rosa_cluster_admin/rosa_monitoring/rosa-troubleshooting-monitoring-issues.adoc#rosa-troubleshooting-monitoring-issues[Troubleshooting monitoring issues]
|
||||
* See the xref:../monitoring/rosa-managing-metrics.adoc#querying-metrics_rosa-managing-metrics[Querying metrics] section on using the PromQL interface
|
||||
* xref:../monitoring/rosa-troubleshooting-monitoring-issues.adoc#rosa-troubleshooting-monitoring-issues[Troubleshooting monitoring issues]
|
||||
|
||||
[id="managing-metrics-next-steps"]
|
||||
== Next steps
|
||||
* xref:../../rosa_cluster_admin/rosa_monitoring/rosa-managing-alerts.adoc#rosa-managing-alerts[Alerts]
|
||||
* xref:../monitoring/managing-alerts.adoc#managing-alerts[Alerts]
|
||||
|
||||
// TODO: Why is alerts a next step if alerts aren't supported? Can this be removed?
|
||||
@@ -29,4 +29,4 @@ include::modules/osd-monitoring-reviewing-monitoring-dashboards-developer.adoc[l
|
||||
[id="monitoring-dashboards-next-steps"]
|
||||
== Next steps
|
||||
|
||||
* xref:../../rosa_cluster_admin/rosa_monitoring/rosa-troubleshooting-monitoring-issues.adoc#rosa-troubleshooting-monitoring-issues[Troubleshooting monitoring issues]
|
||||
* xref:../monitoring/rosa-troubleshooting-monitoring-issues.adoc#rosa-troubleshooting-monitoring-issues[Troubleshooting monitoring issues]
|
||||
@@ -23,7 +23,7 @@ include::modules/osd-monitoring-targets-for-user-defined-projects.adoc[leveloffs
|
||||
|
||||
//Because this is a duplicate file only referenced in the ROSA topic map, the xref links in this section will differ from the osd-understanding-the-monitoring-stack.adoc file.
|
||||
|
||||
* xref:../../rosa_cluster_admin/rosa_monitoring/rosa-accessing-monitoring-for-user-defined-projects.adoc#rosa-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]
|
||||
* xref:../monitoring/rosa-accessing-monitoring-for-user-defined-projects.adoc#rosa-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]
|
||||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.10/html-single/monitoring/index#default-monitoring-components_monitoring-overview[Default monitoring components]
|
||||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.10/html-single/monitoring/index#default-monitoring-targets_monitoring-overview[Default monitoring targets]
|
||||
// TODO: When there is a link to the OCP docs, should that be explicit, so they're not surprised when they find themselves in another doc set?
|
||||
@@ -31,4 +31,4 @@ include::modules/osd-monitoring-targets-for-user-defined-projects.adoc[leveloffs
|
||||
[id="understanding-the-monitoring-stack-next-steps"]
|
||||
== Next steps
|
||||
|
||||
* xref:../../rosa_cluster_admin/rosa_monitoring/rosa-accessing-monitoring-for-user-defined-projects.adoc#rosa-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]
|
||||
* xref:../monitoring/rosa-accessing-monitoring-for-user-defined-projects.adoc#rosa-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]
|
||||
@@ -1 +0,0 @@
|
||||
../_attributes/
|
||||
@@ -1 +0,0 @@
|
||||
../images/
|
||||
@@ -1 +0,0 @@
|
||||
../modules/
|
||||
@@ -1,23 +0,0 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="osd-accessing-monitoring-for-user-defined-projects"]
|
||||
= Accessing monitoring for user-defined projects
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: osd-accessing-monitoring-for-user-defined-projects
|
||||
|
||||
toc::[]
|
||||
|
||||
When you install an {product-title} cluster, monitoring for user-defined projects is enabled by default. With monitoring for user-defined projects enabled, you can monitor your own {product-title} projects without the need for an additional monitoring solution.
|
||||
|
||||
The `dedicated-admin` user has default permissions to configure and access monitoring for user-defined projects.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
Custom Prometheus instances and the Prometheus Operator installed through Operator Lifecycle Manager (OLM) can cause issues with user-defined project monitoring if it is enabled. Custom Prometheus instances are not supported.
|
||||
====
|
||||
|
||||
Optionally, you can disable monitoring for user-defined projects during or after a cluster installation.
|
||||
|
||||
[id="accessing-user-defined-monitoring-next-steps"]
|
||||
== Next steps
|
||||
|
||||
* xref:../../osd_cluster_admin/osd_monitoring/osd-configuring-the-monitoring-stack.adoc#osd-configuring-the-monitoring-stack[Configuring the monitoring stack]
|
||||
@@ -1,82 +0,0 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="osd-configuring-the-monitoring-stack"]
|
||||
= Configuring the monitoring stack
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: osd-configuring-the-monitoring-stack
|
||||
|
||||
toc::[]
|
||||
|
||||
After you configure the monitoring stack, you can review common configuration scenarios and configure monitoring of user-defined projects.
|
||||
|
||||
// Maintenance and support for monitoring
|
||||
include::modules/osd-monitoring-maintenance-and-support.adoc[leveloffset=+1]
|
||||
include::modules/osd-monitoring-support-considerations.adoc[leveloffset=+2]
|
||||
|
||||
// Configuring the monitoring stack
|
||||
include::modules/osd-monitoring-configuring-the-monitoring-stack.adoc[leveloffset=+1]
|
||||
|
||||
// Configurable monitoring components
|
||||
include::modules/osd-monitoring-configurable-monitoring-components.adoc[leveloffset=+1]
|
||||
|
||||
// Moving monitoring components to different nodes
|
||||
include::modules/osd-monitoring-moving-monitoring-components-to-different-nodes.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* link:https://docs.openshift.com/container-platform/4.7/nodes/nodes/nodes-nodes-working.html#nodes-nodes-working-updating_nodes-nodes-working[Understanding how to update labels on nodes]
|
||||
* link:https://docs.openshift.com/container-platform/4.7/nodes/scheduling/nodes-scheduler-node-selectors.html[Placing pods on specific nodes using node selectors]
|
||||
* See the link:https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector[Kubernetes documentation] for details on the `nodeSelector` constraint
|
||||
|
||||
// TODO: Same question about whether links out to OCP docs should explicitly mention that? (I won't point out any more, but could easily search to find other instances in the repo).
|
||||
|
||||
// Assigning tolerations to monitoring components
|
||||
include::modules/osd-monitoring-assigning-tolerations-to-monitoring-components.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* See the link:https://docs.openshift.com/container-platform/4.7/nodes/scheduling/nodes-scheduler-taints-tolerations.html#nodes-scheduler-taints-tolerations[OpenShift Container Platform documentation] on taints and tolerations
|
||||
* See the link:https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/[Kubernetes documentation] on taints and tolerations
|
||||
|
||||
// Configuring persistent storage
|
||||
[id="configuring-persistent-storage"]
|
||||
== Configuring persistent storage
|
||||
|
||||
Running cluster monitoring with persistent storage means that your metrics are stored to a persistent volume (PV) and can survive a pod being restarted or recreated. This is ideal if you require your metrics data to be guarded from data loss. For production environments, it is highly recommended to configure persistent storage. Because of the high IO demands, it is advantageous to use local storage.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
See link:https://docs.openshift.com/container-platform/4.7/scalability_and_performance/optimizing-storage.html#recommended-configurable-storage-technology_persistent-storage[Recommended configurable storage technology].
|
||||
====
|
||||
|
||||
[id="persistent-storage-prerequisites"]
|
||||
=== Persistent storage prerequisites
|
||||
|
||||
* Use the block type of storage.
|
||||
|
||||
include::modules/osd-monitoring-configuring-a-local-persistent-volume-claim.adoc[leveloffset=+2]
|
||||
include::modules/osd-monitoring-modifying-retention-time-for-prometheus-metrics-data.adoc[leveloffset=+2]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* link:https://docs.openshift.com/container-platform/4.7/storage/understanding-persistent-storage.html[Understanding persistent storage]
|
||||
* link:https://docs.openshift.com/container-platform/4.7/scalability_and_performance/optimizing-storage.html[Optimizing storage]
|
||||
|
||||
// Managing scrape sample limits for user-defined projects
|
||||
include::modules/osd-monitoring-limiting-scrape-samples-in-user-defined-projects.adoc[leveloffset=+1]
|
||||
include::modules/osd-monitoring-setting-a-scrape-sample-limit-for-user-defined-projects.adoc[leveloffset=+2]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* link:https://docs.openshift.com/container-platform/4.7/monitoring/troubleshooting-monitoring-issues.html#determining-why-prometheus-is-consuming-disk-space_troubleshooting-monitoring-issues[Determining why Prometheus is consuming a lot of disk space] for steps to query which metrics have the highest number of scrape samples
|
||||
|
||||
// Setting log levels for monitoring components
|
||||
include::modules/osd-monitoring-setting-log-levels-for-monitoring-components.adoc[leveloffset=+1]
|
||||
|
||||
[id="configuring-the-monitoring-stack-next-steps"]
|
||||
== Next steps
|
||||
|
||||
* xref:../../osd_cluster_admin/osd_monitoring/osd-managing-metrics.adoc#osd-managing-metrics[Managing metrics]
|
||||
@@ -1,37 +0,0 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="osd-enabling-alert-routing-for-user-defined-projects"]
|
||||
= Enabling alert routing for user-defined projects
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: osd-enabling-alert-routing-for-user-defined-projects
|
||||
|
||||
toc::[]
|
||||
|
||||
[role="_abstract"]
|
||||
In {product-title}, a cluster administrator can enable alert routing for user-defined projects.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
Managing alerting rules for user-defined projects is only available in {product-title} version 4.11 and up.
|
||||
====
|
||||
|
||||
This process consists of two general steps:
|
||||
|
||||
* Enable alert routing for user-defined projects to use a separate Alertmanager instance.
|
||||
* Grant additional users permission to configure alert routing for user-defined projects.
|
||||
|
||||
After you complete these steps, developers and other users can configure custom alerts and alert routing for their user-defined projects.
|
||||
|
||||
//Overview of setting up alert routing for user-defined projects
|
||||
include::modules/osd-monitoring-understanding-alert-routing-for-user-defined-projects.adoc[leveloffset=+1]
|
||||
|
||||
// Enabling a dedicated Alertmanager instance for use in user-defined projects
|
||||
include::modules/monitoring-enabling-a-separate-alertmanager-instance-for-user-defined-alert-routing.adoc[leveloffset=+1]
|
||||
|
||||
// Granting users permission to configure alert routing for user-defined projects
|
||||
include::modules/monitoring-granting-users-permission-to-configure-alert-routing-for-user-defined-projects.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../osd_cluster_admin/osd_monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]
|
||||
* xref:../../osd_cluster_admin/osd_monitoring/osd-managing-alerts.adoc#creating-alerting-rules-for-user-defined-projects_osd-managing-alerts[Creating alert routing for user-defined projects]
|
||||
@@ -1,77 +0,0 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="osd-managing-alerts"]
|
||||
= Alerts
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: osd-managing-alerts
|
||||
|
||||
toc::[]
|
||||
|
||||
In {product-title}, the Alerting UI enables you to manage alerts, silences, and alerting rules.
|
||||
|
||||
* *Alerting rules*. Alerting rules contain a set of conditions that outline a particular state within a cluster. Alerts are triggered when those conditions are true. An alerting rule can be assigned a severity that defines how the alerts are routed.
|
||||
* *Alerts*. An alert is fired when the conditions defined in an alerting rule are true. Alerts provide a notification that a set of circumstances are apparent within an {product-title} cluster.
|
||||
* *Silences*. A silence can be applied to an alert to prevent notifications from being sent when the conditions for an alert are true. You can mute an alert after the initial notification, while you work on resolving the underlying issue.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
The alerts, silences, and alerting rules that are available in the Alerting UI relate to the projects that you have access to. For example, if you are logged in with `cluster-admin` or `dedicated-admin` privileges, all alerts, silences, and alerting rules are accessible.
|
||||
====
|
||||
|
||||
// Accessing the Alerting UI in the Administrator and Developer perspectives
|
||||
include::modules/monitoring-accessing-the-alerting-ui.adoc[leveloffset=+1]
|
||||
|
||||
// Searching and filtering alerts, silences, and alerting rules
|
||||
include::modules/monitoring-searching-alerts-silences-and-alerting-rules.adoc[leveloffset=+1]
|
||||
|
||||
// Getting information about alerts, silences and alerting rules
|
||||
include::modules/monitoring-getting-information-about-alerts-silences-and-alerting-rules.adoc[leveloffset=+1]
|
||||
|
||||
// Managing silences
|
||||
include::modules/monitoring-managing-silences.adoc[leveloffset=+1]
|
||||
include::modules/monitoring-silencing-alerts.adoc[leveloffset=+2]
|
||||
include::modules/monitoring-editing-silences.adoc[leveloffset=+2]
|
||||
include::modules/monitoring-expiring-silences.adoc[leveloffset=+2]
|
||||
|
||||
// Managing alerting rules for user-defined projects
|
||||
include::modules/monitoring-managing-alerting-rules-for-user-defined-projects.adoc[leveloffset=+1]
|
||||
include::modules/monitoring-optimizing-alerting-for-user-defined-projects.adoc[leveloffset=+2]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* See the link:https://prometheus.io/docs/practices/alerting/[Prometheus alerting documentation] for further guidelines on optimizing alerts
|
||||
* See xref:../../osd_cluster_admin/osd_monitoring/osd-understanding-the-monitoring-stack.adoc#osd-understanding-the-monitoring-stack[Monitoring overview] for details about {product-title} {product-version} monitoring architecture
|
||||
|
||||
include::modules/monitoring-creating-alerting-rules-for-user-defined-projects.adoc[leveloffset=+2]
|
||||
include::modules/monitoring-reducing-latency-for-alerting-rules-that-do-not-query-platform-metrics.adoc[leveloffset=+2]
|
||||
|
||||
* See xref:../../osd_cluster_admin/osd_monitoring/osd-understanding-the-monitoring-stack.adoc#osd-understanding-the-monitoring-stack[Monitoring overview] for details about {product-title} {product-version} monitoring architecture.
|
||||
|
||||
include::modules/monitoring-accessing-alerting-rules-for-your-project.adoc[leveloffset=+2]
|
||||
include::modules/monitoring-listing-alerting-rules-for-all-projects-in-a-single-view.adoc[leveloffset=+2]
|
||||
include::modules/monitoring-removing-alerting-rules-for-user-defined-projects.adoc[leveloffset=+2]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* See the link:https://prometheus.io/docs/alerting/alertmanager/[Alertmanager documentation]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* See xref:../../osd_cluster_admin/osd_monitoring/osd-understanding-the-monitoring-stack.adoc#osd-understanding-the-monitoring-stack[Monitoring overview] for details about {product-title} monitoring architecture.
|
||||
* See the link:https://prometheus.io/docs/alerting/alertmanager/[Alertmanager documentation] for information about alerting rules.
|
||||
* See the link:https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config[Prometheus relabeling documentation] for information about how relabeling works.
|
||||
* See the link:https://prometheus.io/docs/practices/alerting/[Prometheus alerting documentation] for further guidelines on optimizing alerts.
|
||||
|
||||
// Applying a custom configuration to Alertmanager for user-defined alert routing
|
||||
include::modules/monitoring-applying-a-custom-configuration-to-alertmanager-for-user-defined-alert-routing.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* See link:https://www.pagerduty.com/[the PagerDuty official site] for more information on PagerDuty.
|
||||
* See link:https://www.pagerduty.com/docs/guides/prometheus-integration-guide/[the PagerDuty Prometheus Integration Guide] to learn how to retrieve the `service_key`.
|
||||
* See link:https://prometheus.io/docs/alerting/configuration/[Alertmanager configuration] for configuring alerting through different alert receivers.
|
||||
|
||||
[id="alerts-next-steps"]
|
||||
== Next steps
|
||||
* xref:../../osd_cluster_admin/osd_monitoring/osd-reviewing-monitoring-dashboards.adoc#osd-reviewing-monitoring-dashboards[Reviewing monitoring dashboards]
|
||||
@@ -1,32 +0,0 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="osd-reviewing-monitoring-dashboards"]
|
||||
= Reviewing monitoring dashboards
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: osd-reviewing-monitoring-dashboards
|
||||
|
||||
toc::[]
|
||||
|
||||
{product-title} provides monitoring dashboards that help you understand the state of user-defined projects.
|
||||
|
||||
In the *Developer* perspective, you can access dashboards that provide the following statistics for a selected project:
|
||||
|
||||
* CPU usage
|
||||
* Memory usage
|
||||
* Bandwidth information
|
||||
* Packet rate information
|
||||
|
||||
.Example dashboard in the Developer perspective
|
||||
image::monitoring-dashboard-developer.png[]
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
In the *Developer* perspective, you can view dashboards for only one project at a time.
|
||||
====
|
||||
|
||||
// Reviewing monitoring dashboards as a developer
|
||||
include::modules/osd-monitoring-reviewing-monitoring-dashboards-developer.adoc[leveloffset=+1]
|
||||
|
||||
[id="monitoring-dashboards-next-steps"]
|
||||
== Next steps
|
||||
|
||||
* xref:../../osd_cluster_admin/osd_monitoring/osd-troubleshooting-monitoring-issues.adoc#osd-troubleshooting-monitoring-issues[Troubleshooting monitoring issues]
|
||||
@@ -1,11 +0,0 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="osd-troubleshooting-monitoring-issues"]
|
||||
= Troubleshooting monitoring issues
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: osd-troubleshooting-monitoring-issues
|
||||
|
||||
toc::[]
|
||||
|
||||
Find troubleshooting steps for common monitoring issues with user-defined projects.
|
||||
|
||||
include::modules/osd-monitoring-troubleshooting-issues.adoc[leveloffset=+1]
|
||||
@@ -1,33 +0,0 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="osd-understanding-the-monitoring-stack"]
|
||||
= Understanding the monitoring stack
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
:context: osd-understanding-the-monitoring-stack
|
||||
|
||||
toc::[]
|
||||
|
||||
In {product-title}, you can monitor your own projects in isolation from Red Hat Site Reliability Engineer (SRE) platform metrics. You can monitor your own projects without the need for an additional monitoring solution.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
Follow the instructions in this document carefully to configure a supported Prometheus instance for monitoring user-defined projects. Custom Prometheus instances are not supported by {product-title}.
|
||||
====
|
||||
|
||||
// Understanding the monitoring stack
|
||||
include::modules/osd-monitoring-understanding-the-monitoring-stack.adoc[leveloffset=+1]
|
||||
include::modules/osd-monitoring-components-for-monitoring-user-defined-projects.adoc[leveloffset=+2]
|
||||
include::modules/osd-monitoring-targets-for-user-defined-projects.adoc[leveloffset=+2]
|
||||
|
||||
[role="_additional-resources"]
|
||||
[id="understanding-the-monitoring-stack-additional-resources"]
|
||||
== Additional resources
|
||||
|
||||
* xref:../../osd_cluster_admin/osd_monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]
|
||||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.7/html/monitoring/monitoring-overview#default-monitoring-components_monitoring-overview[Default monitoring components]
|
||||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.7/html/monitoring/monitoring-overview#default-monitoring-targets_monitoring-overview[Default monitoring targets]
|
||||
// TODO: When there is a link to the OCP docs, should that be explicit, so they're not surprised when they find themselves in another doc set?
|
||||
|
||||
[id="understanding-the-monitoring-stack-next-steps"]
|
||||
== Next steps
|
||||
|
||||
* xref:../../osd_cluster_admin/osd_monitoring/osd-accessing-monitoring-for-user-defined-projects.adoc#osd-accessing-monitoring-for-user-defined-projects[Accessing monitoring for user-defined projects]
|
||||
@@ -1 +0,0 @@
|
||||
../snippets
|
||||
@@ -66,7 +66,7 @@ include::modules/deleting-cluster.adoc[leveloffset=+1]
|
||||
* xref:../adding_service_cluster/adding-service.adoc#adding-service[Adding services to a cluster using the {cluster-manager} console]
|
||||
* xref:../osd_cluster_admin/osd_nodes/osd-nodes-machinepools-about.adoc#osd-machine-pools-about[About machine pools]
|
||||
* xref:../osd_cluster_admin/osd_nodes/osd-nodes-about-autoscaling-nodes.adoc#nodes-about-autoscaling-nodes[About autoscaling nodes on a cluster]
|
||||
* xref:../osd_cluster_admin/osd_monitoring/osd-configuring-the-monitoring-stack.adoc#osd-configuring-the-monitoring-stack[Configuring the monitoring stack]
|
||||
* xref:../monitoring/osd-configuring-the-monitoring-stack.adoc#osd-configuring-the-monitoring-stack[Configuring the monitoring stack]
|
||||
|
||||
[id="additional-resources_{context}"]
|
||||
== Additional resources
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
../../_attributes/
|
||||
@@ -1 +0,0 @@
|
||||
../images/
|
||||
@@ -1 +0,0 @@
|
||||
../modules/
|
||||
@@ -1 +0,0 @@
|
||||
../snippets
|
||||
@@ -73,7 +73,7 @@ include::modules/rosa-getting-started-deleting-a-cluster.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../adding_service_cluster/adding-service.adoc#adding-service[Adding services to a cluster using the {cluster-manager} console]
|
||||
* xref:../rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc#rosa-managing-worker-nodes[Managing compute nodes]
|
||||
* xref:../rosa_cluster_admin/rosa_monitoring/rosa-configuring-the-monitoring-stack.adoc#rosa-configuring-the-monitoring-stack[Configuring the monitoring stack]
|
||||
* xref:../monitoring/rosa-configuring-the-monitoring-stack.adoc#rosa-configuring-the-monitoring-stack[Configuring the monitoring stack]
|
||||
|
||||
[role="_additional-resources"]
|
||||
[id="additional-resources_{context}"]
|
||||
|
||||
@@ -149,7 +149,7 @@ include::modules/rosa-getting-started-deleting-a-cluster.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../adding_service_cluster/adding-service.adoc#adding-service[Adding services to a cluster using the {cluster-manager} console]
|
||||
* xref:../rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc#rosa-managing-worker-nodes[Managing compute nodes]
|
||||
* xref:../rosa_cluster_admin/rosa_monitoring/rosa-configuring-the-monitoring-stack.adoc#rosa-configuring-the-monitoring-stack[Configuring the monitoring stack]
|
||||
* xref:../monitoring/rosa-configuring-the-monitoring-stack.adoc#rosa-configuring-the-monitoring-stack[Configuring the monitoring stack]
|
||||
|
||||
[role="_additional-resources"]
|
||||
[id="additional-resources_{context}"]
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="showing-data-collected-by-remote-health-monitoring"]
|
||||
= Showing data collected by remote health monitoring
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
ifdef::openshift-dedicated[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
endif::[]
|
||||
:context: showing-data-collected-by-remote-health-monitoring
|
||||
|
||||
toc::[]
|
||||
|
||||
As an administrator, you can review the metrics collected by Telemetry and the Insights Operator.
|
||||
|
||||
include::modules/telemetry-showing-data-collected-from-the-cluster.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/insights-operator-showing-data-collected-from-the-cluster.adoc[leveloffset=+1]
|
||||
@@ -20,6 +20,7 @@ include::modules/security-audit-log-filtering.adoc[leveloffset=+1]
|
||||
// Gathering audit logs
|
||||
include::modules/gathering-data-audit-logs.adoc[leveloffset=+1]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
[id="viewing-audit-logs-additional-resources"]
|
||||
[role="_additional-resources"]
|
||||
== Additional resources
|
||||
@@ -28,3 +29,4 @@ include::modules/gathering-data-audit-logs.adoc[leveloffset=+1]
|
||||
* link:https://github.com/kubernetes/apiserver/blob/master/pkg/apis/audit/v1/types.go#L72[API audit log event structure]
|
||||
* xref:../security/audit-log-policy-config.adoc#audit-log-policy-config[Configuring the audit log policy]
|
||||
* xref:../logging/cluster-logging-external.adoc#cluster-logging-external[Forwarding logs to third party systems]
|
||||
endif::[]
|
||||
|
||||
Reference in New Issue
Block a user