Skip to content

Commit 5c62c29

Browse files
authored
Merge pull request #60966 from ekristova/RHDEVDOCS-3819
RHDEVDOCS-3819: [UG] How to store and retrieve logs
2 parents c911edb + 96019be commit 5c62c29

File tree

3 files changed

+62
-0
lines changed

3 files changed

+62
-0
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1943,6 +1943,8 @@ Topics:
19431943
File: configuring-resource-quota
19441944
- Name: Monitoring Argo CD custom resource workloads
19451945
File: monitoring-argo-cd-custom-resource-workloads
1946+
- Name: Viewing Argo CD logs
1947+
File: viewing-argo-cd-logs
19461948
- Name: Running Control Plane Workloads on Infra nodes
19471949
File: run-gitops-control-plane-workload-on-infra-nodes
19481950
- Name: Sizing requirements for GitOps Operator

cicd/gitops/viewing-argo-cd-logs.adoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
:_content-type: ASSEMBLY
2+
[id="viewing-argo-cd-logs"]
3+
= Viewing Argo CD logs
4+
include::_attributes/common-attributes.adoc[]
5+
:context: viewing-argo-cd-logs
6+
7+
toc::[]
8+
9+
You can view the Argo CD logs with the {logging-title}. The {logging} visualizes the logs on a Kibana dashboard. The OpenShift Logging Operator enables logging with Argo CD by default.
10+
11+
include::modules/gitops-storing-and-retrieving-argo-cd-logs.adoc[leveloffset=+1]
12+
13+
[role="_additional-resources"]
14+
[id="additional-resources_viewing-argo-cd-logs"]
15+
== Additional resources
16+
* xref:../../logging/cluster-logging-deploying.adoc#cluster-logging-deploy-console_cluster-logging-deploying[Installing the {logging-title} using the web console]
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * cicd/gitops/viewing-argo-cd-logs.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="gitops-storing-and-retrieving-argo-cd-logs_{context}"]
7+
= Storing and retrieving Argo CD logs
8+
9+
You can use the Kibana dashboard to store and retrieve Argo CD logs.
10+
11+
.Prerequisites
12+
13+
* The {gitops-title} Operator is installed in your cluster.
14+
* The {logging-title} is installed with default configuration in your cluster.
15+
16+
.Procedure
17+
18+
. In the {product-title} web console, go to the {rh-app-icon} menu -> *Observability* -> *Logging* to view the Kibana dashboard.
19+
20+
. Create an index pattern.
21+
22+
.. To display all the indices, define the index pattern as `pass:[*]`, and click *Next step*.
23+
24+
.. Select *@timestamp* for *Time Filter field name*.
25+
26+
.. Click *Create index pattern*.
27+
28+
. In the navigation panel of the Kibana dashboard, click the *Discover* tab.
29+
30+
. Create a filter to retrieve logs for Argo CD. The following steps create a filter that retrieves logs for all the pods in the `openshift-gitops` namespace:
31+
32+
.. Click *Add a filter +*.
33+
34+
.. Select the *kubernetes.namespace_name* field.
35+
36+
.. Select the *is* operator.
37+
38+
.. Select the *openshift-gitops* value.
39+
40+
.. Click *Save*.
41+
42+
. Optional: Add additional filters to narrow the search. For example, to retrieve logs for a particular pod, you can create another filter with `kubernetes.pod_name` as the field.
43+
44+
. View the filtered Argo CD logs in the Kibana dashboard.

0 commit comments

Comments
 (0)