Monitoring via ArgoCD
This page serves as a general guide to using ArgoCD for monitoring purposes
Table of Contents
ArgoCD is implemented as a kubernetes controller which continuously monitors running applications and compares the current, live state against the desired target state (as specified in your Git repo).
You can use ArgoCD's dashboard (Image 1) to visually monitor your namespaces and pods, and to quickly visualize deployment issues. It can easily show you what your cluster or pods are doing, and if they are healthy.
Image 1: An example ArgoCD Dashboard
ArgoCD has a robust set of documentation that can help you to get started with the application. We recommend the following two pages:
Your ArgoCD dashboard contains a lot of important information about how your Cinchy instance is behaving.
The application tiles view is the default view when logging into ArgoCD. You can also access it through the grid widget in the upper right hand corner of the screen.
These application tiles each represent a pod in one of your Cinchy environments. By default, you should have an application tile for each of the following pods per namespace (Image 2):
- Event Listener
- Maintenance CLI
- Meta Forms
Each application tile shows you some important information about the pod, including its health and sync status. You can easily use the Sync, Refresh, and Delete buttons to manage your pods.
You can also click the star button on any application title to favourite the associated pod.
Image 2: A pod in ArgoCD
The pie chart view (Image 3) shows an easy visualization of the health of your applications. Access this view by clicking on the pie chart widget located in the upper right hand corner of the screen.
Image 3: Pie chart view
You can filter your view so that it only shows certain data. You can find the various filter options from the Filter column on the left hand side of any of the data views.
- Favorites Only: You can filter by only the tiles that you have favourited (Image 4).
Image 4: Filter by Favorites
- Sync Status: You can easily view what is out of sync using this filter (Image 5).
Image 5: Filter by Sync Status
- Health Status: Check on the health of your applications by filtering using these parameters (Image 6).
Image 6: Filter by Health Status
- Labels: Use these labels to filter by specific instances/environments (Image 7).
Image 7: Filtering via label
- Projects: If you choose to group your applications into projects, you can filter them using this tile (Image 8).
Image 8: Filtering via project
- Clusters: If you have more than one cluster, you can filter for it using the Clusters tile (Image 9).
Image 9: Filtering by cluster
- Namespace: Lastly, you can filter by Namespace. The below example shows a filter based on the dev-aurora-1 namespace (Image 10).
Image 10: Namespace view
To bring up a more detailed view of your applications, click on the application tile. This view will show you all of components, their health and their sync status (Image 11). You can use the top navigational buttons perform actions such as syncing, rolling back, or refreshing.
This view can be particularly useful for load testing, snice you can see each individual pod spinning up and down.
Image 11: Detailed view
Quickly view the status of your apps by looking at the health and sync status along the top of the page (Image 12).
Image 12: Health and Sync Status
Clicking on any individual pod or component tile in this view will bring up its information, including a Summary, a list of Events, your Manifest, and Parameters (Image 13).
You can also use this screen to edit or delete applications.
Image 13: Individual information
From the detailed tile summary you can also set your sync policies, such as automation, resource pruning, and self healing (Image 14).
Image 14: Sync Policy
You can click on the "Logs" tab in your detailed summary page to view the applicable logs for your selected pod (Image 15). You can filter, follow, snooze, copy, or download any logs.
Image 15: Logs