Build dashboards and charts with sample data, create an alert, and get pointers to more info.

This tutorial uses Wavefront sample data to get you started.

To complete these tasks you need:

  • Access to a Wavefront instance. If your company doesn’t have one, sign up for a free trial!
  • Dashboard permission and Alert permission. Trial users have these permissions. If you’re not in a trial, your Wavefront administrator can grant the permissions if you don’t have them.

Review Sample Dashboards and Metrics

Your Wavefront instance includes tutorial and tour dashboards that we built using the sample metrics. Let’s get started by reviewing some of these dashboards and metrics.

  1. Log in to Wavefront.
  2. Select Dashboards > All Dashboards.
  3. In the Tags section of the filter bar on the left, click the welcome.tutorial tag.
  4. Click each dashboard and review:
    • Tutorial: Intro - gives an overview of the Getting Started dashboards and documentation.
    • Tutorial: Getting Started with Wavefront Query Language - gives an overview of how to construct metrics queries.
    • Tutorial: Dashboard Basics: Chart Types - describes the different ways of displaying metrics.
  5. The Getting Started Dashboards all use sample metrics. You can explore any metrics in Wavefront, including the ~sample. metrics, using the Metrics browser:
    1. Select Browse > Metrics.
    2. In the Metrics field, type ~sample. (include the period). The sample metrics categories display:

      sample_metrics

    3. Optionally, explore folders until you see a chart icon representing a metric. In the next section you learn how to create your own charts for metrics.
    4. Click the icon to display a chart of the metric.

Create Dashboards and Charts

To get you started quickly, Wavefront includes not only a tutorial, but also a set of sample dashboards, tagged as welcome.tour. One of the tour dashboards, Tour: Sample Cluster Metrics, illustrates a range of metrics that span an entire cluster. You can create a dashboard starting with one of the charts in this tour dashboard and add a new chart to your dashboard.

  1. Open the Tour: Sample Cluster Metrics dashboard:
    1. Select Dashboards > All Dashboards.
    2. In the Search field at the top, type Sample Cluster and press Enter.
    3. Click the Tour: Sample Cluster Metrics dashboard link.

      sample_cluster

      The dashboard defines two variables, dashboard—Availability Zone (az) and Environment (env)— which you can see at the top. Variables can be used in queries to filter metrics for classes of sources. The us-west-2 availability zone and dev environment variable are selected by default.

  2. Open a chart in the Tour: Sample Cluster Metrics dashboard.
    1. The Tour: Sample Cluster Metrics dashboard is organized into sections. Click App Servers at the top to jump to the App Servers section:

      app_servers

    2. In the App Servers section, click the Requests chart title: requests

      The stacked area chart opens in the chart editor. This chart displays the query last(ts(“~sample.requests.total.num”, az=${az}, env=${env})), which returns the ~sample.requests.total.num (total number of requests) metric filtered by availability zone and environment. The last() function fills in any gaps in data with the last known value of the metric.

  3. Add the chart to a new dashboard:
    1. Scroll to the bottom of the chart page.
    2. Click Save to New Dashboard.
    3. In the URL field, type app-server-dashboard.
    4. In the Name field, type App Server Dashboard.
    5. Click Create. You have now created your first dashboard and are placed in edit mode. The variables have also been included in your new dashboard because they are used in the chart.
  4. Edit the App Server Dashboard:
    1. Click the icon at the top right to close the dashboard variables editor.
    2. Click Incoming Chart at the top left and type Request Metrics.
  5. Edit the Requests chart to limit the number of sources being displayed:
    1. Click the Requests title at the top right of the chart.
    2. In the Requests query field delete az=${az}, env=${env} and type env.
    3. Select env= and then production from the autocomplete dropdown.
    4. Press Enter. The chart now displays only production application servers in all availability zones.
    5. Click Accept.
  6. Now let’s create a chart from scratch:
    1. Click Add New Chart. A new line plot chart is created.
    2. In the New Query field, type ts. The system adds parentheses.
    3. Type ~sample.requests.
    4. Choose latency from the autocomplete dropdown and press Enter. The chart displays the query ts(~sample.requests.latency) which returns the ~sample.requests.latency (request latency) metric. The chart contains many lines that can make it hard to see trends. To reduce the number of lines you can filter the points by sources.
    5. Type ”, env=production” (without the quotes) after latency. This filter selects sources in the production environment.
    6. Type “mmax(10m, “ (without the quotes) before ts and type a closing parenthesis ) at the end. This function sets the value to the maximum of the metric over a 10 minute window, reducing noise and focusing attention on the more interesting metric maximum latency. This is an example of the one of the many functions available in Wavefront to analyze your metrics.
    7. In the Name field, replace New Chart with Request Latencies.
    8. Click Accept.
  7. Make sure that Edit JSON is still selected in the top right, hover over the chart, and press and hold the left mouse button. When the cursor changes to , drag the chart to the right of the Requests chart and release the mouse button. The two charts now share the same row.
  8. At the top right of the dashboard, click Save.

    request_metrics

