User Interface

PMM’s user interface is a browser application based on Grafana.



Dashboards

The interface is a collection of web pages called dashboards.

Dashboards are grouped into folders. You can customize these, renaming them or creating new ones.

The area inside dashboards is populated by panels, many of which are in collapsible panel groups. A panel can show a value, a graph, a chart, or a visual representation of a set.

Logging in

  1. Start a web browser and enter the server name or IP address of the PMM server host.

  2. Enter the username and password given to you by your system administrator.

    The defaults are:

    • Username: admin
    • Password: admin
  3. Click Log in

  4. If this is your first time logging in, you’ll be asked to set a new password. (We recommend you do.) Enter a new password in both fields and click Submit.

  5. If you wish, you can click Skip and continue using the default password.

  6. The PMM Home dashboard loads.

    PMM Home dashboard

User interface controls: Common

Top row menu bar

Common page elements top row

Items (left) Description
(Display only)
(Name) / (Optional) Folder name
(Name) Dashboard name
Mark as favorite
Share dashboard
Items (right) Description
Dashboard settings
Cycle view mode
(time range) Time range selector
Time range zoom out
Refresh dashboard
(Time interval) Refresh period

Second row menu bar

This menu bar is context sensitive; it changes according to the page you are on.

The items are grouped left and right. (With wide menus on small screens, items may wrap to the next row.)

  • Left: Filters and controls for the viewed data
  • Right: Links to other dashboards

Second row (home)

Left group items

Items Description
Interval Data interval
Region Filter by region
Environment Filter by environment
Cluster Filter by cluster
Replication Set Filter by replication set
Node Name Filter by node name
Service Name Filter by service name
PMM Annotations View annotations

Right group items

Items Description
Home Home dashboard
Query Analytics Query Analytics
Compare Nodes compare
(Service Type) Service type menu (see below)
HA HA dashboards
Services Services menu
PMM PMM menu

Note

The Compare menu links to the Instances Overview dashboard for the current service type.

Services menu

The Services menu choice determines the Service Type menu.

Menu Items Service type menu Description
Services
MongoDB Instances Overview MongoDB MongoDB dashboards
MySQL Instances Overview MySQL MySQL dashboards
Nodes Overview OS OS dashboards
PostgreSQL Instances Overview PostgreSQL PostgreSQL dashboards
PMM menu

This item lists shortcuts to utility pages.

Menu Items
PMM
PMM Add Instance
PMM Database Checks
PMM Inventory
PMM Settings

Vertical menu bar (left)

The vertical menu bar (left) is part of the Grafana framework and is visible on every page.

Left menu

Items (Top) Name
Home
Search
Create
Dashboards
Explore
Alerting
Configuration
Server Admin
DBaaS

Note

The DBaaS icon appears only if a server feature flag has been set.

Icons (Bottom) Description
(Profile icon) User menu
Help

There are several ways to open a dashboard.

By name

  1. Click the dashboard name (to the right of the icon)

  2. A search field appears labeled Search dashboards by name Search dashboards by name

  3. Click it and begin typing any part of the dashboard name (in this example, “Instances”) Search dashboards by name

  4. Click one of the search results to go to that dashboard

  5. To abandon the search, click the icon at the end of the search bar

Tip

To search within the current folder, click the folder’s name.

By menu

Use the second row main menu. (See Second row menu bar.)

Panels

Charts, graphs and set-based panels reveal additional information when the mouse is moved over them.

Some panels have an information icon in the top left corner. Mouse over this to reveal panel information.

Panel menu

At the top of each panel and to the right of the panel name is the panel menu.

image

Tip

The presence of the menu is hidden until you mouse over it. Look for the symbol in the title bar of a panel.

Item Description
View Open the panel in full window mode
Share Render the panel’s image for sharing
Explore Run PromQL queries
Inspect See the panel’s data or definition
More (Only charts and graphs) Additional options

View

The View menu items opens panels in full-window mode. This is useful for graphs with several metrics.

Exit a panel’s full window mode by pressing Escape or clicking the left arrow next to the dashboard name.

Rendering dashboard images

PMM Server can’t currently directly render dashboard images exported by Grafana without these additional set-up steps.

Part 1: Install dependencies

  1. Connect to your PMM Server Docker container.

    docker exec -it pmm-server bash
    
  2. Install Grafana plugins.

    grafana-cli plugins install grafana-image-renderer
    
  3. Restart Grafana.

    supervisorctl restart grafana
    
  4. Install additional libraries.

    yum install -y libXcomposite libXdamage libXtst cups libXScrnSaver pango \
    atk adwaita-cursor-theme adwaita-icon-theme at at-spi2-atk at-spi2-core \
    cairo-gobject colord-libs dconf desktop-file-utils ed emacs-filesystem \
    gdk-pixbuf2 glib-networking gnutls gsettings-desktop-schemas \
    gtk-update-icon-cache gtk3 hicolor-icon-theme jasper-libs json-glib \
    libappindicator-gtk3 libdbusmenu libdbusmenu-gtk3 libepoxy \
    liberation-fonts liberation-narrow-fonts liberation-sans-fonts \
    liberation-serif-fonts libgusb libindicator-gtk3 libmodman libproxy \
    libsoup libwayland-cursor libwayland-egl libxkbcommon m4 mailx nettle \
    patch psmisc redhat-lsb-core redhat-lsb-submod-security rest spax time \
    trousers xdg-utils xkeyboard-config alsa-lib
    

Part 2 - Share the image

  1. Navigate to the dashboard you want to share.

  2. Open the panel menu.

  3. Select Share to reveal the Share Panel.

    image

  4. Click Direct link rendered image.

  5. A new browser tab opens. Wait for the image to be rendered then use your browser’s image save function to download the image.

If the necessary plugins are not installed, a message in the Share Panel will say so.

image

Annotations

Annotations mark a moment in time. They are useful for marking system changes or other significant application events. They can be set globally or for specific nodes or services.

You create them on the command line with the pmm-admin annotate command.

Annotations show as a vertical dashed line on a dashboard graph. Reveal the annotation text by mousing over the caret indicator below the line.

image

You turn annotations on or off with the PMM Annotations switch in the second row menu bar.

PMM Annotations switch

  • Page updated 2021-01-13

Contents

Previous topic

Using: Overview

Next topic

Integrated Alerting

Contact Us

For free technical help, visit the Percona Community Forum.
To report bugs or submit feature requests, open a JIRA ticket.
For paid support and managed or professional services, contact Percona Sales.