- Metric Sources
- Using Instrumental
- Where to Start
Data is visualized in Instrumental on graphs. Each graph can have one or more query language expressions. These expressions select (and even transform) metric data. Here's a brief video on creating graphs and working with expressions:
Table of Contents
- Adding Graphs
- Sharing, Exporting & Embedding Graphs
- Managing Graphs
Add a graph by clicking the icon in the sidebar or New Graph on a dashboard. This will take you to a new, unsaved graph ready for expressions.
After creating a graph, you should set a descriptive title for the graph. Also consider writing a short description, to help teammates (and future you) understand the purpose of the graph. Edit the title and description by clicking the gear icon ( ) on the graph and then Edit Title & Description.
Query language expressions are added to graphs through the text box at the top left. An expression can be as simple as a single metric name, or more powerful with wildcards, functions, and time shifting.
InstrumentalD's suggested graphs will already have one or more expressions, but you can easily customize these graphs by editing and adding expressions.
As you type, matching metrics and query language functions are displayed:
- Metric results are presented one metric name part at a time (metric names use dots as part separators).
- Blue badges indicate the total number of metrics beginning with this namespace. Select these results to drill down further.
- Function results include the parameters and returned data for each function.
Edit expressions by clicking the expression. As you edit, you will see the same matching metrics and query language functions as when adding a new expression. Hit
ENTER to save your change,
ESC to cancel them.
Hide expressions by hovering over the expression, then click the eye icon. When an expression returns multiple metrics, hide individual expressions via the dropdown menu.
Delete expressions by clicking the trash can icon on a hidden expression. The expression must be hidden before it can be deleted.
Copying the URL for a graph page is the easiest way to share a graph. All graph options, including time, duration, and resolution, are defined in the URL for the page. Copied URLs are only accessible to other Instrumental users on your project. To share with non-Instrumental users, export the graph instead of sharing the URL.
To export a graph, use the export buttons from the graph menu. Exported graphs do not update dynamically, they reflect the state of the graph at the time the export was made. You can also export graphs programmatically.
Dashboards are collections of graphs. We recommend creating dashboards as needed for each use case (post-deploy vs database metrics) or for each team (devops vs development vs product management). There are no limits to the number of dashboards you can create.
Graphs can be moved between dashboards via the dropdown in the top right of the graph.
- Changes the graph to a cumulative, stacked graph. Particularly useful for visualizing the total value of multiple expressions.
- When enabled, data points with a value of zero will be removed. In most cases, the series_continuous() query language function should be used instead.
- Toggles the visibility of notices.
Graphs can be easily removed through the graph settings menu. It also possible to create and share graphs that are never saved. Just share the URL of any graph page. These intentionally temporary graphs are great for exploration without cluttering your graph groups.