Create an Alert

In this section you create an alert that fires when the request latency metric reaches a certain threshold. In Wavefront, one way to create an alert is directly from a chart.

  1. In App Server Dashboard, click the Request Latencies chart title to open the chart.
  2. Hover over the query builder toggle. The Create Alert link displays.

    create_alert

  3. Click the Create Alert link. The Create Alert page displays with the Condition field filled in with the request latencies query.
    1. In the Name field, replace New Alert with Latency Alert.
    2. At the end of the Condition field, type > 210. The alert threshold is deliberately set low so you can see the alert fire after a few minutes. In normal practice the threshold would be set to an anomalous value.
    3. In the Alert fires field, change the value to 2 and press Return or Enter. The alert fires whenever the moving maximum of the latency is greater than 210 for 2 minutes. You can see when alerts would have been generated in the Backtesting option of the Events Display chart.
    4. In the Targets field, type your email address.
    5. Click Save.
  4. Click Alerts in the task bar. The Alerts browser displays and Latency Alert displays the state CHECKING. When the alert fires, the state changes to FIRING:

    firing alert

    and you receive an email like the following:

    alert_email

    As alerts fire and resolve, events are created in Wavefront. You can add many other types of events to Wavefront. You can identify these events as icons that are added to the Request Latencies chart’s X-axis:

    event icons

Videos

Our doc set includes concept videos, how-to videos, and more!

Intro Videos

Our intro videos explain how to get data into Wavefront, how alerting works, and more!

getting data into wavefront

Alerts Videos

Our Alerts videos give important background and best practices info and a lot of practical advice on how to configure classic alerts and multi-threshold alerts.

threshold alerts

Wavefront and Data Videos

Thess videos explain important concepts such as interpolation and tagging, and explain how to use histograms.

time series and interpolation

Administration Videos

Administration videos help you understand how permissions and access control work in Wavefront, and show how to set up permissions and access control.

Wavefront access control

Docs

Use the search box in the top right – or look at some of the most popular docs in the set.

Getting Started Docs

Click a tile for doc about integrating with Wavefront, visualizing your data, refining what you see with queries, and alerting with Wavefront.

Integrate

Explore our integrations

Visualize

Get started with charts and dashboards

Query

Understand Wavefront Query Language

Alert

Get started with alerting

Release Notes

Release notes summarize the features added to each release and changes to existing features.

Query Language Docs

Wavefront Query Builder offers an easy select-and-refine interface that lets you fine tune what your charts display.

chart builder

Advanced users further refine charts and alerts with Wavefront Query Language. Click on the green bar in a tile for a query language page.

Reference

One line for each function + links.

Foundation

Explains concepts like discrete, continuous, and interpolation.

Tips & Tricks

Fine tune queries, perform aggregation, and more.

QL Recipes

Sample queries for common tasks.

Next Steps

Wavefront offers an onboarding (Getting Started) workflow, tutorial and tour dashboards, in-product help, videos, docs, and other resources.

The Getting Started onboarding flow gives a overview of the Wavefront architecture, and a preview of dashboards and alerts. All trial users go through this flow before they can continue using Wavefront. Getting Started flow
The in-product Tutorial dashboards get you started. You explore dashboards and charts that show sample metrics and make temporary modifications. More advanced users can explore the Tour Pro. Here, we're showing how to solve problems such as finding anomalous events. The tour uses sample data but is based on actual customer problems. Sample Cluster
The in-product help on the right of each screen introduces what you're looking at (e.g. charts or alerts) and has links to more info. Sample Cluster
This doc set (docs.wavefront.com) has in-depth information about many different aspects of the product. Use the TOC on the left, the Search bar in the top right or the tiles to find what you're looking for. screenshot of top left corner of doc set.
Developers like the Interactive Query Language Exporer dashboard to learn about all functions by looking at an example. query language explorer

Once you’re familiar with the basics, you can send your own data to Wavefront and start your journey!