Skip to content

Commit 6548dff

Browse files
Merge pull request splunk#1633 from splunk/repo-sync
Pulling refs/heads/main into main
2 parents bba7664 + b16a2fa commit 6548dff

37 files changed

+429
-460
lines changed
145 KB
Loading

_templates/layout.html

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -179,10 +179,12 @@ <h2 style="font-size:21px;font-family: 'Open Sans'; font-weight: bold;">Was this
179179
</p>
180180
</div>
181181
<div id="splunk_oly_helpful_completed" class="well">
182-
<em>Feedback submitted, thanks!</em>
182+
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>
183+
184+
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>.
183185
<div class="admonition note">
184-
<p class="admonition-title"></p>
185-
Did you know that you can edit this page? <a href="https://docs.splunk.com/Observability/get-started/contribute.html">Learn how!</a>
186+
<p class="admonition-title"></p>
187+
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!
186188
</div>
187189
</div>
188190
</div>

apm/set-up-apm/environments.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,20 @@ The :new-page:`Splunk Distribution of OpenTelemetry Collector agent config file
6161
6262
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.
6363

64+
The ``resource/add_environment`` resorce can be then added to any pipeline of the ``service`` section of your configuration file. See
65+
:ref:`Sample configurations <sample_configurations>` for more examples.
66+
67+
.. code-block:: yaml
68+
69+
service:
70+
pipelines:
71+
metrics:
72+
processors: [resource/add_environment]
73+
logs:
74+
processors: [resource/add_environment]
75+
traces:
76+
processors: [resource/add_environment]
77+
6478
To learn more about how to add span tags via the Splunk Distribution of OpenTelemetry Collector, see :ref:`otel-span-tags`.
6579

6680
Alert on specific environments

conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@
162162
# An RST epilog to add variable names for feature text replacement, and non-breaking space.
163163

164164
rst_epilog = """
165-
.. |ms| replace:: Metrics Sidebar
165+
.. |ms| replace:: metrics sidebar
166166
.. |mtab| replace:: Muting Rules tab
167167
.. |sn| replace:: ServiceNow
168168
.. |sv| replace:: secondary visualization

data-visualization/charts/chart-builder.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Plot metrics and events using chart builder in Splunk Observability Cloud
99

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

12-
.. 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`.
12+
.. 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`.
1313

1414
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`).
1515

@@ -47,14 +47,14 @@ If your metrics follow the naming conventions for Graphite metrics, see :ref:`gr
4747

4848
.. _find-metric:
4949

50-
Use the Metrics Sidebar to find a metric
50+
Use the metrics sidebar to find a metric
5151
-------------------------------------------------------------------
5252

53-
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.
53+
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.
5454

55-
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.
55+
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.
5656

57-
For information about how to use the :strong:`Find Events` option, see :ref:`chart-events-as-occur`.
57+
For information about how to use the :strong:`Find events` option, see :ref:`chart-events-as-occur`.
5858

5959

6060
.. _expression:
@@ -234,9 +234,9 @@ For background information on events, see :ref:`events-intro`.
234234
Display events as they occur
235235
-------------------------------------------------------------------
236236

237-
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.
237+
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.
238238

239-
.. 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.
239+
.. 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.
240240

241241

242242
.. _event-markers:
@@ -716,7 +716,7 @@ For example, for a regular wildcard query, :code:`jvm.*` returns anything that s
716716

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

719-
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.
719+
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.
720720

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

data-visualization/charts/chart-options.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _chart-options-tab:
22

33
*****************************************************************
4-
Chart Options in the Chart Builder
4+
Chart options in the Chart Builder
55
*****************************************************************
66

77

data-visualization/charts/chart-types.rst

Lines changed: 2 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,6 @@ Chart types in Splunk Observability Cloud
88
.. meta::
99
:description: Learn about different chart types and when to use each chart type in Splunk Observability Cloud
1010

11-
.. _charts-overview:
12-
13-
Overview
14-
====================
15-
1611
Charts in Splunk Observability Cloud are components of a dashboard. Each chart type provides a different way to represent your data:
1712

1813
- :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.
10398
.. image:: /_images/data-visualization/charts/list-chart.png
10499
:alt: This screenshot shows a list chart illustrating the number of active hosts per AWS EC2 instance type.
105100

106-
Sorting list charts
101+
Sort list charts
107102
-------------------
108103

109-
The API lets you sort values in list charts by specifying the ``options.sortBy`` property in the request to create or update a chart.
110-
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:
111-
112-
.. list-table::
113-
:header-rows: 1
114-
:widths: 10 40 50
115-
116-
* - :strong:`Keyword`
117-
- :strong:`Alias in the user interface`
118-
- :strong:`Description`
119-
120-
* - ``<dimension-name>``
121-
- Dimension name
122-
- One of the dimensions of the displayed MTS. To see the available dimensions, follow the instructions following this table.
123-
124-
* - ``sf_metric``
125-
- Plot name
126-
- 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.
127-
128-
* - ``sf_originatingMetric``
129-
- Metric
130-
- Name of the metric for the displayed MTS.
131-
132-
* - ``value``
133-
- Value
134-
- Value of the data point when Splunk Observability Cloud receives it.
135-
136-
In addition, you can sort by any dimension of an MTS displayed in the chart.
137-
138-
To see a list of entities on which you can sort:
139-
140-
#. In the user interface, open the chart.
141-
#. Select the :strong:`Chart options` tab.
142-
#. 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.
143-
144-
145-
146-
Examples
147-
++++++++++
148-
149-
To sort a list chart by value, specify the following in the request body:
150-
151-
.. code-block::
152-
153-
{
154-
options: {
155-
"sortBy": "value",
156-
...
157-
}
158-
}
159-
160-
161-
To sort by plot name, specify the following:
162-
163-
.. code-block::
164-
165-
{
166-
options: {
167-
"sortBy": "sf_metric",
168-
...
169-
}
170-
}
171-
172-
To sort by the dimension ``demo_datacenter``, specify the following:
173-
174-
.. code-block::
175-
176-
{
177-
options: {
178-
"sortBy": "demo_datacenter",
179-
...
180-
}
181-
}
182-
183-
184-
.. note::
185-
Splunk Observability Cloud doesn't guarantee the sort order of identical values in the input stream.
104+
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`.
186105

187106
List chart prefix and suffix
188107
----------------------------

data-visualization/charts/charts.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ Charts in Splunk Observability Cloud
1111
:hidden:
1212

1313
Chart types<chart-types>
14-
Create simple charts <simple-charts-dashboards>
1514
Create charts<create-charts>
1615
data-resolution-and-rollups
1716
Plot metrics and events using Chart Builder<chart-builder>
@@ -29,7 +28,6 @@ Charts can range from extremely simple (monitor a single metric for a single hos
2928
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.
3029

3130
- :ref:`chart-types`
32-
- :ref:`Create simple charts <simple-charts-dashboards>`
3331
- :ref:`create-charts`
3432
- :ref:`data-resolution-rollups-charts`
3533
- :ref:`Plot metrics and events using Chart Builder <chart-builder>`

0 commit comments

Comments
 (0)