diff --git a/_images/synthetics/detector-one.png b/_images/synthetics/detector-one.png new file mode 100644 index 000000000..1d91cebe8 Binary files /dev/null and b/_images/synthetics/detector-one.png differ diff --git a/_templates/layout.html b/_templates/layout.html index 553856012..4ed4dd382 100644 --- a/_templates/layout.html +++ b/_templates/layout.html @@ -179,10 +179,12 @@

Was this

- Feedback submitted, thanks! + Feedback submitted, thank you! We resolve documentation feedback based on the severity of the issue reported, as well as an assessment of the potential number of customers who might be affected.

+ + If you have a question about using Splunk software, we encourage you to check Splunk Answers or Splunk community Slack to see if similar questions have been answered, or to post your question for others to answer. If you have an active support entitlement and believe that your situation is caused by a product defect, file a support case in the Support portal https://login.splunk.com/page/sso_redirect?type=portal.
-

- Did you know that you can edit this page? Learn how! +

+ We are currently moving to a new documentation site. Expect a delay in responding to your feedback and applying any updates based on your feedback. Thank you for your patience and understanding while we work to bring you an improved documentation experience!
diff --git a/apm/set-up-apm/environments.rst b/apm/set-up-apm/environments.rst index 1ec524c74..e71bfddc3 100644 --- a/apm/set-up-apm/environments.rst +++ b/apm/set-up-apm/environments.rst @@ -61,6 +61,20 @@ The :new-page:`Splunk Distribution of OpenTelemetry Collector agent config file Note that unlike standard attributes, the ``deployment.environment`` tag is set with the ``resource`` processor in OpenTelemetry, because this tag is typically associated with the host or container in which the application is running. +The ``resource/add_environment`` resorce can be then added to any pipeline of the ``service`` section of your configuration file. See +:ref:`Sample configurations ` for more examples. + +.. code-block:: yaml + + service: + pipelines: + metrics: + processors: [resource/add_environment] + logs: + processors: [resource/add_environment] + traces: + processors: [resource/add_environment] + To learn more about how to add span tags via the Splunk Distribution of OpenTelemetry Collector, see :ref:`otel-span-tags`. Alert on specific environments 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 deb8bfc89..eb57c3c67 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`). @@ -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: @@ -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/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 ***************************************************************** diff --git a/data-visualization/charts/chart-types.rst b/data-visualization/charts/chart-types.rst index fca069693..f6ce86aff 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. @@ -103,86 +98,10 @@ A list chart can display up to 100 items at a time. .. image:: /_images/data-visualization/charts/list-chart.png :alt: This screenshot shows a list chart illustrating the number of active hosts per AWS EC2 instance type. -Sorting list charts +Sort list charts ------------------- -The API lets you sort values in list charts by specifying the ``options.sortBy`` property in the request to create or update a chart. -You can sort on one of the dimensions in the MTS for the chart, a data point, the metric name, or the ``publish()`` method ``label`` argument of the SignalFlow statement that generates the data. To choose one of these options, specify one of the keyword values shown in the following table: - -.. list-table:: - :header-rows: 1 - :widths: 10 40 50 - - * - :strong:`Keyword` - - :strong:`Alias in the user interface` - - :strong:`Description` - - * - ```` - - Dimension name - - One of the dimensions of the displayed MTS. To see the available dimensions, follow the instructions following this table. - - * - ``sf_metric`` - - Plot name - - The ``label`` argument of the SignalFlow ``publish()`` that provides the displayed data. This is also the plot name of the corresponding signal in the user interface. - - * - ``sf_originatingMetric`` - - Metric - - Name of the metric for the displayed MTS. - - * - ``value`` - - Value - - Value of the data point when Splunk Observability Cloud receives it. - -In addition, you can sort by any dimension of an MTS displayed in the chart. - -To see a list of entities on which you can sort: - -#. In the user interface, open the chart. -#. Select the :strong:`Chart options` tab. -#. Open the :strong:`Sort` dropdown list. In the list, :strong:`Value` is the alias for ``value``, :strong:`Plot name` is the alias for ``sf_metric``, and :strong:`Metric` is the alias for ``sf_originatingMetric``. All other list items are dimension names. - - - -Examples -++++++++++ - -To sort a list chart by value, specify the following in the request body: - -.. code-block:: - - { - options: { - "sortBy": "value", - ... - } - } - - -To sort by plot name, specify the following: - -.. code-block:: - - { - options: { - "sortBy": "sf_metric", - ... - } - } - -To sort by the dimension ``demo_datacenter``, specify the following: - -.. code-block:: - - { - options: { - "sortBy": "demo_datacenter", - ... - } - } - - -.. note:: - Splunk Observability Cloud doesn't guarantee the sort order of identical values in the input stream. +You can sort a list chart using the API. For more information, see the :new-page:`Sort a list chart ` section in the `Splunk Observability Cloud Developer Guide`. List chart prefix and suffix ---------------------------- 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 605464b1d..f52a18cc0 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,87 +23,157 @@ 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 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`. + * - 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 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`. +.. _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 a new chart using the Chart Builder +------------------------------------------ +Follow these steps to create a chart in the Chart Builder: -.. _copy-charts: +#. 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`. -Copy charts ------------ +.. _create-chart-metric-sidebar: -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. +Create a chart using the metrics sidebar +------------------------------------------------ -You can also use this method to "move" a chart from one dashboard to another; after copying a chart, delete the original 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: -.. _copy-chart-to-clipboard: +#. Open the metrics sidebar. -Follow these steps to copy charts to a clipboard: + * 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. -#. 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. -#. 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. +#. 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. -Different options on the Create menu let you paste the charts onto a dashboard. Pasting charts clears the clipboard. +Create charts with metrics +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -- 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. +* Create a chart with a single metric: -- 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. + #. Select the check box next to the metric name. + #. Select :strong:`Add chart`. -- 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`. +* Create a chart containing one plot for each metric: -To clear the clipboard contents without pasting the charts to a dashboard, select :guilabel:`Clear Clipboard` from the Create menu. + #. Select the check box next to each item you want to add. + #. Select :strong:`Add chart`. -.. _create-chart-with-chart-builder: +* Create multiple charts, one for each metric: -Create a new chart using the Chart Builder ------------------------------------------- + #. Select the check box next to each item you want to add. + #. Select :strong:`Separate charts`. + #. Select :strong:`Add charts`. -#. Select :guilabel:`Chart` from the :guilabel:`Create` menu. Alternatively, you can 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`. +.. note:: Select :strong:`Add with filters` to add matching metadata from each metric result as filters to your chart. + +Create charts with events +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +* Create a chart with a single event: + + #. Select the check box next to the event name. + #. Select :strong:`Add chart`. -See also :ref:`choose-chart-type`. +* Create a chart containing one plot for each event: -.. _create-chart-from-finder: + #. Select the check box next to each item you want to add. + #. Select :strong:`Add single chart`. -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 multiple charts, one for each event: -See also :ref:`choose-chart-type`. + #. Select the check box next to each item you want to add. + #. Select :strong:`Multiple charts`. -.. _create-chart-from-catalog: +.. _create-chart-metric-finder: -Create a chart from the Metadata Catalog ----------------------------------------- +Create a chart using the Metric Finder +------------------------------------------------ -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. +If you're not sure which metric you want to track, use the Metric Finder to browse different options before creating a new chart. -See also :ref:`choose-chart-type`. +#. 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 +--------------- + +You can copy charts from one or multiple dashboards to a clipboard. You might want to use this technique for the following use cases: + +* 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 a chart to a clipboard: + +#. 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. + +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. + +.. list-table:: + :header-rows: 1 + :widths: 30 70 + + * - :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-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. @@ -127,24 +186,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 you are in a built-in dashboard, you have to use :guilabel:`Save as` to save the edited 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 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`. +#. 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. + + 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: 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.) diff --git a/gdi/get-data-in/application/java/java-otel-requirements.rst b/gdi/get-data-in/application/java/java-otel-requirements.rst index 86b367a1c..395f76862 100644 --- a/gdi/get-data-in/application/java/java-otel-requirements.rst +++ b/gdi/get-data-in/application/java/java-otel-requirements.rst @@ -9,6 +9,8 @@ Java agent compatibility and requirements Meet the following requirements to instrument Java applications for Splunk Observability Cloud. +.. note:: Splunk does not officially support compatibility with Java agents from other vendors. + .. _java-requirements: Make sure you are using compatible Java and JVM versions diff --git a/gdi/opentelemetry/components/apache-spark-receiver.rst b/gdi/opentelemetry/components/apache-spark-receiver.rst index 3f43c20f7..14e78b1d4 100644 --- a/gdi/opentelemetry/components/apache-spark-receiver.rst +++ b/gdi/opentelemetry/components/apache-spark-receiver.rst @@ -67,7 +67,15 @@ The following settings are optional: * Valid time units are ``ns``, ``us`` (or ``µs``), ``ms``, ``s``, ``m``, ``h``. -* .. include:: /_includes/gdi/collector-settings-initialdelay.rst +* .. raw:: html + +
+ + .. include:: /_includes/gdi/collector-settings-initialdelay.rst + + .. raw:: html + +
* ``endpoint``. ``http://localhost:4040`` by default. Apache Spark endpoint to connect to in the form of ``[http][://]{host}[:{port}]``. diff --git a/gdi/opentelemetry/components/resource-processor.rst b/gdi/opentelemetry/components/resource-processor.rst index 709fe57b9..abeea7d3b 100644 --- a/gdi/opentelemetry/components/resource-processor.rst +++ b/gdi/opentelemetry/components/resource-processor.rst @@ -51,6 +51,8 @@ Follow these steps to configure and activate the component: 2. Configure the resource processor as described in the next section. 3. Restart the Collector. +.. _sample_configurations: + Sample configurations ---------------------- diff --git a/get-started/get-started-guide/get-started-guide.rst b/get-started/get-started-guide/get-started-guide.rst index 0272e2cf7..168f6eb30 100644 --- a/get-started/get-started-guide/get-started-guide.rst +++ b/get-started/get-started-guide/get-started-guide.rst @@ -79,7 +79,7 @@ The journey for getting started with Splunk Observability Cloud has 3 phases: on See :ref:`Phase 1 optional and advanced configurations `. - * :ref:`advanced-config-3rd-party` - * :ref:`phase3-network-exp` + * :ref:`phase2-network-exp` * :ref:`phase2-profiling` * :ref:`phase2-related-content` diff --git a/get-started/get-started-guide/initial-rollout.rst b/get-started/get-started-guide/initial-rollout.rst index 9ae599014..1a0bab43a 100644 --- a/get-started/get-started-guide/initial-rollout.rst +++ b/get-started/get-started-guide/initial-rollout.rst @@ -105,7 +105,7 @@ When using the Splunk Distribution of OpenTelemetry Collector, you can use recei See :ref:`monitor-data-sources` for a list of receivers. -.. _phase3-network-exp: +.. _phase2-network-exp: Set up Network Explorer to monitor network environment ---------------------------------------------------------- diff --git a/get-started/service-description.rst b/get-started/service-description.rst index 8c1b9dc58..618de7be5 100644 --- a/get-started/service-description.rst +++ b/get-started/service-description.rst @@ -274,13 +274,13 @@ The following components are available for each global region. Each Cloud provid - * US: Oregon (us-west-2), Virginia (us-east-1) * Europe: Dublin (eu-west-1), Frankfurt (eu-central-1), London (eu-west-2) - * Asia Pacific: Sydney (ap-southeast-2) + * Asia Pacific: Sydney (ap-southeast-2), Tokyo (ap-northeast-1) - * US: Oregon (us-west-1) - * us0, us1, us2 * eu0, eu1, eu2 - * au0 + * au0, jp0 * - Synthetic Monitoring - * US: Oregon (us-west-2), Virginia (us-east-1) diff --git a/index.rst b/index.rst index e4235e118..05df6fe13 100644 --- a/index.rst +++ b/index.rst @@ -758,17 +758,17 @@ To keep up to date with changes in the products, see the Splunk Observability Cl .. toctree:: :maxdepth: 3 - Uptime Tests for port and HTTP TOGGLE + Uptime tests for port and HTTP TOGGLE .. toctree:: :maxdepth: 3 - Use an API test to test an endpoint TOGGLE + API tests for endpoints TOGGLE .. toctree:: :maxdepth: 3 - synthetics/test-kpis/test-kpis + Test status TOGGLE .. toctree:: :maxdepth: 3 diff --git a/metrics-and-metadata/metric-categories.rst b/metrics-and-metadata/metric-categories.rst index f7c58c32f..78210c9e1 100644 --- a/metrics-and-metadata/metric-categories.rst +++ b/metrics-and-metadata/metric-categories.rst @@ -8,9 +8,10 @@ Metric categories .. meta:: :description: Learn about metric categories in Splunk Observability Cloud. -These are the available categories for metrics in Splunk Observability Cloud: - +Metric categories for realms us0 and us1 +=========================================== +The following metric categories are used in the realms ``us0`` and ``us1``: .. raw:: html @@ -22,6 +23,85 @@ These are the available categories for metrics in Splunk Observability Cloud:
+Metric categories for other realms +=========================================== + +The following metric categories are used for any realms that aren't ``us0`` or ``us1``: + +.. list-table:: + :header-rows: 1 + :widths: 20 80 + :width: 100% + + * - :strong:`Category type` + - :strong:`Description` + + * - 0 + - | No information about the category type of the metric. + | Note: Category type information for metrics is only available after 03/16/2023. Any metrics created before that date has category type ``0``. + + * - 1 + - Host + + * - 2 + - Container + + * - 3 + - | Custom + | Metrics reported to Splunk Observability Cloud outside of those reported by default, such as host, container, or bundled metrics. Custom metrics might result in increased data ingest costs. + * - 4 + - Hi-resolution + + * - 5 + - Internal + + * - 6 + - Tracing metrics + + * - 7 + - | Bundled + | In host-based subscription plans, additional metrics sent through Infrastructure Monitoring public cloud integrations that are not attributed to specific hosts or containers. + * - 8 + - APM hosts + + * - 9 + - APM container + + * - 10 + - APM identity + + * - 11 + - APM bundled metrics + + * - 12 + - | APM Troubleshooting MetricSets + | This category is not part of the report. + * - 13 + - APM Monitoring MetricSets + + * - 14 + - Infrastructure Monitoring function + + * - 15 + - APM function + + * - 16 + - | RUM Troubleshooting MetricSets + | This category is not part of the report. + * - 17 + - RUM Monitoring MetricSets + + * - 18 + - Network Explorer metrics + + * - 19 + - Runtime metrics + + * - 20 + - Synthetics metrics + +.. note:: In subscription plans based on metric time series (MTS), all metrics are categorized as custom metrics and billed accordingly. + 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:: diff --git a/sp-oncall/on-call-schedules/schedule-examples.rst b/sp-oncall/on-call-schedules/schedule-examples.rst index 17ee6c369..303c32e74 100644 --- a/sp-oncall/on-call-schedules/schedule-examples.rst +++ b/sp-oncall/on-call-schedules/schedule-examples.rst @@ -32,14 +32,13 @@ Configure the Business Hours rotation #. Navigate to the team you'd like to implement this schedule for and add all of the appropriate users using the :guilabel:`Invite User` button. #. Navigate to the :menuselection:`Rotations` tab and select :guilabel:`Add Rotation`. -#. Name the rotation "Business Hours" and select "Partial Day" for the shift type +#. Name the rotation "Business Hours" and select "Partial Day" for the shift type. #. Name the first shift either after the user who will be occupying it or just call it "Shift 1" and set the hours. #. Select :guilabel:`Save Shift`. - - .. note:: Ignore the "Handoff happens every X week" and "The next handoff happens X" fields because this shift is being created with the intent to not handoff. - + .. note:: Ignore the "Handoff happens every X week" and "The next handoff happens X" fields because this shift is being created with the intent to not handoff. #. Next, add the appropriate user to this shift by selecting :guilabel:`Manage Members` and then :guilabel:`Select a User to add`. #. After adding the appropriate user, select :guilabel:`Add Another Shift`. + #. Select :guilabel:`Partial Day` and repeat the process from the previous steps. You will end up creating one shift for each user you would like on-call simultaneously during the business day. #. When finished, select :guilabel:`I'm Done, Save this Rotation`. @@ -49,12 +48,14 @@ Configure the Nights and Weekends rotation #. Create the "Nights and Weekends' rotation by selecting :guilabel:`Add a Rotation`. #. Name the rotation "Nights and Weekends" and select :guilabel:`Partial Day` for the first shift type. #. Name the first shift "Weeknights". - #. In the section with Monday through Friday in blue lettering, deselect Friday. Also, change the hours to cover all week-hours that are not covered by the Business Hours rotation. For example, if your business hours are 8 AM to 5 PM, your Weeknights shift should be 5 PM to 8 AM. If your Business Hours are 9 AM to 4 PM, your Weeknights - shift should be 4 PM to 9 AM. + + #. In the section with Monday through Friday in blue lettering, deselect Friday. Also, change the hours to cover all week-hours that are not covered by the Business Hours rotation. For example, if your business hours are 8 AM to 5 PM, your Weeknights shift should be 5 PM to 8 AM. If your Business Hours are 9 AM to 4 PM, your Weeknights shift should be 4 PM to 9 AM. #. Change the :guilabel:`The next handoff happens` date to the next upcoming Monday. #. Select :guilabel:`Save Shift`. #. To add users to this shift, select :guilabel:`Manage Members` then :guilabel:`Select a User to add`. The order that you add the users in will dictate the week they end up on-duty. The first user you add will do the current week, the next user the week after, the third user the third week. You can re-order them after adding by dragging them on the :menuselection:`Members` page. + #. After adding the appropriate users, select :guilabel:`Add another Shift` and select :guilabel:`Multi-day` for the type. + #. Name this shift “Weekends” and adjust the hours to those desired. #. Select :guilabel:`Save Shift`. #. To add users to this shift, select :guilabel:`Manage Members` then :guilabel:`Select a User to add`. The order that you add the users in will dictate the week they end up on-duty. You can re-order these users after adding by dragging them around within this menu. @@ -69,7 +70,7 @@ The next part of the configuration process will involve creating a Secondary rot #. Name the rotation “Secondary” and select :guilabel:`24/7` for the shift type. #. Name the shift “Secondary Shift” and change the handoff time to the appropriate one. This is typically when business hours begin for your organization. #. Change the :guilabel:`The next handoff happens` date to the next upcoming Monday. -#. Select :guilabel:`Save Shift`/ +#. Select :guilabel:`Save Shift`. #. To add users to the shift :guilabel:`Manage Members` then :guilabel:`Select a User to add`.The order that you add the users in will dictate the week they end up on-duty. The first user you add will do the current week, the next user the week after, the third user the third week. You can re-order these users after adding by dragging them around within this menu. #. When finished, select :guilabel:`I'm Done, Save this Rotation`. @@ -119,24 +120,23 @@ Main points: Configure the Business Hours rotation -------------------------------------------- -Navigate to the team you'd like to implement this schedule for and add all of the appropriate users using the :guilabel:`Invite User` button. +#. Navigate to the team you'd like to implement this schedule for and add all of the appropriate users using the :guilabel:`Invite User` button. #. Navigate to the :menuselection:`Rotations` tab and select :guilabel:`Add Rotation`. #. Name the rotation "Business Hours" and select "Partial Day" for the shift type. - #. Name the first shift either after the user who will be occupying it or just call it "Shift 1" and set the hours. - #. Set the shift hours. - #. Select :guilabel:`Save Shift`. + #. Name the first shift either after the user who will be occupying it or just call it "Shift 1" and set the hours. + #. Set the shift hours. + #. Select :guilabel:`Save Shift`. - .. note:: Ignore the "Handoff happens every X week" and "The next handoff happens X" fields because this shift is being created with the intent to not handoff. + .. note:: Ignore the "Handoff happens every X week" and "The next handoff happens X" fields because this shift is being created with the intent to not handoff. - #. Next, add the appropriate user to this shift by selecting :guilabel:`Manage Members` and then :guilabel:`Select a User to add`. - #. After adding the appropriate user, select :guilabel:`Add Another Shift`. + #. Next, add the appropriate user to this shift by selecting :guilabel:`Manage Members` and then :guilabel:`Select a User to add`. + #. After adding the appropriate user, select :guilabel:`Add Another Shift`. #. Select :guilabel:`Partial Day` and repeat the process from the previous steps. You will end up creating one shift for each user you would like on-call simultaneously during the business day. #. When finished, select :guilabel:`I'm Done, Save this Rotation`. - Configure the Escalation Policies ------------------------------------------ @@ -157,4 +157,4 @@ The next part of this configuration will involve assigning a routing key to the #. Select :guilabel:`Add Key` and name the routing key "bus-hours-only". #. In the dropdown menu, select the :guilabel:`Busines Hours Only` escalation policy, located under the team you created it for. #. Select the blue checkbox to save your changes. -#. Once you've created this routing key, go into your monitoring tools and assign this routing key to the alerts you only want to page during business hours. Optionally, follow the rules engine steps. You should be able to locate instructions on where to edit the routing key in your specific monitoring tool by finding that tool's integration guide. If you have any questions, contact victorops-support@splunk.com. \ No newline at end of file +#. Once you've created this routing key, go into your monitoring tools and assign this routing key to the alerts you only want to page during business hours. Optionally, follow the rules engine steps. You should be able to locate instructions on where to edit the routing key in your specific monitoring tool by finding that tool's integration guide. If you have any questions, contact victorops-support@splunk.com. diff --git a/splunkplatform/unified-id/unified-identity.rst b/splunkplatform/unified-id/unified-identity.rst index 1d6eef51c..ac983e9e8 100644 --- a/splunkplatform/unified-id/unified-identity.rst +++ b/splunkplatform/unified-id/unified-identity.rst @@ -277,6 +277,8 @@ Point-and-click log analysis One important advantage of the integration is that users can now query their Splunk Cloud Platform logs in Log Observer's no-code UI. Users can create advanced queries without knowing SPL with Log Observer's filters and aggregations. See :ref:`logs-queries` for more information. +When you use Log Observer Connect, your logs remain in your Splunk Cloud Platform instance and are accessible only to Log Observer Connect. Log Observer Connect does not store or index your logs data. + Related Content ------------------------------------------------------------------------------------------ diff --git a/synthetics/api-test/api-test-metrics.rst b/synthetics/api-test/api-test-metrics.rst index 8f612de4e..b1c225967 100644 --- a/synthetics/api-test/api-test-metrics.rst +++ b/synthetics/api-test/api-test-metrics.rst @@ -108,9 +108,9 @@ Each occurrence of a test from a particular device and location at a specific ti * - Uptime - ``synthetics.run.uptime.percent`` - - The percentage of non-failed test runs. Uptime is calculated by taking the average score of all runs in the selected time frame, where a successful run receives a score of 100 and a failure receives a score of 0. + - The uptime of a test run: the value will be 0 if the test run failed and 100 if it succeeded. * - Downtime - ``synthetics.run.downtime.percent`` - - The percentage of failed runs within the selected time frame. Downtime is calculated by taking the average score of all runs in the selected time frame, where a failed run receives a score of 100 and a successful run receives a score of 0. + - The downtime of a test run: The value will be 100 if the test run failed and 0 if it succeeded. diff --git a/synthetics/api-test/api-test.rst b/synthetics/api-test/api-test.rst index 97a7c0f12..6e0e204d6 100644 --- a/synthetics/api-test/api-test.rst +++ b/synthetics/api-test/api-test.rst @@ -1,7 +1,7 @@ .. _api-test: ************************************ -API Tests for endpoint +API tests for endpoints ************************************ .. meta:: diff --git a/synthetics/test-config/built-in-variables.rst b/synthetics/test-config/built-in-variables.rst index 0bedf04ef..ca3977716 100644 --- a/synthetics/test-config/built-in-variables.rst +++ b/synthetics/test-config/built-in-variables.rst @@ -1,7 +1,7 @@ .. _built-in-variables: *********************************** -Built-in variables to use in tests +Built-in variables *********************************** .. meta:: diff --git a/synthetics/test-config/devices.rst b/synthetics/test-config/devices.rst new file mode 100644 index 000000000..31b0a0b1a --- /dev/null +++ b/synthetics/test-config/devices.rst @@ -0,0 +1,26 @@ +.. _devices: + +***************************************** +Devices +***************************************** + +.. meta:: + :description: Select a predefined device to simulate a specific viewport size and network connection for a test. + +When you set up a test in Splunk Synthetic Monitoring, you can select a predefined device to simulate a specific viewport size and network connection for that test. Every predefined device is a combination of a specific viewport size and network connection. + +* A viewport is the framed area on a device's screen for viewing information, such as the browser window on a desktop. Since a viewport is an integral part of the visual experience of a user interacting with your application or site, viewport settings only apply to visual tests (browser tests). Viewport settings don't apply to API or uptime tests, because these tests are non-visual -- they only capture response data from your application or site. +* A network connection is the network type, speed, bandwidth, and latency experienced by a device. Since a network connection is an integral part of all experiences, network connection settings apply to all test types. Testing your site or application from a variety of network connections helps you to monitor the experience of users in a variety of environments. + + +Select a device type for Splunk Synthetic Monitoring tests +========================================================== + +All tests have the device type :guilabel:`Default Desktop` by default. To change this for any test, follow these steps: + +#. From the landing page of Splunk Observability Cloud, navigate to Splunk Synthetic Monitoring. +#. Select the test that you want to change. +#. Select :guilabel:`Edit test`. The test creation view opens. +#. In the :guilabel:`Device` field, select one of the predefined devices. +#. Select :guilabel:`Save`. + diff --git a/synthetics/test-config/global-variables.rst b/synthetics/test-config/global-variables.rst index ff92d4b04..972049224 100644 --- a/synthetics/test-config/global-variables.rst +++ b/synthetics/test-config/global-variables.rst @@ -1,48 +1,48 @@ .. _global-variables: ***************************************** -Create and use global variables +Global variables ***************************************** .. meta:: :description: Define a variable that you can use in multiple browser and API tests in Splunk Synthetic Monitoring. -Define a global variable once, and then use it across all of your browser and API tests. +Global variables are pre-saved, reusable variables that you define once and use across all your browser and API tests. How can you use a global variable? =================================== Use global variables to store non-sensitive information for your browser and API tests. Splunk Synthetic Monitoring saves your global variables, but note that their values are visible to all users in your account. -To preserve your account's security, don't use global variables to store sensitive information such as login credentials, API keys, or credit card information. Instead, either use placeholder values or permanently conceal the global variables that contain sensitive information. +To preserve your account's security, don't use global variables to store sensitive information such as login credentials, API keys, or credit card information. .. _concealed-gv: What happens when you conceal a global variable? ================================================== -When you conceal a global variable, Splunk Synthetic Monitoring permanently hides its value from all users of your account. Concealed values are never revealed; they are scrubbed from the Splunk Synthetic Monitoring UI, from test results, and from alert messages. However, if you send a concealed value to a test endpoint, that endpoint receives its unconcealed value. +When you conceal a global variable, Splunk Synthetic Monitoring encrypts the variable's value in its database and scrubs its value from the Splunk Synthetic Monitoring UI, from test results, and from alert messages. However, concealed global variables were not designed to safeguard sensitive information or critical data; do not misuse them for such purposes. Create a global variable =============================== There are two ways to create a global variable: -#. Add a new global variable in the vault: +* Add a new global variable in the vault: - a. From the Splunk Synthetic Monitoring landing page, select :guilabel:`Synthetics configuration`. The :guilabel:`Synthetics configuration` page opens, on the :guilabel:`Global variables` tab. - b. Select :guilabel:`+ Add` to open the creation dialog box. + #. From the Splunk Synthetic Monitoring landing page, select :guilabel:`Synthetics configuration`. The :guilabel:`Synthetics configuration` page opens, on the :guilabel:`Global variables` tab. + #. Select :guilabel:`+ Add` to open the creation dialog box. -#. Add a new global variable while editing a test: +* Add a new global variable while editing a test: - a. In the right-hand :guilabel:`Variables` column, scroll to :guilabel:`Global variables` and select :guilabel:`Add`. + In the right-hand :guilabel:`Variables` column, scroll to :guilabel:`Global variables` and select :guilabel:`Add`. -Once you're in the :guilabel:`Add global variable` dialog box, enter the following: +When you're in the :guilabel:`Add global variable` dialog box, enter the following: #. In the :guilabel:`env` field, enter the name of the variable. You will use this key to access your variable within a test. #. In the :guilabel:`value` field, enter the value that will replace the variable when the test is run. #. (Optional) In the :guilabel:`Description` field, enter a description to explain the purpose of the variable for future reference. A description is particularly helpful when you conceal the variable and cannot reveal its value. -#. (Optional) Select :guilabel:`Conceal value` to permanently conceal the value to all users. -#. Once you're satisfied with your global variable, select :guilabel:`Add`. +#. (Optional) Select :guilabel:`Conceal value`. +#. Select :guilabel:`Add`. Edit a global variable diff --git a/synthetics/test-config/private-locations.rst b/synthetics/test-config/private-locations.rst index fc31ea30e..60918a1af 100644 --- a/synthetics/test-config/private-locations.rst +++ b/synthetics/test-config/private-locations.rst @@ -5,7 +5,7 @@ Private locations ***************** .. meta:: - :description: Run synthetic tests from an internal site or private web application to quickly find defects using Splunk Synthetic Monitoring. + :description: Run synthetic tests from private locations such as internal sites, private web applications, or private networks. A private location is a software package that offers a quick and easy deployment of Splunk Synthetic Monitoring solutions beyond the public network so that you can find, fix, and prevent web performance defects on any internal web application, in any environment - whether inside or outside of your firewalls. Private locations allow Splunk Synthetics Monitoring users to test sooner in the development cycle and against internal sites or applications that aren't available to the public. diff --git a/synthetics/test-config/public-locations.rst b/synthetics/test-config/public-locations.rst index 412071af4..9babdfdc5 100644 --- a/synthetics/test-config/public-locations.rst +++ b/synthetics/test-config/public-locations.rst @@ -5,7 +5,7 @@ Public locations ***************** .. meta:: - :description: Run synthetic tests from locations set by infrastructure and connectivity providers to simulate performance for users in that location. + :description: Run synthetic tests from locations set by infrastructure and connectivity providers to simulate performance from a range of checkpoints around the world. Public locations are global checkpoints from which you can run synthetic tests to simulate performance for users in that location. diff --git a/synthetics/test-config/syn-downtimes.rst b/synthetics/test-config/syn-downtimes.rst index 0b367dbae..b9e10d419 100644 --- a/synthetics/test-config/syn-downtimes.rst +++ b/synthetics/test-config/syn-downtimes.rst @@ -1,7 +1,7 @@ .. _syn-downtimes: ************************************************************ -Schedule a downtime configuration +Downtime ************************************************************ diff --git a/synthetics/test-config/synth-alerts.rst b/synthetics/test-config/synth-alerts.rst index b1a852ddb..f114187f2 100644 --- a/synthetics/test-config/synth-alerts.rst +++ b/synthetics/test-config/synth-alerts.rst @@ -1,7 +1,7 @@ .. _synth-alerts: ************************************************************ -Set up detectors and alerts in Splunk Synthetic Monitoring +Detectors and alerts ************************************************************ .. meta:: @@ -11,32 +11,68 @@ In Splunk Observability Cloud, detectors monitor your tests and metrics for anom To learn more about advanced alerts and detectors in Splunk Observability Cloud, see :ref:`get-started-detectoralert`. Read on to learn about creating static threshold detectors specific to Synthetics. -Use cases for detectors in Synthetics +Types of detectors in Synthetics ======================================= -You can use detectors to alert on metrics at the test level, or at the page level or synthetic transaction level for Browser tests. The following table provides example use cases for detectors at each of these levels: +In Synthetics, there are detectors to alert on metrics at the test level, at the page level, or at the synthetic transaction level for browser tests. The following table explains each of these detector types: .. list-table:: :header-rows: 1 :widths: 25 75 * - :strong:`Detector type` - - :strong:`Use case` + - :strong:`Description` * - Test-level detectors - - | Create test-level detectors to trigger alerts on metrics that correspond to the entire test. + - | Test-level detectors send alerts on metrics that correspond to an entire test. | - | For example, alert when the count of failed runs, % Uptime, or duration of the entire test exceeds a given threshold. + | Examples: Send an alert when the count of failed runs, % uptime, or duration of the entire test exceeds a given threshold. * - Page-level detectors - - | In Browser tests, create page-level detectors to trigger alerts on metrics corresponding to a single page within a test. For example, alert when the DOM load time, largest contentful paint (LCP), or total image size on a given page exceeds a given threshold. + - | Page-level detectors send alerts on metrics that correspond to a single page within a browser test. + | + | Examples: Send an alert when the DOM load time, largest contentful paint (LCP), or total image size on a given page exceeds a given threshold. | | If you don't scope your alerts to the page level for page-level metrics, the detector monitors the average metric value across pages. See :ref:`page-level-detector` to learn more. * - Transaction-level detectors - - | In Browser tests, create synthetic transaction-level detectors to trigger alerts on metrics based on a synthetic transaction within a test. + - | Synthetic transaction-level detectors send alerts on metrics that correspond to a synthetic transaction within a browser test. | - | You can alert on the three transaction-level metrics that Splunk Synthetic Monitoring captures: Duration, Requests, and Size. See :ref:`transaction-level-detector` to learn more. + | Examples: Send an alert on the three transaction-level metrics that Splunk Synthetic Monitoring captures (duration, requests, and size). See :ref:`transaction-level-detector` to learn more. + + +Best practices for sending an alert when a synthetic test fails +=============================================================== + +You can set up a detector while initially creating or editing a test, or from the results view for a particular test. A detector can track one or more synthetic tests. + +To set up a detector, do one of the following: + +* When creating or editing a test, select :guilabel:`Create detector` to open the detector dialog box. +* From the :guilabel:`Test results` page for a particular test, select :guilabel:`Create detector` to open the detector dialog box. + +In the detector dialog box, enter the following fields: + +#. In the test name list, select the tests you want to include in your detector. Best practice is to select tests that have a similar run length. +#. In the metric list, select :strong:`Uptime`. The uptime metric is 0 when the test fails. +#. In :strong:`+ Add filters` don't add filters for :guilabel:`failed` or :guilabel:`success`. Omit these filters to ensure that the detector sees all datapoints for the test run. + +#. In the :guilabel:`Alert details` section, enter the following: + + * :guilabel:`Trigger threshold`: The threshold to trigger the alert. + * :guilabel:`Orientation`: Whether the metric must fall below or exceed the threshold to trigger the alert. + * :guilabel:`Violates threshold`: How many times the metric must violate the threshold to trigger the alert. + * :guilabel:`Split by location`: Whether to split the detector by test location. If you don't split by location, the detector monitors the average value across all locations. + +#. Use the severity selector to set the severity of the alert. +#. Add recipients. +#. Select :guilabel:`Activate`. + +.. image:: /_images/synthetics/detector-one.png + :width: 100% + :alt: Setting up a detector for failed tests. + +Your detector is now set up to check for failed test runs every minute and to send an alert based on your settings in :guilabel:`Alert details`. .. _synth-detector-setup: diff --git a/synthetics/test-config/test-config.rst b/synthetics/test-config/test-config.rst index e4a8e0089..3b3ca026a 100644 --- a/synthetics/test-config/test-config.rst +++ b/synthetics/test-config/test-config.rst @@ -9,92 +9,19 @@ Advanced test configurations .. toctree:: - synth-alerts built-in-variables + synth-alerts + devices + syn-downtimes global-variables - public-locations private-locations + public-locations rum-synth try-now - syn-downtimes + To simulate diverse types of traffic to your site or application, use a range of configuration options to customize each of your tests. -======================================================================================== -Devices -======================================================================================== - -When you set up a test in Splunk Synthetic Monitoring, you can configure the viewport and network connection of the device from which the test is simulated. - -Because Browser tests capture the visual experience of a page, while Uptime and API tests only capture response data, viewport applies to Browser tests only. Network connection applies to all test types. - ----------------------------------------------------------------------------------------- -Viewport ----------------------------------------------------------------------------------------- -Browser tests in Splunk Synthetic Monitoring capture the visual experience of a user interacting with your application. The viewport is the framed area on a device's screen for viewing information, such as the browser window on a desktop. By default, Browser tests run from a desktop-sized viewport. You can configure tests to run from other viewport sizes to test the user experience from a variety of window sizes and device types. - -When you set up a test, you can choose the viewport size from a list of common devices, or set a custom viewport by height and width. - ----------------------------------------------------------------------------------------- -Network connection ----------------------------------------------------------------------------------------- -You can run Browser, Uptime, or API tests to simulate network connections of various latencies, including Mobile LTE, Mobile 3G, DSL, Mobile 5G, and cable internet. Testing your site from a variety of connection types lets you monitor the experience of users in a variety of settings. - -======================================================================================== -Variables -======================================================================================== -Use variables to fill in fields, provide URLs, and enter other information during your tests. - -.. list-table:: - :header-rows: 1 - :widths: 20 80 - - * - :strong:`Variable type` - - :strong:`Description` - * - Built-in variables - - Built-in variables such as random values, dates and times, or location names, for use in your Browser and API Tests. See :ref:`built-in-variables` to learn more. - * - Global variables - - Pre-saved, reusable variables you can define once and use across all your Browser and API tests. See :ref:`global-variables` to learn more. - -======================================================================================== -Locations -======================================================================================== -Specify locations for your tests to simulate traffic from a range of checkpoints around the world, or use private locations to test sites from within a private network. - -For more, see: - -* :ref:`public-locations` -* :ref:`private-locations` - -.. * See :ref:`private-locations` to set up private locations. - - -======================================================================================== -Test state and current status -======================================================================================== -You can use the play and pause buttons in the more menu (|more|) of your tests to pause or resume data collection. - -The current status of a test is updated every time you load the :guilabel:`Test Overview` page in Splunk Synthetic Monitoring. The following table describes the possible status types for each test. - -.. list-table:: - :header-rows: 1 - :widths: 20, 80 - - * - :strong:`Current status` - - :strong:`Description` - - * - Pending - - Splunk Synthetic Monitoring is still retrieving the status of this test. - - * - Available - - The test is functioning properly. If the test is active, data is being collected at the set interval and can be viewed in the :guilabel:`Test History` page. If the test is paused, it can be unpaused and will resume collecting data. - - * - No Data - - The test isn't currently collecting data. - - * - Failure - - The test encountered a failure. - ======================================================================================== Test naming conventions ======================================================================================== @@ -106,22 +33,6 @@ Choosing informative names for your tests and alerts helps organize content. Her .. image:: /_images/synthetics/ButtercupGames-naming-convention.png :width: 60% - :alt: This image shows two Browser tests with the prefix [ButtercupGames]. - - -================================ -Troubleshoot broken tests -================================ - -See, :ref:`syn-troubleshoot`. + :alt: This image shows two browser tests with the prefix [ButtercupGames]. - -======================================================================================== -Filter tests -======================================================================================== -You can filter by test type, key-value pairs, and more. - -.. image:: /_images/synthetics/syn-filter-test.png - :width: 60% - :alt: This image shows the filter env:prod for all tests on the Synthetic homepage.. diff --git a/synthetics/test-kpis/test-kpis.rst b/synthetics/test-status/test-kpis.rst similarity index 100% rename from synthetics/test-kpis/test-kpis.rst rename to synthetics/test-status/test-kpis.rst diff --git a/synthetics/test-status/test-status.rst b/synthetics/test-status/test-status.rst new file mode 100644 index 000000000..9de75e18c --- /dev/null +++ b/synthetics/test-status/test-status.rst @@ -0,0 +1,50 @@ +.. _test-status: + +*************************************************** +Test status +*************************************************** + +.. meta:: + :description: words + + +.. toctree:: + + test-kpis + +======================================================================================== +Test state and current status +======================================================================================== +You can use the play and pause buttons in the more menu (|more|) of your tests to pause or resume data collection. + +The current status of a test is updated every time you load the :guilabel:`Test Overview` page in Splunk Synthetic Monitoring. The following table describes the possible status types for each test. + +.. list-table:: + :header-rows: 1 + :widths: 20, 80 + + * - :strong:`Current status` + - :strong:`Description` + + * - Pending + - Splunk Synthetic Monitoring is still retrieving the status of this test. + + * - Available + - The test is functioning properly. If the test is active, data is being collected at the set interval and can be viewed in the :guilabel:`Test History` page. If the test is paused, it can be unpaused and will resume collecting data. + + * - No Data + - The test isn't currently collecting data. + + * - Failure + - The test encountered a failure. + + + +======================================================================================== +Filter tests +======================================================================================== +You can filter by test type, key-value pairs, and more. + +.. image:: /_images/synthetics/syn-filter-test.png + :width: 60% + :alt: This image shows the filter env:prod for all tests on the Synthetic homepage.. diff --git a/synthetics/uptime-test/uptime-test.rst b/synthetics/uptime-test/uptime-test.rst index afa21464b..8b7dbe1cc 100644 --- a/synthetics/uptime-test/uptime-test.rst +++ b/synthetics/uptime-test/uptime-test.rst @@ -2,7 +2,7 @@ .. _uptime-test: ************************************************** -Uptime Tests for port and HTTP +Uptime tests for port and HTTP ************************************************** .. meta::