diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index f5020b0958..9b57d58c16 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -2075,8 +2075,8 @@ Topics: File: managing-alerts - Name: Reviewing monitoring dashboards File: reviewing-monitoring-dashboards -- Name: Accessing third-party UIs - File: accessing-third-party-uis +- Name: Accessing third-party monitoring UIs and APIs + File: accessing-third-party-monitoring-uis-and-apis - Name: Troubleshooting monitoring issues File: troubleshooting-monitoring-issues --- diff --git a/modules/monitoring-accessing-third-party-monitoring-uis.adoc b/modules/monitoring-accessing-third-party-monitoring-uis.adoc new file mode 100644 index 0000000000..111fbbbc31 --- /dev/null +++ b/modules/monitoring-accessing-third-party-monitoring-uis.adoc @@ -0,0 +1,18 @@ +// Module included in the following assemblies: +// +// * monitoring/accessing-third-party-monitoring-uis-and-apis.adoc + +:_content-type: CONCEPT +[id="accessing-third-party-monitoring-uis"] += Accessing third-party monitoring UIs + +[role="_abstract"] +{product-title} does not provide or support direct access to third-party web user interfaces (UIs) for the following components in the monitoring stack: Alertmanager, Thanos Ruler, and Thanos Querier. +As an alternative to these third-party UIs, navigate to the *Observe* section of the {product-title} web console to access metrics, alerting, metrics targets, and dashboard UIs for platform components. + +[NOTE] +==== +Although you can access the third-party Grafana and Prometheus web UIs from the web console or the CLI, this access is deprecated and is planned to be removed in a future {product-title} release. +==== + + diff --git a/modules/monitoring-accessing-third-party-monitoring-web-service-apis.adoc b/modules/monitoring-accessing-third-party-monitoring-web-service-apis.adoc new file mode 100644 index 0000000000..fee9fec6ce --- /dev/null +++ b/modules/monitoring-accessing-third-party-monitoring-web-service-apis.adoc @@ -0,0 +1,26 @@ +// Module included in the following assemblies: +// +// * monitoring/accessing-third-party-monitoring-uis-and-apis.adoc + +:_content-type: PROCEDURE +[id="accessing-third-party-monitoring-web-service-apis"] += Accessing third-party monitoring web service APIs + +[role="_abstract"] +You can directly access third-party web service APIs from the command line for monitoring stack components such as Prometheus, Alertmanager, Thanos Ruler, and Thanos Querier. + +The following example shows how to query the service API receivers for Alertmanager. +This example requires that the associated user account be bound against the `monitoring-alertmanager-edit` role in the `openshift-monitoring` namespace and that the account has the privilege to view the route. +This access only supports using a Bearer Token for authentication. + +[source, terminal] +---- +$ host=$(oc -n openshift-monitoring get route alertmanager-main -ojsonpath={.spec.host}) +$ token=$(oc whoami -t) +$ curl -H "Authorization: Bearer $token" -k "https://$host/api/v2/receivers" +---- + +[NOTE] +==== +To access Thanos Ruler and Thanos Querier service APIs, the requesting account must have `get` permission on the namespaces resource, which can be done by granting the `cluster-monitoring-view` cluster role to the account. +==== \ No newline at end of file diff --git a/monitoring/accessing-third-party-monitoring-uis-and-apis.adoc b/monitoring/accessing-third-party-monitoring-uis-and-apis.adoc new file mode 100644 index 0000000000..21f1922859 --- /dev/null +++ b/monitoring/accessing-third-party-monitoring-uis-and-apis.adoc @@ -0,0 +1,26 @@ +:_content-type: ASSEMBLY +[id="accessing-third-party-monitoring-uis-and-apis"] += Accessing third-party monitoring UIs and APIs +include::_attributes/common-attributes.adoc[] +:context: accessing-third-party-monitoring-uis-and-apis + +toc::[] + +[role="_abstract"] +In {product-title} {product-version}, you cannot access third-party web browser user interfaces (UIs) for the following monitoring components: Alertmanager, Thanos Ruler, and Thanos Querier. +However, you can access web UIs for Grafana and Prometheus, although this access is deprecated and is planned to be removed in a future {product-title} release. +In addition, you can access web service APIs for third-party monitoring components from the command line interface (CLI). + +// Accessing web UIs for third-party monitoring components +include::modules/monitoring-accessing-third-party-monitoring-uis.adoc[leveloffset=+1] + +// Accessing service APIs for third-party monitoring components +include::modules/monitoring-accessing-third-party-monitoring-web-service-apis.adoc[leveloffset=+1] + +[role="_additional-resources"] +[id="additional-resources_accessing-third-party-monitoring-uis-and-apis"] +== Additional resources + +* xref:../monitoring/managing-metrics.adoc#managing-metrics[Managing metrics] +* xref:../monitoring/managing-alerts.adoc#managing-alerts[Managing alerts] +* xref:../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[Reviewing monitoring dashboards] diff --git a/monitoring/accessing-third-party-uis.adoc b/monitoring/accessing-third-party-uis.adoc deleted file mode 100644 index ffca4e229d..0000000000 --- a/monitoring/accessing-third-party-uis.adoc +++ /dev/null @@ -1,18 +0,0 @@ -:_content-type: ASSEMBLY -[id="accessing-third-party-uis"] -= Accessing third-party UIs -include::_attributes/common-attributes.adoc[] -:context: accessing-third-party-uis - -toc::[] - -{product-title} does not provide or support direct access to third-party web user interfaces (UIs) for components in the Monitoring stack such as Prometheus, Grafana, Alertmanager, or Thanos Querier. - -Instead, navigate to the *Observe* section of the {product-title} web console to access Metrics, Alerting, and Dashboard UIs for these platform components. - -[role="_additional-resources"] -.Additional resources - -* xref:../monitoring/managing-metrics.adoc#managing-metrics[Managing metrics] -* xref:../monitoring/managing-alerts.adoc#managing-alerts[Managing alerts] -* xref:../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[Reviewing monitoring dashboards] diff --git a/monitoring/monitoring-overview.adoc b/monitoring/monitoring-overview.adoc index c7ef8b7f6a..5bb6d689ba 100644 --- a/monitoring/monitoring-overview.adoc +++ b/monitoring/monitoring-overview.adoc @@ -9,14 +9,17 @@ toc::[] [id="about-openshift-monitoring"] == About {product-title} monitoring +[role="_abstract"] {product-title} includes a preconfigured, preinstalled, and self-updating monitoring stack that provides monitoring for core platform components. You also have the option to xref:../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[enable monitoring for user-defined projects]. A cluster administrator can xref:../monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[configure the monitoring stack] with the supported configurations. {product-title} delivers monitoring best practices out of the box. A set of alerts are included by default that immediately notify cluster administrators about issues with a cluster. Default dashboards in the {product-title} web console include visual representations of cluster metrics to help you to quickly understand the state of your cluster. With the {product-title} web console, you can xref:../monitoring/managing-metrics.adoc#managing-metrics[view and manage metrics], xref:../monitoring/managing-alerts.adoc#managing-alerts[alerts], and xref:../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[review monitoring dashboards]. -After installing {product-title} {product-version}, cluster administrators can optionally enable monitoring for user-defined projects. By using this feature, cluster administrators, developers, and other users can specify how services and pods are monitored in their own projects. -As a cluster administrator, you can find answers to common problems such as user metrics unavailability and Prometheus consuming a lot of disk space in xref:../monitoring/troubleshooting-monitoring-issues.adoc#troubleshooting-monitoring-issues[troubleshooting monitoring issues]. +In the *Observe* section of {product-title} web console, you can access and manage monitoring features such as xref:../monitoring/managing-metrics.adoc#managing-metrics[metrics], xref:../monitoring/managing-alerts.adoc#managing-alerts[alerts], xref:../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[monitoring dashboards], and xref:../monitoring/managing-metrics-targets.adoc#managing-metrics-targets[metrics targets]. + +After installing {product-title}, cluster administrators can optionally enable monitoring for user-defined projects. By using this feature, cluster administrators, developers, and other users can specify how services and pods are monitored in their own projects. +As a cluster administrator, you can find answers to common problems such as user metrics unavailability and high consumption of disk space by Prometheus in xref:../monitoring/troubleshooting-monitoring-issues.adoc#troubleshooting-monitoring-issues[Troubleshooting monitoring issues]. // Understanding the monitoring stack include::modules/monitoring-understanding-the-monitoring-stack.adoc[leveloffset=+1] @@ -26,12 +29,14 @@ include::modules/monitoring-components-for-monitoring-user-defined-projects.adoc include::modules/monitoring-targets-for-user-defined-projects.adoc[leveloffset=+2] [role="_additional-resources"] +[id="additional-resources_monitoring-overview"] == Additional resources * xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] * xref:../monitoring/enabling-monitoring-for-user-defined-projects.adoc#granting-users-permission-to-monitor-user-defined-projects_enabling-monitoring-for-user-defined-projects[Granting users permission to monitor user-defined projects] * xref:../security/tls-security-profiles.adoc#tls-security-profiles[Configuring TLS security profiles] +[id="next-steps_monitoring-overview"] == Next steps * xref:../monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[Configuring the monitoring stack] diff --git a/monitoring/reviewing-monitoring-dashboards.adoc b/monitoring/reviewing-monitoring-dashboards.adoc index c93042f57e..f9990e6a8a 100644 --- a/monitoring/reviewing-monitoring-dashboards.adoc +++ b/monitoring/reviewing-monitoring-dashboards.adoc @@ -46,6 +46,7 @@ include::modules/monitoring-reviewing-monitoring-dashboards-developer.adoc[level * xref:../applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc#monitoring-project-and-application-metrics-using-developer-perspective[Monitoring project and application metrics using the Developer perspective] +[id="next-steps_reviewing-monitoring-dashboards"] == Next steps -* xref:../monitoring/accessing-third-party-uis.adoc#accessing-third-party-uis[Accessing third-party UIs] +* xref:../monitoring/accessing-third-party-monitoring-uis-and-apis.adoc#accessing-third-party-monitoring-uis-and-apis[Accessing third-party monitoring UIs and APIs]