Skip to content

Commit

Permalink
Merge pull request #1633 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 Jan 3, 2025
2 parents bba7664 + b16a2fa commit 6548dff
Show file tree
Hide file tree
Showing 37 changed files with 429 additions and 460 deletions.
Binary file added _images/synthetics/detector-one.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 5 additions & 3 deletions _templates/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,10 +179,12 @@ <h2 style="font-size:21px;font-family: 'Open Sans'; font-weight: bold;">Was this
</p>
</div>
<div id="splunk_oly_helpful_completed" class="well">
<em>Feedback submitted, thanks!</em>
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.<br><br>

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 <a href="https://login.splunk.com/page/sso_redirect?type=portal">https://login.splunk.com/page/sso_redirect?type=portal</a>.
<div class="admonition note">
<p class="admonition-title"></p>
Did you know that you can edit this page? <a href="https://docs.splunk.com/Observability/get-started/contribute.html">Learn how!</a>
<p class="admonition-title"></p>
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!
</div>
</div>
</div>
Expand Down
14 changes: 14 additions & 0 deletions apm/set-up-apm/environments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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
Expand Down
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 8 additions & 8 deletions data-visualization/charts/chart-builder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`).

Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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<specify-signal>`. The only real difference is that if you :ref:`use the Metrics Sidebar <use-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<specify-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:
Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion data-visualization/charts/chart-options.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _chart-options-tab:

*****************************************************************
Chart Options in the Chart Builder
Chart options in the Chart Builder
*****************************************************************


Expand Down
85 changes: 2 additions & 83 deletions data-visualization/charts/chart-types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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>``
- 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 <https://dev.splunk.com/observability/docs/chartsdashboards/charts_overview#Sort-a-list-chart>` section in the `Splunk Observability Cloud Developer Guide`.

List chart prefix and suffix
----------------------------
Expand Down
2 changes: 0 additions & 2 deletions data-visualization/charts/charts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ Charts in Splunk Observability Cloud
:hidden:

Chart types<chart-types>
Create simple charts <simple-charts-dashboards>
Create charts<create-charts>
data-resolution-and-rollups
Plot metrics and events using Chart Builder<chart-builder>
Expand All @@ -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 <simple-charts-dashboards>`
- :ref:`create-charts`
- :ref:`data-resolution-rollups-charts`
- :ref:`Plot metrics and events using Chart Builder <chart-builder>`
Expand Down
Loading

0 comments on commit 6548dff

Please sign in to comment.