docs: App metrics doc updated #43
Conversation
|
|
||
|  | ||
| Before installing Prometheus from the chart store, manually apply the necessary CRDs in your cluster. |
There was a problem hiding this comment.
Is this required? I doubt. I guess the chart includes CRDs as well
There was a problem hiding this comment.
It's required. The CRDs do not get applied by the helm chart, hence we have to do it manually.
|
|
||
| **Note: Since, all the requests are passed through envoy, any misconfiguration in envoy configs can bring your application down, so please test the configurations in a non-production environment extensively.** | ||
| To use the Grafana dashboard, you need to first install the integration from the Devtron Stack Manager. |
There was a problem hiding this comment.
Give an interlinking to our Devtron Stack Manager doc.
| This application metrics indicates the number of request processed by an application per minute. | ||
| 4. **Setup Prometheus Endpoint:** | ||
|
|
||
| Once Prometheus is installed, navigate to `Networking → Service` in the K8s resources. Expand the Prometheus server service to see the endpoints. |
There was a problem hiding this comment.
Can we rephrase it:
Once Prometheus is installed, go to its **App Details** page and navigate to ...
|
|
||
| ## Latency Metrics | ||
| To set Prometheus as a data source in Grafana, navigate to `Global Configurations → Clusters & Environments`, select your cluster, and edit its settings. |
There was a problem hiding this comment.
navigate to Global Configurations → Clusters & Environments
navigate to Global Configurations → Clusters & Environments
(use Bold tag **)
|
|
||
|  | ||
|  |
There was a problem hiding this comment.
Let's do this for other figure captions as well.
| ## Checklist for enabling Advanced Application metrics in Production | ||
| To enable Throughput and Latency metrics in Devtron, follow these steps: | ||
| - Open your Devtron app. | ||
| - Go to `Configurations → Base Configurations → Deployment Template`. |
There was a problem hiding this comment.
Go to Configurations → Base Configurations → Deployment Template.
Go to Configurations → Base Configurations → Deployment Template.
(Bold tag expected for prominent pages, sections, and buttons)
| {% hint style="warning" %} |
There was a problem hiding this comment.
Seems to be an incorrect indentation, this will not render correctly
Remove the initial whitespaces
| {% hint style="warning" %} | ||
| **Note:** Enable metrics option is only available for [Devtron charts](https://docs.devtron.ai/usage/deploy-chart) and not for [Custom Deployment Charts](https://docs.devtron.ai/devtron/v0.6/global-configurations/custom-charts). |
There was a problem hiding this comment.
Will not render neatly...
Gitbook follows this syntax
{% hint style="warning" %}
### Note (or any other text)
blah blah blah
{% endhint %}
There was a problem hiding this comment.
We should not use absolute paths for linking:
[Devtron charts](https://docs.devtron.ai/usage/deploy-chart)
[Custom Deployment Charts](https://docs.devtron.ai/devtron/v0.6/global-configurations/custom-charts)
It should be interlinking (relative paths)
[Devtron Charts](../deploy-chart/README.md)
[Custom Deployment Chart](../global-configurations/deployment-charts.md)
|  | ||
|
|
||
| Now, you can track all your application metrics by navigating to `Devtron Apps → Your App → App Details`, where you can view the Application Metrics as shown below. |
There was a problem hiding this comment.
Devtron Apps → Your App → App Details
...navigating to Applications and going to the App Details page of your Devtron App as shown below.
|
|
||
| **99.9th percentile latency**: The maximum latency, in seconds, for the fastest 99.9% of requests. | ||
| Now to set up the Prometheus endpoint: | ||
| - Enable the See metrics for applications in this cluster option, as shown in the image below. |
There was a problem hiding this comment.
Since this is a checkbox option, we need to make it prominent by either:
See metrics for applications in this cluster OR See metrics for applications in this cluster
(1st one is preferable)
|
|
||
| Memory usage is a utilization metric that shows the overall utilization of memory by an application. It is available as both, aggregated or per pod. | ||
| 3. **Enable `upgradeJob` paramter to install CRDs:** |
|
|
||
| **95th percentile latency**: The maximum latency, in seconds, for the fastest 95% of requests. | ||
| After adding the endpoint, application metrics will be visible in the Devtron dashboard for all the Devtron apps in the cluster. This includes CPU usage and Memory usage. |
There was a problem hiding this comment.
it may take some time after adding, ~3-5 mins
| ## Checklist for enabling Advanced Application metrics in Production | ||
| To enable Throughput and Latency metrics in Devtron, follow these steps: | ||
| - Open your Devtron app. | ||
| - Go to **Configurations → Base Configurations → Deployment Template**. |
There was a problem hiding this comment.
If the env is overridden this won't work!!
|  | ||
|
|
||
| Now, you can track all your application metrics by navigating to Applications and going to the App Details page of your Devtron App as shown below. |
There was a problem hiding this comment.
will the normal metrics (CPU / Memory) will work in case of custom charts?
| {% hint style="warning" %} | ||
| ### Note | ||
| You won’t be able to enable the Application Metrics if your environment is [Overridden](../creating-application/environment-overrides.md). |
There was a problem hiding this comment.
🥲 You can u just need to do it at env override and not base configuration
No description provided.