Skip to content

Commit

Permalink
Merge pull request #1621 from splunk/repo-sync
Browse files Browse the repository at this point in the history
Pulling refs/heads/main into main
  • Loading branch information
aurbiztondo-splunk authored Nov 29, 2024
2 parents 9d136a9 + 80cfc30 commit 0c03ddd
Show file tree
Hide file tree
Showing 11 changed files with 225 additions and 363 deletions.
6 changes: 3 additions & 3 deletions data-visualization/charts/chart-builder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ Visibility of plot lines

Click the eye icon on the far left of the plot line to show or hide the plot line on the chart. This option is not available for text charts and event feeds. In all chart types except heatmap, multiple plot lines can be displayed.

.. note:: In the :ref:`single-value-chart-type`, if multiple plots are visible, the value on the chart reflects the first visible plot in the plot list.
.. note:: In a single value chart, if multiple plots are visible, the value on the chart reflects the first visible plot in the plot list.

To hide all plot lines except one, alt-click (or option-click) the eye icon for the plot line you want to display. This can be useful when a chart contains multiple plots and you need to focus on just one. To return to the previous view, alt-click the eye icon again for the visible plot line.

Expand Down Expand Up @@ -402,7 +402,7 @@ A number displayed on a chart could be anything from a raw number (such as bits

All display units are shown when you take any of the following actions:

- View a :ref:`single-value<single-value-chart-type>` or :ref:`list chart<list-chart-type>`
- View a :ref:`single value<single-value-charts>` or :ref:`list chart<list-charts>`

- Look at values in the :ref:`data table<data-table>` for a chart

Expand Down Expand Up @@ -436,7 +436,7 @@ It can sometimes be useful to apply the :ref:`Scale<scale>` analytics function w
Visualization type
-------------------------------------------------------------------

For :ref:`graphs<graph-chart-type>`, plots default to a visualization style selected for the chart as a whole, such as line, area, column, or histogram. For example, new plots created on a column chart appear initially as additional columns. However, you can change this setting so a plot uses a different chart display type than the chart default.
For :ref:`graph charts<graph-charts>`, plots default to a visualization style selected for the chart as a whole, such as line, area, column, or histogram. For example, new plots created on a column chart appear initially as additional columns. However, you can change this setting so a plot uses a different chart display type than the chart default.

For example, if the chart is an area chart, you can choose to display one of its plots as a line.

Expand Down
4 changes: 2 additions & 2 deletions data-visualization/charts/chart-options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ In the following illustration, the border on the left indicates that value is or
Color theme
=============================================================================

Use this option to specify the color family to use when you populate a histogram chart. To learn more, see :ref:`graph-chart-type`. The color you select represents the darkest value on the chart; other values are shown with progressively less saturation.
Use this option to specify the color family to use when you populate a histogram chart. To learn more, see :ref:`histogram-charts`. The color you select represents the darkest value on the chart; other values are shown with progressively less saturation.

Similar options are available for heatmap charts (see :ref:`color-threshold`) and for single value and list charts. To learn more, see :ref:`color-value`.

Expand Down Expand Up @@ -499,7 +499,7 @@ This option lets you specify whether Y-axis values are shown in decimal units (1
Visualization type
=============================================================================

See :ref:`choose-chart-type`.
See :ref:`chart-types`.

.. _chart-option-compatibility-matrix:

Expand Down
279 changes: 167 additions & 112 deletions data-visualization/charts/chart-types.rst

Large diffs are not rendered by default.

190 changes: 2 additions & 188 deletions data-visualization/charts/create-charts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,200 +118,14 @@ 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.

To learn more about different chart types, see :ref:`chart-types`.

See the following sections for more information on when to use each type of chart:

- :ref:`graph-chart-type`.

- :ref:`list-chart-type`.

- :ref:`single-value-chart-type`.

- :ref:`heatmap-chart-type`.

- :ref:`event-feed-chart-type`.

- :ref:`text-chart-type`.

- :ref:`table-chart-type`.
To learn more about different chart types, see :ref:`chart-types`.

.. note::

In some cases, you might want to create multiple charts for the same data displayed in different ways. One way to do that is to copy a chart then change the chart type after you paste it from the clipboard. Another way is to change the chart type and then use :guilabel:`Save as` to save it as a new chart, preferably with a new name. See :ref:`copy-charts` for more information.

.. _graph-chart-type:

Use graph charts
----------------

Use graph charts when you want to display data points over a period of time. To learn more about graph charts, see :ref:`graph-charts`.

The first four icons in the chart's title bar represent the four visualization options for graph charts:

- Line: To learn more about line visualization, see :ref:`line-charts`.

.. image:: /_images/data-visualization/charts/line-chart.png
:alt: This screenshot shows a line chart illustrating the CPU percentages used for a set of AWS EC2 instances.

- Area: To learn more about area visualization, see :ref:`area-charts`.

.. image:: /_images/data-visualization/charts/area-chart.png
:alt: This screenshot shows an area chart illustrating the CPU percentages used for a set of AWS EC2 instances.

- Column: To learn more about column visualization, see :ref:`column-charts`.

.. image:: /_images/data-visualization/charts/column-chart.png
:alt: This screenshot shows a column chart illustrating CPU percentages used for a set of AWS EC2 instances.

- Histogram: To learn more about histogram visualization, see :ref:`histogram-charts`.

.. image:: /_images/data-visualization/charts/histogram-chart.png
:alt: This screenshot shows a histogram chart illustrating CPU percentages used for a set of AWS EC2 instances.

The chart type you choose here is applied as a default to all the plots on the chart, but you can choose a different visualization type for individual plots. See :ref:`plot-config-panel`.

To customize a chart, see :ref:`chart-options-tab`.

.. _single-value-chart-type:

Use single value charts
-----------------------

Choose this chart type when you want to see a single number in a large font that represents the current value of a single data point on a plot line. If the time period is in the past, the number represents the value of the metric near the end of the time period.

.. image:: /_images/data-visualization/charts/single-value-chart.png
:width: 50%
:alt: This screenshot shows a single value chart illustrating the number of hosts with the Splunk Distribution of OpenTelemetry Collector installed.

.. caution::

To display an accurate value, the plot must use an aggregate analytics function that generates a single value for each data point on the chart, such as Mean, Sum, Max, and so on. If the plot line always reflects only a single time series, no analytics function is needed. However, this is uncommon.

If the plot line on the chart shows multiple values, that is one line per metric time series (MTS) when viewed as a line chart, the single number displayed on the chart might represent any of the values for a given point in time.


.. note::

If multiple plots are marked as visible, the value represents the first visible plot in the list. For example, if plots |nbsp| A and |nbsp| B are visible, the value represents plot |nbsp| A. If you hide plot |nbsp| A, the value represents plot |nbsp| B.

To learn more about single value charts, see :ref:`single-value-charts`.

To customize a chart, see :ref:`chart-options-tab`. An especially useful option for this chart type is :ref:`color-value`, which lets you use different colors to represent different value ranges.

.. _heatmap-chart-type:

Use heatmap charts
------------------

Use heatmap charts when you want to see the specified plot in a format similar to the navigator view in Infrastructure Monitoring, with squares representing each source for the selected metric, and the color of each square representing the value range of the metric.

.. image:: /_images/data-visualization/charts/heatmap-chart.png
:alt: This screenshot shows a heatmap chart illustrating the CPU capacity used by each node in a Kubernetes cluster.

To learn more about heatmap charts, see :ref:`heatmap-charts`.

To customize a chart, see :ref:`chart-options-tab`.


.. _list-chart-type:

Use list charts
---------------

Use this chart type to display current data values in a list format. By default, the name of each value in the chart reflects the name of the plot and any associated analytics. To avoid having the raw metric name displayed on the chart, give the plot a meaningful name.

.. 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.

To learn more about list charts, see :ref:`list-charts`.

To customize the information shown in the list, see :ref:`chart-options-tab`.


.. _event-feed-chart-type:

Use event feed charts
---------------------

Use this chart type when you want to see a list of events on your dashboard.

.. image:: /_images/data-visualization/charts/event-feed-chart.png
:alt: This screenshot shows an event feed chart illustrating a series of cleared, critical, and custom events.

To learn more about event feed charts, see :ref:`event-feed-charts`.

To customize the information shown in the feed, see :ref:`dashboard-event-feed`.


.. _text-chart-type:

Use text charts
---------------

Use text charts when you want to place a text note on the dashboard instead of displaying metrics.

.. image:: /_images/data-visualization/charts/text-chart.png
:width: 50%
:alt: This screenshot shows a text chart illustrating how you can this chart type to provide relevant instructional text on a dashboard.

To learn more about text charts, see :ref:`text-charts`.

See also :ref:`text-note`.


.. _table-chart-type:

Use table charts
------------------------------

A table chart displays metrics and dimensions in table format. Each metric name and dimension key displays as a column. Each output metric time series displays as a row. If there are multiple values for a cell, each time series displays in a separate row.

.. image:: /_images/data-visualization/charts/table-chart.png
:alt: This screenshot shows a table chart grouped by the demo_host dimension, sorted by the demo_customer dimension, and linked to a detector with no alerts as illustrated by a green border around the table chart.

You can group metric time series rows by a dimension. To do this, select the :strong:`Group by` menu and select the dimension you want to group the rows by. The selected dimension's column becomes the first column and each row of the table displays to represent one value of the dimension.

For example, group the table by the :code:`host` dimension to display the health and status of each host in your environment.

If you choose to group by a dimension column that you've hidden, the column displays to accomplish the requested grouping.

After using the :strong:`Group by` option to group the table, there might still be more than one row per dimension value. This can happen if there are multiple values for a column per grouping dimension value. To resolve this, you can apply aggregation analytics to plots.

For more information about aggregation, see :ref:`aggregations-transformations`.

If there are missing data values for a table cell, the cell displays no value.

Here are some additional ways in which you can customize a table chart to best visualize your data:

- Reorder a dimension column

Select and drag the column header to move the column to its new position. You can't reorder metric columns.

- Show or hide a column

- In graphical Plot Editor view, select the gear icon near the upper right of the table. In the :strong:`SHOW/HIDE COLUMNS` section, select the column name to switch between showing and hiding the column.

- In SignalFlow Plot Editor view:

- To hide a metric column, comment it out by adding a :code:`#` to the start of the metric's line of SignalFlow code. Alternatively, you can remove the metric.

- To show or hide a dimension column, select the gear icon near the upper right of the table. In the :strong:`SHOW/HIDE COLUMNS` section, select the dimension column name to switch between showing and hiding the column.

- Sort table values

Select a column header to switch between sorting by ascending and descending order. An arrow icon displays in the column header to indicate the sort order.

- Link a detector to the table chart

Select the :strong:`Alerts` icon (bell) near the upper right of the Chart Builder. Select :strong:`Link detector` to link the table chart to an existing detector. Select :strong:`New Detector From Chart` to create a new detector to link the table chart to.

For more information about creating a new detector from a chart, see :ref:`create-detector-from-chart`.

A chart that is linked to a detector displays with a border color that corresponds to the alert status of the linked detector. For example, if there are no alerts issued by the detector, the chart displays with a green border. The chart displays alerts in the chart header, but doesn't display alert status per row.

For more information about customizing charts, see :ref:`chart-options-tab`.

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
============
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Automatic discovery for Kubernetes
************************************************************************

.. meta::
:description: Get started with automatic discovery and instrumentation for Kubernetes environments. Deploy automatic discovery and instrumentation to automatically find services and applications running in your environment and send data from them to Splunk Observability Cloud.
:description: Get started with automatic discovery and zero-code instrumentation for Kubernetes environments. Deploy automatic discovery and zero-code instrumentation to automatically find services and applications running in your environment and send data from them to Splunk Observability Cloud.

.. toctree::
:hidden:
Expand All @@ -25,4 +25,4 @@ To enable the Collector's zero-code instrumentation of back-end applications wri

To use the Collector's automatic discovery of third-party applications in Kubernetes environments see :ref:`k8s-third-party`. With this option you'll only have to reuse a config file automatically generated by the Collector.

For a walkthrough of how to use automatic instrumentation to instrument an application in a Kubernetes environment, see :ref:`k8s-advanced-auto-discovery-config`.
For a walkthrough of how to use automatic discovery and zero-code instrumentation to monitor an application in a Kubernetes environment, see :ref:`k8s-advanced-auto-discovery-config`.
2 changes: 1 addition & 1 deletion gdi/opentelemetry/automatic-discovery/discovery-linux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Automatic discovery for Linux
************************************************************************

.. meta::
:description: Get started with automatic discovery and instrumentation for Linux environments. Deploy automatic discovery and instrumentation to automatically find services and applications running in your Linux environment and send data from them to Splunk Observability Cloud.
:description: Get started with automatic discovery and zero-code instrumentation for Linux environments. Deploy automatic discovery and zero-code instrumentation to automatically find services and applications running in your Linux environment and send data from them to Splunk Observability Cloud.

.. toctree::
:hidden:
Expand Down
4 changes: 2 additions & 2 deletions gdi/opentelemetry/automatic-discovery/discovery-windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Automatic discovery for Windows
************************************************************************

.. meta::
:description: Get started with automatic instrumentation for Windows environments. Deploy automatic instrumentation to automatically find applications running in your Windows environment and send data from them to Splunk Observability Cloud.
:description: Get started with automatic discovery for Windows environments. Deploy zero-code instrumentation to automatically find applications running in your Windows environment and send data from them to Splunk Observability Cloud.

.. toctree::
:hidden:
Expand All @@ -18,6 +18,6 @@ Automatic discovery for Windows

<h2>Get started</h2>

The Collector for Windows does not support automatic discovery of services.
The Collector for Windows does not support automatic discovery of third-party services.

To enable the Collector's zero-code instrumentation of back-end applications written in .NET see :ref:`windows-backend-auto-discovery`. With this option you won't have to install and configure your instrumentation agents separately.
Loading

0 comments on commit 0c03ddd

Please sign in to comment.