Help Docs ~ Scout Server Monitoring

Dashboards

Dashboards are your main entry point into all the data Scout collects.

What can you do with dashboards?

  • quickly explore metrics across all your servers
  • create as many charts on a dashboard as needed
  • place multiple metrics on a single chart for easy comparison
  • share entire dashboards across email or chart
  • view any chart in realtime - see live streaming metrics from your servers

Adding different metrics to the same chart

To put more than one metric on a chart, just drag another metric from the sidebar ONTO an existing chart.

Removing metrics from a chart

To remove metrics from a chart, click on the chart's gear icon (upper right), and delete metrics from the list there. Note that any chart-specific filters apply to all the metrics on the chart. If you need to apply different filters to different metrics, use separate charts on the dashboard instead of placing multiple metrics on a single chart.

Filtering metrics

Global Filters

The filters on top of the page (role, environment, and server name) affect all the charts on the dashboard ... unless you've set a more specific filter on the chart itself.

Chart-Specific Filters

To set a chart-specific filter, click on the gear icon in the chart's upper-right corner. This brings up the chart settings, which includes another set of filters (role, environment, and server name) applicable to the chart only.

You can place markers at a specific time on your charts. Typically, markers include a short description of what happened at that time - for example "deployed code to production." Markers are created through our API.

Chart types

There are three different chart types - range, breakout, and stacked. You can mix-and-match different chart types on a single dashboard.

Change the display by clicking on the settings icon for chart:

Range (default)

Range charts aggregate metrics from many servers into one line (showing the average value across all servers) and an area plot (showing the max and min across all servers). Use this type when you're displaying info from many servers, and are interested in the overall picture more than individual server's values.

Example: Are any of my hundreds of load-balanced app servers serving unusually low traffic?

If your chart displays more than 50 metrics, it can only be displayed in range format.

Breakout

Breakout charts show individual lines for each server on the chart. Use this chart when you want to see at a glance which server is doing what.

Example: are any of my database servers showing unusual disk write latency?

The breakout display is limited to 50 metrics.

Stacked

Stacked charts are just like line charts, but values are stacked on top of one another instead of overlapping. Use this when you're interested in the sum of many servers' metrics.

Example: what's the total traffic across all of my Apache web servers?

The stacked display is limited to 50 metrics.

Sharing dashboards

Click the share link for a unique, private link to the dashboard at it's current state.

The link is meant to used for quick collaboration across email or chat. Anyone with the link can view the dashboard, regardless of whether they are logged into Scout.

Logged-in Scout users can make adjustments to the dashboard, but for non-logged-in users, the dashboard is read only.

Viewing charts in realtime

Click the play icon on any chart to see the data streamed live, updating every second. You can enable realtime on multiple charts. Realtime sessions automatically expire after 30 minutes, but you can extend sessions if needed.

Sharing realtime charts

If you share dashboard with a realtime chart, the recipient will also see the realtime data, as long as they view it within the 30minutes+ realtime session.

If anyone opens a realtime share link after the realtime session is expired, they will see a normal dashboard (no live streaming data).

Realtime performance impact

Most Scout plugins are lightweight as they execute simple commands and won't have a noticeable performance impact on the monitored server. If a plugin runs long enough to slow down realtime reporting, it is excluded from subsequent runs in the current realtime session and a notice is shown in the chart UI. Other plugins will continue to report. This prevents resource-heavy plugins from having a large negative performance impact on the server being monitored.

Make a dashboard copy

You can create and save a copy of a dashboard by using the 'Share' link:

  1. Create a dashboard, or view the saved dashboard you want to copy.
  2. Click the Share link and copy the URL.
  3. Visit the share URL and click the 'Edit' button in the upper left. This will create an editable dashboard from the shared dashboard.
  4. Save the dashboard under a new name.

You can make multiple dashboard copies from the same shared dashboard by repeating steps 3 and 4.

Dashboards

Dashboards are your main entry point into all the data Scout collects.