From 819fccce47b0f11a1bfa104efa28cd6345fdbc80 Mon Sep 17 00:00:00 2001 From: Kim <56411016+kimsauce@users.noreply.github.com> Date: Tue, 20 Sep 2022 01:15:08 -0700 Subject: [PATCH] dashboards (new) metadata (#305) * AWS Cost explorer * Word list, glossary, URL fixes, missing descriptions * dashboards metadata --- docs/dashboards-new/create-a-dashboard-new.md | 1 + .../drill-down-to-discover-root-causes.md | 1 + docs/dashboards-new/explore-view.md | 1 + docs/dashboards-new/export-dashboard-new.md | 1 + docs/dashboards-new/faq.md | 1 + .../filter-with-template-variables.md | 1 + docs/dashboards-new/link-dashboards.md | 1 + docs/dashboards-new/locate-deviations.md | 1 + docs/dashboards-new/panels.md | 1 + docs/dashboards-new/panels/area-charts.md | 9 +++++---- docs/dashboards-new/panels/bar-charts.md | 4 ++-- docs/dashboards-new/panels/box-plot-charts.md | 3 +-- docs/dashboards-new/panels/bubble-charts.md | 11 ++++++----- docs/dashboards-new/panels/column-charts.md | 4 +++- docs/dashboards-new/panels/combo-charts.md | 12 +++++++----- docs/dashboards-new/panels/line-charts.md | 4 +++- docs/dashboards-new/panels/map-charts.md | 17 +++++++++-------- docs/dashboards-new/panels/markdown-syntax.md | 4 +++- docs/dashboards-new/panels/modify-chart.md | 4 +++- docs/dashboards-new/panels/pie-charts.md | 4 +++- docs/dashboards-new/panels/scatter-charts.md | 7 ++++--- .../panels/single-value-charts.md | 8 ++++---- docs/dashboards-new/panels/table-charts.md | 9 +++++---- docs/dashboards-new/set-custom-time-ranges.md | 1 + docs/dashboards-new/share-dashboard-new.md | 1 + 25 files changed, 69 insertions(+), 42 deletions(-) diff --git a/docs/dashboards-new/create-a-dashboard-new.md b/docs/dashboards-new/create-a-dashboard-new.md index 5c186890db..0f28ad4e6f 100644 --- a/docs/dashboards-new/create-a-dashboard-new.md +++ b/docs/dashboards-new/create-a-dashboard-new.md @@ -1,6 +1,7 @@ --- id: create-a-dashboard-new title: Create a Dashboard (New) +description: Learn how to create your own custom Dashboard (New) with a panel and query, then customize a chart and add the chart to the dashboard. --- This page demonstrates how to create a Dashboard (New), add a query, and then add the chart to the dashboard. You create your Dashboard (New) by selecting template options from menus and drop-downs. diff --git a/docs/dashboards-new/drill-down-to-discover-root-causes.md b/docs/dashboards-new/drill-down-to-discover-root-causes.md index 8732dd73c6..e95090546a 100644 --- a/docs/dashboards-new/drill-down-to-discover-root-causes.md +++ b/docs/dashboards-new/drill-down-to-discover-root-causes.md @@ -1,6 +1,7 @@ --- id: drill-down-to-discover-root-causes title: Drill Down to Discover Root Causes +description: Learn how to drill into related content to discover the root cause of a spike of interest on a dashboard. --- When you see a spike of interest on a dashboard that requires further investigation, you can easily drill into the related content to discover the root cause. This page shows you how you can easily discover related dashboards and corresponding logs searches that pertain to an issue in your environment. diff --git a/docs/dashboards-new/explore-view.md b/docs/dashboards-new/explore-view.md index 757487a23d..b85174e9bf 100644 --- a/docs/dashboards-new/explore-view.md +++ b/docs/dashboards-new/explore-view.md @@ -2,6 +2,7 @@ id: explore-view title: Navigating Sumo Logic Dashboards with Explore sidebar_label: Explore View +description: Explore gives you an easy way to view and navigate the hierarchy of your environment. --- import Iframe from 'react-iframe'; diff --git a/docs/dashboards-new/export-dashboard-new.md b/docs/dashboards-new/export-dashboard-new.md index 4f5c20bef7..ff013c914d 100644 --- a/docs/dashboards-new/export-dashboard-new.md +++ b/docs/dashboards-new/export-dashboard-new.md @@ -2,6 +2,7 @@ id: export-dashboard-new title: Exporting Sumo Logic Dashboards (New) sidebar_label: Export Dashboard (New) +description: Learn how to export your Dashboard (New) as a PDF or PNG file. --- Dashboards provide insights for monitoring key performance indicators (KPIs) across your organization. There may be times when key stakeholders require access to a static snapshot of dashboard KPIs without having to log in to Sumo Logic. In these instances, you can export a snapshot of a dashboard to share. This capability allows you to extend monitoring analytics to a broader base both within and outside your organization. diff --git a/docs/dashboards-new/faq.md b/docs/dashboards-new/faq.md index 6b595f08e9..61ed200f5a 100644 --- a/docs/dashboards-new/faq.md +++ b/docs/dashboards-new/faq.md @@ -2,6 +2,7 @@ id: faq title: Dashboard (New) FAQ sidebar_label: FAQ +description: Find answers to frequently asked questions about our new Dashboards. --- ## How do I convert a Classic Dashboard to the new dashboard framework? diff --git a/docs/dashboards-new/filter-with-template-variables.md b/docs/dashboards-new/filter-with-template-variables.md index 0cd2745ae7..e1f2e58fab 100644 --- a/docs/dashboards-new/filter-with-template-variables.md +++ b/docs/dashboards-new/filter-with-template-variables.md @@ -2,6 +2,7 @@ id: filter-template-variables title: Filtering Dashboards (New) with Template Variables sidebar_label: Filtering with Template Variables +description: Learn how to use template variables to dynamically filter dashboard data. --- Template variables are a feature of Dashboard (New) that allow you to analyze specific data on demand. They give you the ability to filter the data displayed on your dashboard so you can quickly troubleshoot a problem. Queries can be changed on the fly by choosing values for variables from drop-down lists without having to manually edit queries. diff --git a/docs/dashboards-new/link-dashboards.md b/docs/dashboards-new/link-dashboards.md index 01f82567a6..eefab065be 100644 --- a/docs/dashboards-new/link-dashboards.md +++ b/docs/dashboards-new/link-dashboards.md @@ -1,6 +1,7 @@ --- id: link-dashboards title: Linking Dashboards (New) +description: Easily link dashboards together to quickly view related data. --- ## Link Multiple Dashboards Together diff --git a/docs/dashboards-new/locate-deviations.md b/docs/dashboards-new/locate-deviations.md index c5e85eba8b..83b7159a99 100644 --- a/docs/dashboards-new/locate-deviations.md +++ b/docs/dashboards-new/locate-deviations.md @@ -1,6 +1,7 @@ --- id: locate-deviations-time-series title: Locate Deviations in a Time Series +description: Learn how to create charts that locate deviations in a time series and the graph outliers. --- An **outlier** is a data point that is outside the range of expected values. This page shows you how to locate deviations beyond thresholds in a time series.  diff --git a/docs/dashboards-new/panels.md b/docs/dashboards-new/panels.md index 0cd1a1e1c0..18e0e5007d 100644 --- a/docs/dashboards-new/panels.md +++ b/docs/dashboards-new/panels.md @@ -2,6 +2,7 @@ id: panels title: Dashboard (New) Panels sidebar_label: Panels +description: Learn about the different panel types available in Dashboard (New) and the types of data best suited for each. --- import Tabs from '@theme/Tabs'; diff --git a/docs/dashboards-new/panels/area-charts.md b/docs/dashboards-new/panels/area-charts.md index bdba42abff..69f90df8c7 100644 --- a/docs/dashboards-new/panels/area-charts.md +++ b/docs/dashboards-new/panels/area-charts.md @@ -1,9 +1,10 @@ --- id: area-charts -description: An area chart is used to visually represent quantity over a period of time. +title: Area Charts +description: An area chart is used to visually represent quantity over a period of time. --- -# Area Charts + An area chart is used to visually represent quantity over a period of time. The quantity is laid out on the vertical axis, and the horizontal axis shows the time period being charted. What distinguishes an area chart from a line chart is the use of shaded regions below the line which better indicates the increase or decrease of volume. @@ -24,14 +25,14 @@ which would produce results such as: To add a panel with an area chart: 1. Create or open a Dashboard (New) and click on **Add Panel \> Time Series** or **Add Panel \> Categorical**. - + ![time series or categorical.png](/img/dashboards-new/panels/area-charts/time-series-or-categorical.png) 1. Provide a Metric or Log query and press **Enter** for it to run. 1. Once the query runs you will need to flip the chart type to **Area**. ![Dashboard New Area Chart.png](/img/dashboards-new/panels/area-charts/Dashboard-New-Area-Chart.png) - + 1. [Modify the chart](./modify-chart.md) as desired. 1. Click the **Add to Dashboard** button on the top right of the window to add the panel to your dashboard. diff --git a/docs/dashboards-new/panels/bar-charts.md b/docs/dashboards-new/panels/bar-charts.md index 5ad4403665..93e2805196 100644 --- a/docs/dashboards-new/panels/bar-charts.md +++ b/docs/dashboards-new/panels/bar-charts.md @@ -1,9 +1,9 @@ --- id: bar-charts +title: Bar Charts description: Bar charts are useful for visually comparing the number of events that have occurred. --- -# Bar Charts Bar charts are useful for visually comparing the number of events that have occurred, such as the type of error that occurs the most in your system. To create a Bar chart, use a search query that provides at least a few data points in the **Aggregates** tab. @@ -33,5 +33,5 @@ To add a panel with a bar chart: 1. [Modify the chart](./modify-chart.md) as desired. 1. Click the **Add to Dashboard** button on the top right of the window to add the panel to your dashboard. - + ![Add to Dashboard button.png](/img/dashboards-new/create-dashboard-new/Add-to-Dashboard-button.png) diff --git a/docs/dashboards-new/panels/box-plot-charts.md b/docs/dashboards-new/panels/box-plot-charts.md index 2e38116504..68bec217e1 100644 --- a/docs/dashboards-new/panels/box-plot-charts.md +++ b/docs/dashboards-new/panels/box-plot-charts.md @@ -1,10 +1,9 @@ --- id: box-plot-charts +title: Box Plot Charts description: Box Plot Chart graphically depicts groups of data using quartiles, which are the values that divide a list of numbers into quarters. --- -# Box Plot Charts - A Box Plot Chart graphically depicts groups of data using quartiles, which are the values that divide a list of numbers into quarters. In Box Plot charts, the bottom and top of the box represent the first and third quartiles; the band inside the box represents the median. ![Box plot](/img/dashboards-new/panels/box-plot-charts/Box-plot.png) diff --git a/docs/dashboards-new/panels/bubble-charts.md b/docs/dashboards-new/panels/bubble-charts.md index f5bdbf4921..aa0d28192f 100644 --- a/docs/dashboards-new/panels/bubble-charts.md +++ b/docs/dashboards-new/panels/bubble-charts.md @@ -1,8 +1,9 @@ --- id: bubble-charts +title: Bubble Charts +description: Bubble charts show you the size of data points in relation to two other dimensions. --- -# Bubble Charts Bubble charts are available in the [Dashboard (New)](../about.md) platform. @@ -17,9 +18,9 @@ You can modify the fields used for each axis as needed. For example, in the following query `logins` is the Z dimension and will be displayed as the value of each bubble. The fields `latitude` and `longitude` can be used as dimensions. ```sql -_sourceCategory=service "message=User logged in" remote_ip -| parse "[remote_ip=*]" as remote_ip -| lookup latitude, longitude, city, state from geo://location on ip = remote_ip +_sourceCategory=service "message=User logged in" remote_ip +| parse "[remote_ip=*]" as remote_ip +| lookup latitude, longitude, city, state from geo://location on ip = remote_ip | count as logins by city, latitude, longitude ``` @@ -47,5 +48,5 @@ To add a panel with a bubble chart: ![Add to Dashboard button.png](/img/dashboards-new/create-dashboard-new/Add-to-Dashboard-button.png) - +   diff --git a/docs/dashboards-new/panels/column-charts.md b/docs/dashboards-new/panels/column-charts.md index 19446dc975..aee2864c6a 100644 --- a/docs/dashboards-new/panels/column-charts.md +++ b/docs/dashboards-new/panels/column-charts.md @@ -1,8 +1,10 @@ --- id: column-charts +title: Column Charts +description: Column charts are useful for visually comparing the number of events that have occurred. --- -# Column Charts + Column charts are useful for visually comparing the number of events that have occurred, such as the type of error that occurs the most in your system. To create a Column chart, use a search query that provides at least a few data points in the **Aggregates** tab. diff --git a/docs/dashboards-new/panels/combo-charts.md b/docs/dashboards-new/panels/combo-charts.md index b6f5d8bc93..0b2f0b6969 100644 --- a/docs/dashboards-new/panels/combo-charts.md +++ b/docs/dashboards-new/panels/combo-charts.md @@ -1,17 +1,19 @@ --- id: combo-charts +title: Combo Charts +description: Column charts are useful for visually comparing the number of events that have occurred. --- -# Combo Charts + Combo charts have a secondary vertical axis allowing you to view two aggregates on the same chart. A common combo chart is a bar or column chart with a secondary vertical axis as a separate line as a comparison. For example, say we're running a query like: -```sql -_sourceCategory=*apache* -| parse "HTTP/1.1\" * * * " as status_code, size, referrer -| timeslice 5m +``` +_sourceCategory=*apache* +| parse "HTTP/1.1\" * * * " as status_code, size, referrer +| timeslice 5m | avg(size), count by _timeslice ``` diff --git a/docs/dashboards-new/panels/line-charts.md b/docs/dashboards-new/panels/line-charts.md index 048d60a454..3b465b0876 100644 --- a/docs/dashboards-new/panels/line-charts.md +++ b/docs/dashboards-new/panels/line-charts.md @@ -1,8 +1,10 @@ --- id: line-charts +title: Line Charts +description: Line charts are useful for displaying how data changes over time. --- -# Line Charts + Line charts are useful for displaying how data changes over time, where the Y axis of a line chart displays the count of an item, and the X axis is a timeline. diff --git a/docs/dashboards-new/panels/map-charts.md b/docs/dashboards-new/panels/map-charts.md index d006ba0c36..15a2e363ac 100644 --- a/docs/dashboards-new/panels/map-charts.md +++ b/docs/dashboards-new/panels/map-charts.md @@ -1,8 +1,9 @@ --- id: map-charts +title: Map Charts +description: Map charts are useful for showing IP addresses from log messages on a map. --- -# Map Charts Map charts show the location and number of hits from data on a map. @@ -14,19 +15,19 @@ To map your data you can:  For example, you'd use the geoip operator to create a map chart: ```sql -| parse "remote_ip=*]" as client_ip -| geoip client_ip -| count by latitude, longitude +| parse "remote_ip=*]" as client_ip +| geoip client_ip +| count by latitude, longitude | sort _count ``` Or, you'd use the geo lookup operator to create a map chart: ```sql -_sourceCategory=Error -| parse regex "(\\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})" -| lookup latitude, longitude, country_code, country_name, region, city, postal_code from geo://location on ip = client_ip -| count by latitude, longitude, country_code, country_name, region, city, postal_code +_sourceCategory=Error +| parse regex "(\\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})" +| lookup latitude, longitude, country_code, country_name, region, city, postal_code from geo://location on ip = client_ip +| count by latitude, longitude, country_code, country_name, region, city, postal_code | sort _count ``` diff --git a/docs/dashboards-new/panels/markdown-syntax.md b/docs/dashboards-new/panels/markdown-syntax.md index a57ece27d6..5ea1f68569 100644 --- a/docs/dashboards-new/panels/markdown-syntax.md +++ b/docs/dashboards-new/panels/markdown-syntax.md @@ -1,8 +1,10 @@ --- id: markdown-syntax +title: Markdown Syntax +description: Markdown Syntax options are supported in Dashboards. --- -# Markdown Syntax + The following Markdown Syntax options are supported in Dashboards. When your syntax is supported, you will see "Markdown Supported" near the bottom left corner of the text box. Unsupported syntax prevents you from clicking the **Submit** button. diff --git a/docs/dashboards-new/panels/modify-chart.md b/docs/dashboards-new/panels/modify-chart.md index 940966d982..2c0d2a30c7 100644 --- a/docs/dashboards-new/panels/modify-chart.md +++ b/docs/dashboards-new/panels/modify-chart.md @@ -1,8 +1,10 @@ --- id: modify-chart +title: Modify a Chart +description: Learn how to customize a chart's type and visual display characteristics. --- -# Modify a Chart + You can customize a chart on a dashboard panel in a variety of ways. You can even change the chart type to analyze the data in another format. This section shows you how to customize a chart or change the chart type entirely.  diff --git a/docs/dashboards-new/panels/pie-charts.md b/docs/dashboards-new/panels/pie-charts.md index 42e1ccdea0..5a606f0628 100644 --- a/docs/dashboards-new/panels/pie-charts.md +++ b/docs/dashboards-new/panels/pie-charts.md @@ -1,8 +1,10 @@ --- id: pie-charts +title: Pie Charts +description: Donut or Pie charts are useful for visually comparing the percentage of events that have occurred for a particular field. --- -# Pie Charts + Pie charts are useful for visually comparing the percentage of events that have occurred, such as the type of error that occurs the most in your system. A pie chart will compare different values for the same field. If you want to compare values for different fields consider using a histogram. diff --git a/docs/dashboards-new/panels/scatter-charts.md b/docs/dashboards-new/panels/scatter-charts.md index dc984b1979..dc5c093463 100644 --- a/docs/dashboards-new/panels/scatter-charts.md +++ b/docs/dashboards-new/panels/scatter-charts.md @@ -1,8 +1,9 @@ --- id: scatter-charts +title: Scatter Charts +description: Scatter charts show correlations between two fields against specific data. --- -# Scatter Charts Scatter charts are available in the [Dashboard (New)](../about.md) platform. @@ -19,8 +20,8 @@ For example, in the following query `logins` is the aggregate field and will b ```sql _sourceCategory=service "message=User logged in" remote_ip -| parse "[remote_ip=*]" as remote_ip -| lookup latitude, longitude from geo://location on ip = remote_ip +| parse "[remote_ip=*]" as remote_ip +| lookup latitude, longitude from geo://location on ip = remote_ip | count as logins by latitude, longitude ``` diff --git a/docs/dashboards-new/panels/single-value-charts.md b/docs/dashboards-new/panels/single-value-charts.md index ee9823f3b9..5d554b449f 100644 --- a/docs/dashboards-new/panels/single-value-charts.md +++ b/docs/dashboards-new/panels/single-value-charts.md @@ -1,9 +1,9 @@ --- id: single-value-charts +title: Single Value Charts +description: Displays the first record of your search results. --- -# Single Value Charts - You can use single value charts to display results for a search or metric query as a single value, for at-a-glance analysis. This page shows you how to create and tailor single value charts for searches. For information on single value charts for metrics, see [Create and Tailor Single Value Metrics Charts](/docs/metrics/metric-charts). A single value chart displays a single record from a search, in order to make that value stand out at a glance. If the query returns more than one value in the **Aggregates** tab, only the first value is displayed in the single value chart. @@ -34,12 +34,12 @@ To add a panel with a single value chart: ![Metrics selection for query builder.png](/img/dashboards-new/create-dashboard-new/Add-log-query.png) To create a metrics query utilize the [Metrics Query Builder](../../metrics/metric-queries-alerts/metrics-explorer.md).  - + ![new single value chart metrics.png](/img/dashboards-new/panels/single-value-charts/new-single-value-chart-metrics.png) 1. [Modify the chart](./modify-chart.md) as desired. -1. Click the **Add to Dashboard** button on the top right of the window to add the panel to your dashboard. +1. Click the **Add to Dashboard** button on the top right of the window to add the panel to your dashboard. ![Add to Dashboard button.png](/img/dashboards-new/create-dashboard-new/Add-to-Dashboard-button.png) diff --git a/docs/dashboards-new/panels/table-charts.md b/docs/dashboards-new/panels/table-charts.md index 43e1c19e53..946abf7fd2 100644 --- a/docs/dashboards-new/panels/table-charts.md +++ b/docs/dashboards-new/panels/table-charts.md @@ -1,8 +1,9 @@ --- id: table-charts +title: Table Charts +description: Table charts are the default chart type in the Aggregates tab. --- -# Table Charts Table charts are the default chart type in the **Aggregates** tab. They are useful for listing the type and number of events that have occurred, such as the type of error that occurs the most in your system. To create a table chart, use a search query that provides at least a few data points in the **Aggregates** tab. @@ -58,9 +59,9 @@ If your query looks for URLs, when you create a table chart panel, the URLs disp For example, if you used this query to search for hits to the Sumo Logic Help system: ```sql -_sourceCategory=aws/cloudtrail  -| keyvalue "LoginTo"  -| count loginto +_sourceCategory=aws/cloudtrail  +| keyvalue "LoginTo"  +| count loginto | sort - _count ``` diff --git a/docs/dashboards-new/set-custom-time-ranges.md b/docs/dashboards-new/set-custom-time-ranges.md index 3146ff2a69..4042b648f3 100644 --- a/docs/dashboards-new/set-custom-time-ranges.md +++ b/docs/dashboards-new/set-custom-time-ranges.md @@ -1,6 +1,7 @@ --- id: set-custom-time-ranges title: Set Customized Time Ranges +description: Learn how to set custom time ranges for individual panels and the dashboard as a whole. --- A new dashboard has a preset default time range for its panels and the dashboard as a whole. You can choose to customize the time range for individual panels, as well as setting a new time range for the dashboard. It's important that you review the time range override guidelines to ensure you achieve your expected results. diff --git a/docs/dashboards-new/share-dashboard-new.md b/docs/dashboards-new/share-dashboard-new.md index d3eb4c348c..dd71afdbfa 100644 --- a/docs/dashboards-new/share-dashboard-new.md +++ b/docs/dashboards-new/share-dashboard-new.md @@ -1,6 +1,7 @@ --- id: share-a-dashboard-new title: Share a Dashboard (New) +description: Learn how to save a custom dashboard and then share it with others. --- After you have created a custom Dashboard (New) you may also want to share it with coworkers within your organization. This page walks you through these tasks.