Skip to content

Commit e9baf0d

Browse files
committed
ml-jira-2756:Documented monitoring Argo CD instances
Miner update to address merge review.
1 parent f667291 commit e9baf0d

File tree

3 files changed

+43
-0
lines changed

3 files changed

+43
-0
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1944,6 +1944,8 @@ Topics:
19441944
File: uninstalling-openshift-gitops
19451945
- Name: Setting up a new Argo CD instance
19461946
File: setting-up-argocd-instance
1947+
- Name: Monitoring Argo CD instances
1948+
File: monitoring-argo-cd-instances
19471949
- Name: Using Argo Rollouts for progressive deployment delivery
19481950
File: using-argo-rollouts-for-progressive-deployment-delivery
19491951
- Name: Configuring an OpenShift cluster by deploying an application with cluster configurations
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
:_content-type: ASSEMBLY
2+
[id="monitoring-argo-cd-instances"]
3+
= Monitoring Argo CD instances
4+
include::_attributes/common-attributes.adoc[]
5+
:context: monitoring-argo-cd-instances
6+
7+
toc::[]
8+
9+
By default, the {gitops-title} Operator automatically detects an installed Argo CD instance in your defined namespace, for example, `openshift-gitops`, and connects it to the monitoring stack of the cluster to provide alerts for out-of-sync applications.
10+
11+
.Prerequisites
12+
* You have access to the cluster with `cluster-admin` privileges.
13+
* You have access to the {product-title} web console.
14+
* You have installed the {gitops-title} Operator in your cluster.
15+
* You have installed an Argo CD application in your defined namespace, for example, `openshift-gitops`.
16+
17+
include::modules/gitops-monitoring-argo-cd-health-using-prometheus-metrics.adoc[leveloffset=+1]
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * cicd/gitops/monitoring-argo-cd-instances.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="gitops-monitoring-argo-cd-health-using-promethous-metrics_{context}"]
7+
= Monitoring Argo CD health using Prometheus metrics
8+
9+
You can monitor the health status of an Argo CD application by running Prometheus metrics queries against it.
10+
11+
.Procedure
12+
13+
. In the *Developer* perspective of the web console, select the namespace where your Argo CD application is installed, and navigate to *Observe* -> *Metrics*.
14+
. From the *Select query* drop-down list, select *Custom query*.
15+
. To check the health status of your Argo CD application, enter the Prometheus Query Language (PromQL) query similar to the following example in the *Expression* field:
16+
+
17+
.Example
18+
[source, terminal]
19+
----
20+
sum(argocd_app_info{dest_namespace=~"<your_defined_namespace>",health_status!=""}) by (health_status) <1>
21+
----
22+
<1> Replace the `<your_defined_namespace>` variable with the actual name of your defined namespace, for example `openshift-gitops`.
23+
24+

0 commit comments

Comments
 (0)