PMM’s user interface is a browser application based on Grafana.
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.
Start a web browser and enter the server name or IP address of the PMM server host.
Enter the username and password given to you by your system administrator.
The defaults are:
Click Log in
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.
If you wish, you can click Skip and continue using the default password.
The PMM Home dashboard loads.
|(Name) /||(Optional) Folder name|
|Mark as favorite|
|Cycle view mode|
|(time range)||Time range selector|
|Time range zoom out|
|(Time interval)||Refresh period|
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
Left group items
|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
|Query Analytics||Query Analytics|
|(Service Type)||Service type menu (see below)|
The Compare menu links to the Instances Overview dashboard for the current service type.
The Services menu choice determines the Service Type menu.
|Menu||Items||Service type menu||Description|
|MongoDB Instances Overview||MongoDB||MongoDB dashboards|
|MySQL Instances Overview||MySQL||MySQL dashboards|
|Nodes Overview||OS||OS dashboards|
|PostgreSQL Instances Overview||PostgreSQL||PostgreSQL dashboards|
This item lists shortcuts to utility pages.
|PMM Add Instance|
|PMM Database Checks|
The vertical menu bar (left) is part of the Grafana framework and is visible on every page.
The DBaaS icon appears only if a server feature flag has been set.
|(Profile icon)||User menu|
There are several ways to open a dashboard.
Click the dashboard name (to the right of the icon)
A search field appears labeled Search dashboards by name
Click it and begin typing any part of the dashboard name (in this example, “Instances”)
Click one of the search results to go to that dashboard
To abandon the search, click the icon at the end of the search bar
To search within the current folder, click the folder’s name.
Use the second row main menu. (See Second row menu bar.)
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.
At the top of each panel and to the right of the panel name is the panel menu.
The presence of the menu is hidden until you mouse over it. Look for the symbol in the title bar of a panel.
|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|
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.
PMM Server can’t currently directly render dashboard images exported by Grafana without these additional set-up steps.
Part 1: Install dependencies
Connect to your PMM Server Docker container.
docker exec -it pmm-server bash
Install Grafana plugins.
grafana-cli plugins install grafana-image-renderer
supervisorctl restart grafana
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
Navigate to the dashboard you want to share.
Open the panel menu.
Select Share to reveal the Share Panel.
Click Direct link rendered image.
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.
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.
You turn annotations on or off with the PMM Annotations switch in the second row menu bar.
- Page updated 2021-01-13