From 667e8c9626551d32f98aeb713c6d698b56b12f61 Mon Sep 17 00:00:00 2001 From: trangl Date: Mon, 2 Dec 2024 19:05:29 +0100 Subject: [PATCH 01/13] Move contents from create simple chart and reformat with tables --- data-visualization/charts/create-charts.rst | 132 ++++++++++++++------ 1 file changed, 96 insertions(+), 36 deletions(-) diff --git a/data-visualization/charts/create-charts.rst b/data-visualization/charts/create-charts.rst index 605464b1d..ae1ac31c8 100644 --- a/data-visualization/charts/create-charts.rst +++ b/data-visualization/charts/create-charts.rst @@ -13,17 +13,6 @@ Before you create a chart, you need to have an idea of which metrics you want to Also consider customizing the defaults for your charts. You can filter metrics to limit the data to specific hosts, or specify a different time range for the chart. You can return to customize chart features at any time. -.. note:: - - Instead of displaying metrics on a chart, you can also: - - - Create a chart that contains a text note. See :ref:`text-note`. Use this feature to add documentation and guidance to a dashboard, because the text - chart appears as one of the charts in the dashboard. - - Create a chart that contains events (an event feed). See :ref:`dashboard-event-feed` - - Overlay events on a chart that already displays metrics. See :ref:`chart-events`. - - Link a detector to a chart and display its alert status on the chart. See :ref:`linking-detectors`. - - .. _ways-to-create-charts: Create a chart @@ -34,58 +23,131 @@ Once you have an initial plan for the metrics you want to display on your chart, .. note:: You can't add charts to a built-in dashboard. For more information, see :ref:`built-in-dashboards`. -- To create one or more simple charts on a new or existing dashboard, see :ref:`simple-charts-dashboards`. This technique is also a good choice if you want to see what metrics are available, because you can see them in the |ms|. +See the following table for different chart creation methods: -- To copy charts you see on a dashboard to a new or existing dashboard, see :ref:`copy-charts`. +.. list-table:: + :header-rows: 1 + :widths: 30 70 -- To copy charts you are viewing in the Chart Builder, use the :guilabel:`Save As` option (see :ref:`save-chart`), change the name as desired, and choose the dashboard where you want to place the copied chart. If you have edited the chart, those changes will be reflected in the copied chart. + * - :strong:`Method` + - :strong:`Description` + * - Create a chart using the metrics sidebar + - Use this method to create a simple chart or add a new chart to an existing dashboard. To learn more, see :ref:`create-chart-metric-sidebar`. + * - Copy a chart + - Use this method to add a clone or move a chart to another dashboard. To learn more, see :ref:`copy-charts`. + * - Create a chart using the Chart Builder + - Use this method to create a more complex chart with customizations during the creation process. To learn more, see :ref:`create-chart-with-chart-builder`. + * - Create a chart using the API + - Use this method to programmatically create a chart instead of creating one through the user interface. To learn more, see :ref:`create-chart-via-api`. - To create a chart based on a metric you have found in the Metadata Catalog, see :ref:`create-chart-from-catalog`. -- To build a chart from scratch, see :ref:`create-chart-with-chart-builder`. -- To programmatically create a chart instead of creating one through the user interface, see :ref:`create-chart-via-api`. +.. _create-chart-metric-sidebar: + +Create a chart using the metrics sidebar +------------------------------------------------ + +To start creating a simple chart, use the metrics sidebar to find and select the metrics and events you want to display in your chart: + +#. Open the metrics sidebar. + + * For an existing dashboard: Navigate to the existing dashboard and open it. Select the sidebar icon in the top right to open the metrics sidebar. + * For a new dashboard: From the :strong:`Create` menu in the top, select :strong:`Dashboard`. Select :strong:`Browse metrics sidebar` to open the metrics sidebar. + +#. On the :strong:`Metrics` tab, select :strong:`Find metrics` or :strong:`Find events`, depending what you want to plot in your chart. +#. Enter keywords into the search field. If a search keyword also matches metric metadata, such as a dimension name or property value, the metadata displays under the metric name. To add the metadata to your query as a filter, select the matching metadata or the :strong:`Filter` (+) icon. To exclude the metadata from your search results, select the :strong:`Exclude` (-) icon. + .. note:: Hover over a metric or event name to display information about it. + +Create one or multiple charts with metrics +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +* Create a chart with a single metric: + + #. Select the check box next to the metric name. + #. Select :strong:`Add chart`. + +* Create a chart containing one plot for each metric: + #. Select the check box next to each item you want to add. + #. Select :strong:`Add chart`. + +* Create multiple charts, one for each metric: + + #. Select the check box next to each item you want to add. + #. Select the :strong:`Separate charts` option. + #. Select :strong:`Add charts`. + +.. note:: Select :strong:`Add with filters` to add matching metadata from each metric result as filters to your chart. + +Create one or multiple charts with events +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +* Create a chart with a single event: + + #. Select the check box next to the event name. + #. Select :strong:`Add chart`. + +* Create a chart containing one plot for each event: + + #. Select the check box next to each item you want to add. + #. Select :strong:`Add single chart`. + +* Create multiple charts, one for each event: + + #. Select the check box next to each item you want to add. + #. Select :strong:`Multiple charts`. .. _copy-charts: -Copy charts ------------ +Copy a chart +--------------- -You can copy charts from one or multiple dashboards to a clipboard. This technique is useful if you are troubleshooting an issue and want to pull some existing charts together to view on a new dashboard (see :ref:`create-dashboard`), or if you want to copy charts from one dashboard to another. +You can copy charts from one or multiple dashboards to a clipboard. You might want to use this technique for the following use cases: -You can also use this method to "move" a chart from one dashboard to another; after copying a chart, delete the original chart. +* Pull some existing charts together in a new dashboard for troubleshooting. +* Copy charts from one dashboard to another. +* Move a chart from one dashboard to another; after copying a chart, delete the original chart. .. _copy-chart-to-clipboard: -Follow these steps to copy charts to a clipboard: +Follow these steps to copy a chart to a clipboard: -#. To start, open the dashboard containing the chart you want to copy. Staying in the dashboard view, select :guilabel:`Copy` from the :guilabel:`Chart actions` drop-down menu of the chart you want to copy. You have to be in dashboard view to see the Copy option. +#. Open the dashboard containing the chart you want to copy. +#. In the dashboard view, open the :guilabel:`Chart actions` menu of the chart you want to copy. +#. Select :guilabel:`Copy`. #. When you copy a chart, a counter on the :guilabel:`Create` icon on the navigation bar indicates how many charts you have copied to the clipboard. -#. To copy another chart to the clipboard, select :guilabel:`Chart actions > Add to Clipboard` from a different chart, or select the :guilabel:`Add to clipboard` icon on another chart while in the dashboard view. The counter increments as you add additional charts. +#. To copy another chart to the clipboard, select :guilabel:`Chart actions > Add to clipboard` from a different chart, or select the :guilabel:`Add to clipboard` icon on another chart while in the dashboard view. The counter increments as you add additional charts. -Different options on the Create menu let you paste the charts onto a dashboard. Pasting charts clears the clipboard. +Once you copy charts to the clipboard, several options from the :strong:`Create` menu let you paste the charts to another dashboard. Pasting charts clears the clipboard. -- To paste the charts into a dashboard you are viewing, select :guilabel:`Paste Charts` from the :guilabel:`Create` menu. You must have write permissions for the dashboard. See :ref:`about-permissions` for more detail. +.. list-table:: + :header-rows: 1 + :widths: 30 70 -- If you see :guilabel:`Dashboard with copied charts` on the Create menu, select that option to create a new, unsaved dashboard and paste the charts into it. - -- If you see :guilabel:`Dashboard (unsaved)` on the Create menu, you have already added charts to a new dashboard and haven't saved the dashboard yet. Select this option to open the unsaved dashboard, then select :guilabel:`Paste Charts`. - -To clear the clipboard contents without pasting the charts to a dashboard, select :guilabel:`Clear Clipboard` from the Create menu. + * - :strong:`Option` + - :strong:`Description` + * - Paste charts + - Select this option to paste the charts into a dashboard you are viewing. You must have write permissions for the dashboard. See :ref:`about-permissions` for more detail. + * - Dashboard with copied charts + - Select this option to create a new dashboard consisting of all the copied charts. + * - Dashboard (unsaved) + - If you see this option, you have already added charts to a new dashboard but haven't saved it. Select this option to open the unsaved dashboard. Select :strong:`Past charts` to add the copied charts to this dashboard. + * - Clear clipboard + - Select this option to clear the clipboard content without pasting charts to a dashboard. .. _create-chart-with-chart-builder: Create a new chart using the Chart Builder ------------------------------------------ -#. Select :guilabel:`Chart` from the :guilabel:`Create` menu. Alternatively, you can select :guilabel:`New Chart` on custom dashboards. +#. In the :strong:`Create` menu, select :strong:`Chart`. Alternatively, select :guilabel:`New chart` on custom dashboards. #. Search for metrics or events you want to plot on your chart. For more information, see :ref:`chart-builder`. .. note:: You can add functions to your chart with the :strong:`F(x)` column. See :ref:`plot-analytics` and :ref:`analytics-ref` for more details. + #. Customize your chart. See :ref:`chart-options-tab`. -See also :ref:`choose-chart-type`. .. _create-chart-from-finder: @@ -93,7 +155,6 @@ Create a chart from the Metric Finder ------------------------------------- Use the Metric Finder to find the metric you want to track. From the results page, select the metric name to open the Chart Builder, pre-populated with your metric. -See also :ref:`choose-chart-type`. .. _create-chart-from-catalog: @@ -102,19 +163,18 @@ Create a chart from the Metadata Catalog You can also create a chart from the Metadata Catalog. Select a metric from the list in the sidebar, then select :guilabel:`View in Chart` in the preview pane to open the Chart Builder, pre-populated with your metric. -See also :ref:`choose-chart-type`. .. _create-chart-via-api: Create a chart using Splunk Observability Cloud API --------------------------------------------------- -If you prefer to work programmatically, see :new-page:`Display Data Using Charts ` to create a chart with API. +If you prefer to work programmatically, see :new-page:`Display data using charts ` to create a chart with API. .. _choose-chart-type: Select a chart type -=================== +======================= Available chart types are shown as icons in the chart's title bar. You can also select a chart type in the Chart Options tab. Hover over an icon to see which chart type it represents, then select an icon to display the chart in that format. The selected chart type is highlighted and indicated by a small pointer. From 63fe821ff490dc1634c173aaa5588b9bb074badb Mon Sep 17 00:00:00 2001 From: trangl Date: Mon, 2 Dec 2024 19:39:28 +0100 Subject: [PATCH 02/13] Fix title capitalization --- data-visualization/charts/chart-options.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data-visualization/charts/chart-options.rst b/data-visualization/charts/chart-options.rst index 29eb484a3..4ceca672a 100644 --- a/data-visualization/charts/chart-options.rst +++ b/data-visualization/charts/chart-options.rst @@ -1,7 +1,7 @@ .. _chart-options-tab: ***************************************************************** -Chart Options in the Chart Builder +Chart options in the Chart Builder ***************************************************************** From f51cc478212fbdafd4e1562d0b2b5bc0b388696e Mon Sep 17 00:00:00 2001 From: trangl Date: Tue, 3 Dec 2024 10:40:59 +0100 Subject: [PATCH 03/13] Wording --- data-visualization/charts/create-charts.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/data-visualization/charts/create-charts.rst b/data-visualization/charts/create-charts.rst index ae1ac31c8..b1d096692 100644 --- a/data-visualization/charts/create-charts.rst +++ b/data-visualization/charts/create-charts.rst @@ -34,7 +34,7 @@ See the following table for different chart creation methods: * - Create a chart using the metrics sidebar - Use this method to create a simple chart or add a new chart to an existing dashboard. To learn more, see :ref:`create-chart-metric-sidebar`. * - Copy a chart - - Use this method to add a clone or move a chart to another dashboard. To learn more, see :ref:`copy-charts`. + - Use this method to add a copy or move a chart to another dashboard. To learn more, see :ref:`copy-charts`. * - Create a chart using the Chart Builder - Use this method to create a more complex chart with customizations during the creation process. To learn more, see :ref:`create-chart-with-chart-builder`. * - Create a chart using the API @@ -59,7 +59,7 @@ To start creating a simple chart, use the metrics sidebar to find and select the #. Enter keywords into the search field. If a search keyword also matches metric metadata, such as a dimension name or property value, the metadata displays under the metric name. To add the metadata to your query as a filter, select the matching metadata or the :strong:`Filter` (+) icon. To exclude the metadata from your search results, select the :strong:`Exclude` (-) icon. .. note:: Hover over a metric or event name to display information about it. -Create one or multiple charts with metrics +Create charts with metrics ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ * Create a chart with a single metric: @@ -75,12 +75,12 @@ Create one or multiple charts with metrics * Create multiple charts, one for each metric: #. Select the check box next to each item you want to add. - #. Select the :strong:`Separate charts` option. + #. Select :strong:`Separate charts`. #. Select :strong:`Add charts`. .. note:: Select :strong:`Add with filters` to add matching metadata from each metric result as filters to your chart. -Create one or multiple charts with events +Create charts with events ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ * Create a chart with a single event: From 2c76b3abe59319b16a8932a8383c660ee5f38f2e Mon Sep 17 00:00:00 2001 From: trangl Date: Tue, 3 Dec 2024 11:13:33 +0100 Subject: [PATCH 04/13] Remove simple chart topic --- data-visualization/charts/chart-builder.rst | 2 +- data-visualization/charts/charts.rst | 2 - data-visualization/charts/create-charts.rst | 22 +-- .../charts/simple-charts-dashboards.rst | 134 ------------------ .../dashboards/dashboard-create-customize.rst | 10 +- .../dashboards/dashboard-group.rst | 2 +- 6 files changed, 5 insertions(+), 167 deletions(-) delete mode 100644 data-visualization/charts/simple-charts-dashboards.rst diff --git a/data-visualization/charts/chart-builder.rst b/data-visualization/charts/chart-builder.rst index deb8bfc89..5585189da 100644 --- a/data-visualization/charts/chart-builder.rst +++ b/data-visualization/charts/chart-builder.rst @@ -9,7 +9,7 @@ Plot metrics and events using chart builder in Splunk Observability Cloud Charts are highly customizable. This topic describes how to use chart builder's tools and options to customize your charts to display signals (metrics and events) in an intuitive and compelling way. -.. note:: Use the chart builder only if you are already familiar with Splunk Observability Cloud charts and are ready to dive into its more advanced features. For a simpler approach to creating charts, see :ref:`simple-charts-dashboards`. +.. note:: Use the chart builder only if you are already familiar with Splunk Observability Cloud charts and are ready to dive into its more advanced features. For a simpler approach to creating charts, see :ref:`create-chart-metric-sidebar`. If you are editing an existing chart, you might want to start by configuring plot lines already on the chart (see :ref:`plot-options` and :ref:`plot-config-panel`). diff --git a/data-visualization/charts/charts.rst b/data-visualization/charts/charts.rst index 3ee5e55bf..be51f7aa3 100644 --- a/data-visualization/charts/charts.rst +++ b/data-visualization/charts/charts.rst @@ -11,7 +11,6 @@ Charts in Splunk Observability Cloud :hidden: Chart types - Create simple charts Create charts data-resolution-and-rollups Plot metrics and events using Chart Builder @@ -29,7 +28,6 @@ Charts can range from extremely simple (monitor a single metric for a single hos The following sections lead you through developing the expertise you need to build charts that meet your requirements, based on the metrics you want to monitor. - :ref:`chart-types` -- :ref:`Create simple charts ` - :ref:`create-charts` - :ref:`data-resolution-rollups-charts` - :ref:`Plot metrics and events using Chart Builder ` diff --git a/data-visualization/charts/create-charts.rst b/data-visualization/charts/create-charts.rst index b1d096692..43e618e7f 100644 --- a/data-visualization/charts/create-charts.rst +++ b/data-visualization/charts/create-charts.rst @@ -40,8 +40,6 @@ See the following table for different chart creation methods: * - Create a chart using the API - Use this method to programmatically create a chart instead of creating one through the user interface. To learn more, see :ref:`create-chart-via-api`. -- To create a chart based on a metric you have found in the Metadata Catalog, see :ref:`create-chart-from-catalog`. - .. _create-chart-metric-sidebar: @@ -141,29 +139,13 @@ Once you copy charts to the clipboard, several options from the :strong:`Create` Create a new chart using the Chart Builder ------------------------------------------ -#. In the :strong:`Create` menu, select :strong:`Chart`. Alternatively, select :guilabel:`New chart` on custom dashboards. +#. In the :strong:`Create` menu on the top navigation bar, select :strong:`Chart`. Alternatively, select :guilabel:`New chart` on custom dashboards. #. Search for metrics or events you want to plot on your chart. For more information, see :ref:`chart-builder`. .. note:: You can add functions to your chart with the :strong:`F(x)` column. See :ref:`plot-analytics` and :ref:`analytics-ref` for more details. #. Customize your chart. See :ref:`chart-options-tab`. - -.. _create-chart-from-finder: - -Create a chart from the Metric Finder -------------------------------------- -Use the Metric Finder to find the metric you want to track. From the results page, select the metric name to open the Chart Builder, pre-populated with your metric. - - -.. _create-chart-from-catalog: - -Create a chart from the Metadata Catalog ----------------------------------------- - -You can also create a chart from the Metadata Catalog. Select a metric from the list in the sidebar, then select :guilabel:`View in Chart` in the preview pane to open the Chart Builder, pre-populated with your metric. - - .. _create-chart-via-api: Create a chart using Splunk Observability Cloud API @@ -192,7 +174,7 @@ Edit a chart To edit a chart, open it from any dashboard or the Dashboard panel of a navigator. Editing a chart is essentially identical to building a chart. See :ref:`chart-builder`. -If you don't have write permissions for the dashboard containing the chart, or you are in a built-in dashboard, you have to use :guilabel:`Save as` to save the edited chart. +If you don't have write permissions for the dashboard containing the chart or if you are in a built-in dashboard, you have to use :guilabel:`Save as` to save the edited chart as a new chart. .. _save-chart: diff --git a/data-visualization/charts/simple-charts-dashboards.rst b/data-visualization/charts/simple-charts-dashboards.rst deleted file mode 100644 index a4bde9f10..000000000 --- a/data-visualization/charts/simple-charts-dashboards.rst +++ /dev/null @@ -1,134 +0,0 @@ -.. _simple-charts-dashboards: - -*********************************************************************** -Create simple charts using Splunk Observability Cloud -*********************************************************************** - -.. meta:: - :description: Splunk Observability Cloud makes it easy for you to quickly add simple charts to a new or existing dashboard. For example, you might want to put together a new draft dashboard with simple charts to share with others. If you're troubleshooting a problem, you can add charts for various metrics to a dashboard, share it with others, then close it without even saving it. - -This topic describes how to create simple charts to add to a new or existing dashboard. - -For example, you can create a new draft dashboard and add one or more simple charts to it. You can then :ref:`share the chart ` on the draft dashboard with others. If you want to continue using the charts on the draft dashboard, you can save the dashboard. Or, if you no longer need the charts, you can just clear the draft dashboard without saving. - -You can also add simple charts to existing dashboards that you have write permissions for. - -For information about developing more complex charts, see :ref:`create-charts`. - - -.. _finding-metrics-and-events: -.. _use-metrics-sidebar: - -Find metrics and events to add to a simple chart -============================================================================= - -To start creating a simple chart, use the Metrics Sidebar to find and select the metrics and events you want to display in your chart. - -- To add a new chart to an existing dashboard, open the dashboard. Click the sidebar icon in the top right to open the Metrics Sidebar, if it isn't already open. - -- To add a new chart to a new dashboard, open the navigation :strong:`Menu` and select :strong:`Dashboard`. Open the :strong:`Create` menu (+) in the top right and select :strong:`Dashboard`. Click :strong:`Browse Metrics Sidebar` in the new chart placeholder section to open the Metrics Sidebar. - -To search for a metric to display in a chart, select the :strong:`Find Metrics` option, enter one or more keywords in the search field, and click the search icon or press Enter. To search for an event to display in a chart, select the :strong:`Find Events` option instead. - -If a search keyword also matches metric metadata, such as a dimension name or property value, the metadata displays under the metric name. Click the matching metadata, or the :strong:`Filter` (+) icon, to add it to your search as a filter. To exclude the metadata from your search results, click the :strong:`Exclude` (-) icon. - -Hover over a metric or event name to display information about it. For example, when you hover over a metric name, you can see the metric name, its description, the time it was created, its type, and the number of time series that it reports (filtered by any filters that have been applied to your search query). - -For general guidance on how to browse and search for metrics, see :ref:`metric-finder`. - - -.. _creating-charts: - -Create a simple chart -============================================================================= - -After you've found one or more metrics or events that you want to add to your chart, you have the following options. - - -Add metrics to a simple chart -------------------------------------- - -On the :strong:`Metrics` tab in the Metrics Sidebar, select the :strong:`Find Metrics` option. - -- To add a chart for a single metric, click the metric name. - -- To add a single chart containing one plot for each metric: - - - Select the checkbox next to each item; you can also click :strong:`Select All`. - - Click :strong:`Add Chart`. - -- To add multiple charts to the dashboard, one for each metric: - - - Select the checkbox next to each item; you can also click :strong:`Select all`. - - Select the :strong:`Separate charts` option. - - Click :strong:`Add charts`. - -- To add active filters and matching metadata from each metric result to a chart as a filter: - - - Select the checkbox next to each item; you can also click :strong:`Select all`. - - Select the :strong:`Add with filters` option. - - Click :strong:`Add Chart`. - - -Add events to a simple chart -------------------------------------- - -On the :strong:`Metrics` tab in the Metrics Sidebar, select the :strong:`Find Events` option. - -- To add a chart for a single event, click the event name. - -- To add a single chart containing one plot for each event: - - - Select the checkbox next to each item; you can also click :strong:`Select All`. - - Click :strong:`Add Single Chart`. - -- To add multiple charts to the dashboard, one for each event: - - - Select the checkbox next to each item; you can also click :strong:`Select all`. - - Click :strong:`Multiple Charts`. - -.. note:: New charts are always added to the bottom of a dashboard. Depending on the number of charts on your dashboard, you might need to scroll to see a chart you've just added. Hover over the top edge of a chart in a dashboard to display a control that enables you to move the chart. You can also resize a chart by clicking and dragging the corners or the side and bottom edges. - - -.. _new-dashboard-next-steps: - -Save, share, or clear charts -============================================================================= - -After adding charts to a new dashboard, you have several options: - -- Share the charts. - - If other people are interested in seeing your charts, such as for troubleshooting an issue, you can share the charts, or the entire dashboard, without having to save the dashboard. - - To share a chart, open the :strong:`Chart actions` menu by clicking the |more| icon in the top right of a chart and select :strong:`Share`. - - For more details about sharing charts, see :ref:`sharing-a-chart`. - - To share the dashboard, open the :strong:`Dashboard actions` menu by clicking the |more| icon in the top right of the dashboard and select :strong:`Share`. - -- Save the dashboard. - - If you created a set of charts you want to refer to in the future, save the dashboard. - - To save the dashboard, open the :strong:`Dashboard actions` menu by clicking the |more| icon in the top right of the dashboard and select :strong:`Save As...`. Enter a dashboard name and the dashboard group you want to save the dashboard to. You can save the dashboard to an existing custom or user dashboard group, or you can create a new dashboard group. If you create a new dashboard group, the group is added as a Custom Dashboard group. For information about dashboard group types, see :ref:`dashboard-basics`. - -- Clear the charts. - - When you are done working with an unsaved dashboard and don't need the charts anymore, click :strong:`Clear` to remove all charts and return the dashboard to an empty state. - -- Exit the dashboard without saving it. - - If needed, you can navigate away from your charts and dashboard without saving them. The charts and dashboard are kept as an unsaved dashboard. - - To navigate back to your unsaved dashboard, access the Dashboards page, open the :strong:`Create` (+) menu, and click :strong:`Dashboard (unsaved)`. The unsaved dashboard is also accessible from your list of :strong:`Recent` dashboards at the top of the Dashboards page. - - -Next steps -============================================================================= - -- To find your metrics quickly and easily, consider using the full-featured :ref:`Metric Finder`. - -- To learn how to modify and configure charts, including applying additional analytics functions to make them more informative, see :ref:`chart-builder` and :ref:`gain-insights-through-chart-analytics`. - -- To learn how to create an event feed chart, see :ref:`dashboard-event-feed`. diff --git a/data-visualization/dashboards/dashboard-create-customize.rst b/data-visualization/dashboards/dashboard-create-customize.rst index 00ea44f45..7c73ec0a7 100644 --- a/data-visualization/dashboards/dashboard-create-customize.rst +++ b/data-visualization/dashboards/dashboard-create-customize.rst @@ -7,15 +7,7 @@ Create and customize dashboards .. meta:: :description: Visualize metrics and create customized filters and variables to explore data in real time with dashboards in Splunk Observability Cloud. -You can quickly visualize the metrics you monitor using Splunk Observability Cloud dashboards. This topic -explains how to create and customize these dashboards, as well as how to customize mirrored dashboards. - -Prerequisites -================== - -- If you are unfamiliar with dashboards or need a refresher, see :ref:`dashboard-basics`. - -- See :ref:`simple-charts-dashboards` for information about simple charts. +You can quickly visualize the metrics you monitor using Splunk Observability Cloud dashboards. This topic explains how to create and customize these dashboards, as well as how to customize mirrored dashboards. If you are unfamiliar with dashboards or need a refresher, see :ref:`dashboard-basics`. .. _create-dashboard: diff --git a/data-visualization/dashboards/dashboard-group.rst b/data-visualization/dashboards/dashboard-group.rst index eb055a6bc..a5ad6211e 100644 --- a/data-visualization/dashboards/dashboard-group.rst +++ b/data-visualization/dashboards/dashboard-group.rst @@ -23,7 +23,7 @@ To create a dashboard group from scratch, take the following steps: #. Set write permissions if needed, then click :guilabel:`Create`. To learn more, see :ref:`about-permissions`. #. After that, you land on a dashboard with the same name as the group. You can rename the dashboard from the dashboard's Actions menu (|more|), or begin adding charts to the group. -For more information on creating charts, see :ref:`simple-charts-dashboards` and :ref:`create-charts`. +For more information on creating charts, see :ref:`create-charts`. .. _protect-dashboard: From 67598007ace7b95865563c2367ec76754c0b9463 Mon Sep 17 00:00:00 2001 From: trangl Date: Tue, 3 Dec 2024 11:20:23 +0100 Subject: [PATCH 05/13] Rephrase and reformat notes --- data-visualization/charts/create-charts.rst | 24 +++++++++++---------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/data-visualization/charts/create-charts.rst b/data-visualization/charts/create-charts.rst index 43e618e7f..8b66ec3eb 100644 --- a/data-visualization/charts/create-charts.rst +++ b/data-visualization/charts/create-charts.rst @@ -169,24 +169,26 @@ To learn more about different chart types, see :ref:`chart-types`. The chart type you select is applied as a default to all the plots on the chart, but you can use different visualizations for individual plots. To learn more, see :ref:`plot-config-panel`. -Edit a chart -============ - -To edit a chart, open it from any dashboard or the Dashboard panel of a navigator. Editing a chart is essentially identical to building a chart. See :ref:`chart-builder`. - -If you don't have write permissions for the dashboard containing the chart or if you are in a built-in dashboard, you have to use :guilabel:`Save as` to save the edited chart as a new chart. - .. _save-chart: Save a chart ============ -When you finish creating or editing a chart, select :guilabel:`Save`, :guilabel:`Save as`, or :guilabel:`Save and close` from the :guilabel:`Chart actions` drop-down menu of the chart. The button text varies depending on how you created or opened the chart. If the button is not labeled with the option you want, you can select other options from the :guilabel:`Chart actions` menu. +When you finish creating or editing a chart, select :guilabel:`Save`, :guilabel:`Save as`, or :guilabel:`Save and close` from the :guilabel:`Chart actions` menu of the chart. The options vary depending on how you created or opened the chart. -If you don't have write permissions for the dashboard you are viewing, or you are in a built-in dashboard, you can't see an option to save the chart. Instead, you have to use :guilabel:`Save as` to save the chart. +If you don't have write permissions for the dashboard you are viewing or if you are in a built-in dashboard, you can't see an option to save the chart. Instead, you have to use :guilabel:`Save as` to save the chart to another dashboard. -If you don't want to save your changes, select :guilabel:`Close`. +To save your changes, select :guilabel:`Close`. .. note:: - If you select :guilabel:`Close`, you will not be prompted to save the chart, even if you have made some changes. Any unsaved changes will be lost. + Closing a chart doesn't prompt you to save changes. You must save your changes before closing, or unsaved changes will be lost. + +Edit a chart +============ + +To edit a chart, open it from any dashboard or the :strong:`Dashboard` panel of a navigator. + + .. note:: If you don't have write permissions for the dashboard containing the chart or if you are in a built-in dashboard, you have to use :guilabel:`Save as` to save the edited chart to another dashboard. + + From 7db142e696081e998065063ba98cf462e1c5dc56 Mon Sep 17 00:00:00 2001 From: trangl Date: Tue, 3 Dec 2024 11:28:02 +0100 Subject: [PATCH 06/13] Update broken labels --- conf.py | 2 +- data-visualization/charts/chart-builder.rst | 12 ++++++------ .../metrics-finder-metadata-catalog.rst | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/conf.py b/conf.py index 4515173de..689b75827 100644 --- a/conf.py +++ b/conf.py @@ -162,7 +162,7 @@ # An RST epilog to add variable names for feature text replacement, and non-breaking space. rst_epilog = """ -.. |ms| replace:: Metrics Sidebar +.. |ms| replace:: metrics sidebar .. |mtab| replace:: Muting Rules tab .. |sn| replace:: ServiceNow .. |sv| replace:: secondary visualization diff --git a/data-visualization/charts/chart-builder.rst b/data-visualization/charts/chart-builder.rst index 5585189da..b384c5da3 100644 --- a/data-visualization/charts/chart-builder.rst +++ b/data-visualization/charts/chart-builder.rst @@ -47,14 +47,14 @@ If your metrics follow the naming conventions for Graphite metrics, see :ref:`gr .. _find-metric: -Use the Metrics Sidebar to find a metric +Use the metrics sidebar to find a metric ------------------------------------------------------------------- -You can also choose the signal by using the Metrics Sidebar to search for metric and histogram metric names, instead of typing one in directly. Select :strong:`Browse` next to the :strong:`Signal` field to display the Metrics Sidebar. +You can also select the signal by using the metrics sidebar to search for metric and histogram metric names, instead of typing one in directly. Select :strong:`Browse` next to the :strong:`Signal` field to display the metrics sidebar. -In the Metrics Sidebar, select the :strong:`Find Metrics` option to search for metrics and histogram metrics. Using the Metrics Sidebar is the same as described in :ref:`use-metrics-sidebar`, except that each selected metric is added as a plot in the chart, instead of as one or more new charts. +In the metrics sidebar, select :strong:`Find metrics` to search for metrics and histogram metrics. Using the metrics sidebar is the same as described in :ref:`create-chart-metric-sidebar`, except that each selected metric is added as a plot in the chart, instead of as one or more new charts. -For information about how to use the :strong:`Find Events` option, see :ref:`chart-events-as-occur`. +For information about how to use the :strong:`Find events` option, see :ref:`chart-events-as-occur`. .. _expression: @@ -234,9 +234,9 @@ For background information on events, see :ref:`events-intro`. Display events as they occur ------------------------------------------------------------------- -The process for adding an event triggered by a :term:`detector`, or occurrences of a custom event, is essentially identical to :ref:`specifying a metric as a signal`. The only real difference is that if you :ref:`use the Metrics Sidebar `, you must select the :strong:`Find Events` option to search for detector or custom event names. +The process for adding an event triggered by a :term:`detector`, or occurrences of a custom event, is essentially identical to :ref:`specifying a metric as a signal`. The only real difference is that if you use the metrics sidebar, you must select the :strong:`Find events` option to search for detector or custom event names. -.. note:: If you clear the :strong:`Find Metrics` option to search only for events, none of the other search options in the Metrics Sidebar are available. You must enter text manually to find matching detector or custom event names. Similarly, if you add a filter, you can search only for metrics, not for events. +.. note:: If you clear the :strong:`Find metrics` option to search only for events, none of the other search options in the metrics sidebar are available. You must enter text manually to find matching detector or custom event names. Similarly, if you add a filter, you can search only for metrics, not for events. .. _event-markers: diff --git a/metrics-and-metadata/metrics-finder-metadata-catalog.rst b/metrics-and-metadata/metrics-finder-metadata-catalog.rst index b3f89d97a..946c3f8f7 100644 --- a/metrics-and-metadata/metrics-finder-metadata-catalog.rst +++ b/metrics-and-metadata/metrics-finder-metadata-catalog.rst @@ -1,7 +1,7 @@ .. _metrics-finder-and-metadata-catalog: ***************************************************************** -Search the Metric Finder and Metadata catalog +Search the Metric Finder and Metadata Catalog ***************************************************************** .. meta:: From e59625f81b1b5ffd83baacfaee2ad53f212c3054 Mon Sep 17 00:00:00 2001 From: trangl Date: Tue, 3 Dec 2024 11:30:25 +0100 Subject: [PATCH 07/13] Style fixes --- data-visualization/charts/chart-builder.rst | 2 +- data-visualization/dashboards/dashboards-add.rst | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/data-visualization/charts/chart-builder.rst b/data-visualization/charts/chart-builder.rst index b384c5da3..eb57c3c67 100644 --- a/data-visualization/charts/chart-builder.rst +++ b/data-visualization/charts/chart-builder.rst @@ -716,7 +716,7 @@ For example, for a regular wildcard query, :code:`jvm.*` returns anything that s For Graphite wildcards, :code:`jvm.*` returns only something that has no subsequent dots in the name. For example, for :code:`jvm.*`, :code:`jvm.foo` would be returned, but :code:`jvm.foo.bar` and :code:`jvm.foo.bar.foo` would not. -To use the Graphite wildcard, enter the appropriate Graphite syntax into the signal field, then select the Graphite wildcard option. If you are using the Metrics Sidebar, enter any search term with an asterisk between two dot (.) characters, then select :strong:`Graphite wildcard` from the search results list. +To use the Graphite wildcard, enter the appropriate Graphite syntax into the signal field, then select the Graphite wildcard option. If you are using the metrics sidebar, enter any search term with an asterisk between two dot (.) characters, then select :strong:`Graphite wildcard` from the search results list. When the Graphite wildcard option is selected, the ability to filter plots by dimensions is removed. Graphite naming conventions encapsulate dimension values into dot-separated strings and are in effect selected through the use of wildcards. diff --git a/data-visualization/dashboards/dashboards-add.rst b/data-visualization/dashboards/dashboards-add.rst index 1e9de7559..fe61231a4 100644 --- a/data-visualization/dashboards/dashboards-add.rst +++ b/data-visualization/dashboards/dashboards-add.rst @@ -43,9 +43,9 @@ An event feed chart shows a list of events that meet criteria you specify, inclu - custom events that you have manually created in Splunk Infrastructure Monitoring - custom events that have been sent in from an external source -You can use the Metrics Sidebar to quickly add simple event feed charts to your dashboard (see :ref:`create-charts`). Click :menuselection:`Find Events` in the Metrics Sidebar to include only events in your search results. +You can use the metrics sidebar to quickly add simple event feed charts to your dashboard (see :ref:`create-charts`). Select :menuselection:`Find events` in the metrics sidebar to include only events in your search results. -To add charts with more robust event feeds to a dashboard, open the dashboard and then select :menuselection:`Chart` from the dashboard's Actions menu (|more|). (Alternately, you can click :guilabel:`New chart` in the placeholder image at the bottom of every dashboard.) From the chart type selector, select :menuselection:`Event Feed`. See :ref:`chart-types` for more information on Event Feed charts. +To add charts with more robust event feeds to a dashboard, open the dashboard and then select :menuselection:`Chart` from the dashboard's Actions menu (|more|). (Alternately, you can select :guilabel:`New chart` in the placeholder image at the bottom of every dashboard.) From the chart type selector, select :menuselection:`Event Feed`. See :ref:`chart-types` for more information on Event Feed charts. If you don't have :ref:`write permissions` for the dashboard you are viewing, or you are in a built-in dashboard, you need to select :guilabel:`Save as` to save the chart. @@ -53,7 +53,7 @@ You can add multiple event types to the feed by adding a new plot line for each If you add events generated when a detector triggers an alert, the severity of the alert is shown in the feed. -Click :guilabel:`Save As` to save the event feed to the dashboard; the event feed is placed at the bottom of the dashboard. Once in the dashboard, the event feed can be moved and resized like any other chart. You can also click on custom events listed in the feed to edit or delete them. +Select :guilabel:`Save As` to save the event feed to the dashboard; the event feed is placed at the bottom of the dashboard. Once in the dashboard, the event feed can be moved and resized like any other chart. You can also select custom events listed in the feed to edit or delete them. When you hover over an event in a dashboard's event feed chart, a vertical line is displayed in all the charts at the time the event occurred. This feature makes it easy for you to visualize correlations between metric values and the event. (Of course, a line is displayed only when the event occurred during the time frame displayed in the dashboard.) From 33057cab11aee25f1b6c3384526d113c45e5a506 Mon Sep 17 00:00:00 2001 From: trangl Date: Tue, 3 Dec 2024 11:32:28 +0100 Subject: [PATCH 08/13] Add numbered steps --- data-visualization/charts/create-charts.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data-visualization/charts/create-charts.rst b/data-visualization/charts/create-charts.rst index 8b66ec3eb..09f15147e 100644 --- a/data-visualization/charts/create-charts.rst +++ b/data-visualization/charts/create-charts.rst @@ -174,11 +174,11 @@ The chart type you select is applied as a default to all the plots on the chart, Save a chart ============ -When you finish creating or editing a chart, select :guilabel:`Save`, :guilabel:`Save as`, or :guilabel:`Save and close` from the :guilabel:`Chart actions` menu of the chart. The options vary depending on how you created or opened the chart. +#. When you finish creating or editing a chart, select :guilabel:`Save`, :guilabel:`Save as`, or :guilabel:`Save and close` from the :guilabel:`Chart actions` menu of the chart. The options vary depending on how you created or opened the chart. -If you don't have write permissions for the dashboard you are viewing or if you are in a built-in dashboard, you can't see an option to save the chart. Instead, you have to use :guilabel:`Save as` to save the chart to another dashboard. + If you don't have write permissions for the dashboard you are viewing or if you are in a built-in dashboard, you have to use :guilabel:`Save as` to save the chart to another dashboard. -To save your changes, select :guilabel:`Close`. +#. Select :guilabel:`Close`. .. note:: From 01a4544c00b1dbb67068ba4865af64b99431ff2e Mon Sep 17 00:00:00 2001 From: trangl Date: Tue, 3 Dec 2024 11:42:08 +0100 Subject: [PATCH 09/13] Remove stacked headings --- data-visualization/charts/chart-types.rst | 5 ----- 1 file changed, 5 deletions(-) diff --git a/data-visualization/charts/chart-types.rst b/data-visualization/charts/chart-types.rst index fca069693..02bf0a43f 100644 --- a/data-visualization/charts/chart-types.rst +++ b/data-visualization/charts/chart-types.rst @@ -8,11 +8,6 @@ Chart types in Splunk Observability Cloud .. meta:: :description: Learn about different chart types and when to use each chart type in Splunk Observability Cloud -.. _charts-overview: - -Overview -==================== - Charts in Splunk Observability Cloud are components of a dashboard. Each chart type provides a different way to represent your data: - :ref:`graph-charts`: Display data points over a period of time. Graph charts come in four different forms. From 5497a24a3d4bc97b12180c07b01a363ffea396b0 Mon Sep 17 00:00:00 2001 From: trangl Date: Tue, 17 Dec 2024 12:26:48 +0100 Subject: [PATCH 10/13] Add Metric Finder method --- data-visualization/charts/create-charts.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/data-visualization/charts/create-charts.rst b/data-visualization/charts/create-charts.rst index 09f15147e..e2b3a71c3 100644 --- a/data-visualization/charts/create-charts.rst +++ b/data-visualization/charts/create-charts.rst @@ -31,6 +31,8 @@ See the following table for different chart creation methods: * - :strong:`Method` - :strong:`Description` + * - Create a chart using the Metric Finder + - Use this method to browse metrics and decide the metric you are interested in before creating a chart. To learn more, see :ref:`create-chart-metric-finder`. * - Create a chart using the metrics sidebar - Use this method to create a simple chart or add a new chart to an existing dashboard. To learn more, see :ref:`create-chart-metric-sidebar`. * - Copy a chart @@ -41,6 +43,19 @@ See the following table for different chart creation methods: - Use this method to programmatically create a chart instead of creating one through the user interface. To learn more, see :ref:`create-chart-via-api`. +.. _create-chart-metrics-finder: + +Create a chart using the Metric Finder +------------------------------------------------ + +If you're not sure which metric you want to track, use the Metric Finder to browse different options before creating a new chart. + +#. From the navigation menu, select :strong:`Metric Finder`. +#. Search for metrics by entering key words into the search bar, or selecting an integration name. +#. Once you find the metric you're interested in, select the metric name to open the Chart Builder, pre-populated with your metric. + +To learn more about using the Metric Finder, see :ref:`metric-finder`. + .. _create-chart-metric-sidebar: Create a chart using the metrics sidebar From 947105595b22f838c35ec4619da2f486b57dd1ed Mon Sep 17 00:00:00 2001 From: trangl Date: Tue, 17 Dec 2024 15:58:39 +0100 Subject: [PATCH 11/13] Fix label typo --- data-visualization/charts/create-charts.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data-visualization/charts/create-charts.rst b/data-visualization/charts/create-charts.rst index e2b3a71c3..6565cafb3 100644 --- a/data-visualization/charts/create-charts.rst +++ b/data-visualization/charts/create-charts.rst @@ -43,7 +43,7 @@ See the following table for different chart creation methods: - Use this method to programmatically create a chart instead of creating one through the user interface. To learn more, see :ref:`create-chart-via-api`. -.. _create-chart-metrics-finder: +.. _create-chart-metric-finder: Create a chart using the Metric Finder ------------------------------------------------ From 91f0b533f55a39b7dc406dcb4daaa7fcf9493643 Mon Sep 17 00:00:00 2001 From: trangl Date: Tue, 17 Dec 2024 16:16:42 +0100 Subject: [PATCH 12/13] Wording --- data-visualization/charts/create-charts.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data-visualization/charts/create-charts.rst b/data-visualization/charts/create-charts.rst index 6565cafb3..42f154253 100644 --- a/data-visualization/charts/create-charts.rst +++ b/data-visualization/charts/create-charts.rst @@ -32,7 +32,7 @@ See the following table for different chart creation methods: * - :strong:`Method` - :strong:`Description` * - Create a chart using the Metric Finder - - Use this method to browse metrics and decide the metric you are interested in before creating a chart. To learn more, see :ref:`create-chart-metric-finder`. + - Use this method to browse metrics and decide which metric to track before creating a chart. To learn more, see :ref:`create-chart-metric-finder`. * - Create a chart using the metrics sidebar - Use this method to create a simple chart or add a new chart to an existing dashboard. To learn more, see :ref:`create-chart-metric-sidebar`. * - Copy a chart From e80f60a333a1f5da623c8e6bbd65f9647f29046d Mon Sep 17 00:00:00 2001 From: trangl Date: Wed, 18 Dec 2024 13:43:19 +0100 Subject: [PATCH 13/13] Switch methods order --- data-visualization/charts/create-charts.rst | 50 +++++++++++---------- 1 file changed, 26 insertions(+), 24 deletions(-) diff --git a/data-visualization/charts/create-charts.rst b/data-visualization/charts/create-charts.rst index 42f154253..f52a18cc0 100644 --- a/data-visualization/charts/create-charts.rst +++ b/data-visualization/charts/create-charts.rst @@ -31,30 +31,31 @@ See the following table for different chart creation methods: * - :strong:`Method` - :strong:`Description` + * - Create a chart using the Chart Builder + - Use this method to create a complex chart with customizations during the creation process. To learn more, see :ref:`create-chart-with-chart-builder`. + * - Create a chart using the metrics sidebar + - Use this method to create a simple chart or add a new chart to an existing dashboard. This method is useful for users who are new to Splunk Observability Cloud and are not familiar with more complex chart customizations. To learn more, see :ref:`create-chart-metric-sidebar`. * - Create a chart using the Metric Finder - Use this method to browse metrics and decide which metric to track before creating a chart. To learn more, see :ref:`create-chart-metric-finder`. - * - Create a chart using the metrics sidebar - - Use this method to create a simple chart or add a new chart to an existing dashboard. To learn more, see :ref:`create-chart-metric-sidebar`. * - Copy a chart - Use this method to add a copy or move a chart to another dashboard. To learn more, see :ref:`copy-charts`. - * - Create a chart using the Chart Builder - - Use this method to create a more complex chart with customizations during the creation process. To learn more, see :ref:`create-chart-with-chart-builder`. * - Create a chart using the API - Use this method to programmatically create a chart instead of creating one through the user interface. To learn more, see :ref:`create-chart-via-api`. -.. _create-chart-metric-finder: +.. _create-chart-with-chart-builder: -Create a chart using the Metric Finder ------------------------------------------------- +Create a new chart using the Chart Builder +------------------------------------------ -If you're not sure which metric you want to track, use the Metric Finder to browse different options before creating a new chart. +Follow these steps to create a chart in the Chart Builder: -#. From the navigation menu, select :strong:`Metric Finder`. -#. Search for metrics by entering key words into the search bar, or selecting an integration name. -#. Once you find the metric you're interested in, select the metric name to open the Chart Builder, pre-populated with your metric. +#. In the :strong:`Create` menu on the top navigation bar, select :strong:`Chart`. Alternatively, select :guilabel:`New chart` on custom dashboards. +#. Search for metrics or events you want to plot on your chart. For more information, see :ref:`chart-builder`. + + .. note:: You can add functions to your chart with the :strong:`F(x)` column. See :ref:`plot-analytics` and :ref:`analytics-ref` for more details. -To learn more about using the Metric Finder, see :ref:`metric-finder`. +#. Customize your chart. See :ref:`chart-options-tab`. .. _create-chart-metric-sidebar: @@ -111,6 +112,19 @@ Create charts with events #. Select the check box next to each item you want to add. #. Select :strong:`Multiple charts`. +.. _create-chart-metric-finder: + +Create a chart using the Metric Finder +------------------------------------------------ + +If you're not sure which metric you want to track, use the Metric Finder to browse different options before creating a new chart. + +#. From the navigation menu, select :strong:`Metric Finder`. +#. Search for metrics by entering key words into the search bar, or selecting an integration name. +#. Once you find the metric you're interested in, select the metric name to open the Chart Builder, pre-populated with your metric. + +To learn more about using the Metric Finder, see :ref:`metric-finder`. + .. _copy-charts: Copy a chart @@ -149,18 +163,6 @@ Once you copy charts to the clipboard, several options from the :strong:`Create` * - Clear clipboard - Select this option to clear the clipboard content without pasting charts to a dashboard. -.. _create-chart-with-chart-builder: - -Create a new chart using the Chart Builder ------------------------------------------- - -#. In the :strong:`Create` menu on the top navigation bar, select :strong:`Chart`. Alternatively, select :guilabel:`New chart` on custom dashboards. -#. Search for metrics or events you want to plot on your chart. For more information, see :ref:`chart-builder`. - - .. note:: You can add functions to your chart with the :strong:`F(x)` column. See :ref:`plot-analytics` and :ref:`analytics-ref` for more details. - -#. Customize your chart. See :ref:`chart-options-tab`. - .. _create-chart-via-api: Create a chart using Splunk Observability Cloud API