Skip to content

Display Prometheus button by default, and add empty/error states

Resources

PM @joshlambert | FE @jivanvl | UX @pedroms

Description

Presently with 9.0, the option to display Prometheus data only shows if the service has been configured as well as if data exists. Unfortunately this means it can be quite hard to discover the Prometheus integration, as well as see any errors on why the button may not be showing up for an environment.

To resolve this, we should do three things:

  1. Display the monitoring button for an environment at all times
  2. Display the empty state when a user clicks into the performance view without the service configured
  3. Display the appropriate error state, when an error condition occurs to more easily properly configure the service/queries

Display the Monitoring button at all time

The button to display the performance metrics for an environment should be displayed at all times, removing the logic where it checks to see if the service is active and has metrics.

For displaying the Monitoring button on the environments list see https://gitlab.com/gitlab-org/gitlab-ce/issues/29341

Display empty state when a user views the monitoring view for an environment, when service is not configured

Get started with performance monitoring

Stay updated about the performance and health of your environment by configuring Prometheus to easily monitor your deployments. Visit our documentation to [learn more about performance monitoring]. link to documentation

Configure Prometheus to get started

environments__monitoring--get-started-2

Display Error States

Attempting to load performance data

We are working on creating your graphs using the data from the Prometheus server. More information is available in our documentation.

[View documentation] button to documentation

environments__monitoring--loading-data

Unable to connect to Prometheus server

An error has occurred in contacting the Prometheus server. Please ensure connectivity is available from the GitLab server to the configured Prometheus server.

[View documentation] button to documentation

environments__monitoring--error1

Links / references

Empty states svgs: graphics-svg.zip