Setting Up Metrics Visualization

Porter supports visualizing the resources (CPU/memory) that your applications are consuming over different time ranges. This is done by querying a Prometheus add-on deployed on your cluster.

Deploying the Prometheus Addon

Navigate to Launch > Community Add-ons > Prometheus in order to install the Prometheus addon. No configuration settings are necessary to install this chart.

Install PrometheusInstall Prometheus

Viewing Application Metrics

Navigate to the "Applications" tab for a cluster. After installing Prometheus, there will be a "Metrics" tab after you click on the application. Initially, these metrics will not show anything: after about an hour, it should start to display the application resource usage:

Metrics ViewMetrics View

The default behavior is to display the summed resource usage of all currently running pods over the selected time range. You can view the resource usage of individual pods by clicking on the settings button:

Metrics Pod SelectionMetrics Pod Selection

Viewing NGINX Metrics

Porter also supports viewing the error percentage of 500-level errors for your applications. Go to the ingress-nginx namespace and click on the nginx-ingress deployment. In the "Metrics" tab, there will be an additional metric called 5XX Error Percentage:

nginx-errorsnginx-errors

For Clusters Created Before April 16th, 2021

By default, new Porter clusters will show the NGINX error percentage automatically, as long as Prometheus is installed. However, if you installed the cluster before April 16th, 2021, you will need to update the NGINX chart. Go to the "Applications" tab and select "All" for the Filter. You should click on the chart called nginx-ingress and click on the "DevOps Mode" button. Then click on the "Helm Values" tab. You can then copy/paste the following yaml into the values:

controller:
  metrics:
    annotations:
      prometheus.io/port: '10254'
      prometheus.io/scrape: 'true'
    enabled: true
  podAnnotations:
    prometheus.io/port: '10254'
    prometheus.io/scrape: 'true'

🚧

Don't Overwrite YAML

Warning: careful not to overwrite existing yaml! You should merge any existing values with these values.

Now click "Update Values". After a few seconds it should have reloaded, and you will be able to view the NGINX 5XX error percentage.