Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 03a051f

Browse files
authored
Merge pull request #1502 from splunk/repo-sync
Pulling refs/heads/main into main
2 parents bd1d631 + 861b4e9 commit 03a051f

File tree

6 files changed

+86
-65
lines changed

6 files changed

+86
-65
lines changed

gdi/opentelemetry/data-processing.rst

Lines changed: 31 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ Process your data with pipelines
55
*********************************************************************
66

77
.. meta::
8-
:description: Learn how to process data collected with the Splunk Distribution of OpenTelemetry Collector.
8+
:description: Learn how to process data collected with the Splunk Distribution of the OpenTelemetry Collector.
99

10-
A pipeline defines the path the ingested data follows in the Collector, starting from reception, then further processing or modification, and finally when data exits the Collector through exporters.
10+
Use pipelines in your Collector's config file to define the path you want your ingested data to follow. Specify which components you want to use, starting from data reception using :ref:`receivers <otel-components-receivers>`, then data processing or modification with :ref:`processors <otel-components-processors>`, until data finally exits the Collector through :ref:`exporters <otel-components-exporters>`. For an overview of all available components and theire behavior refer to :ref:`otel-components`.
1111

1212
Pipelines operate on three data types: logs, traces, and metrics. To learn more about data in Splunk Observability Cloud, see :ref:`data-model`.
1313

@@ -16,13 +16,36 @@ Pipelines operate on three data types: logs, traces, and metrics. To learn more
1616
Define the pipeline
1717
=========================================
1818

19-
The pipeline is constructed during Collector startup based on the pipeline definition. See :ref:`otel-components` to understand the behavior of each component.
19+
The pipeline is constructed during Collector startup based on your Collector's config file.
2020

21-
To define the pipeline, first you need to specify a data type in your pipeline configuration. All the receivers, exporters, and processors you use in a pipeline must support the particular data type, otherwise you'll get the ``ErrDataTypeIsNotSupported`` error message when the configuration is loaded.
21+
See more at:
2222

23-
A pipeline can contain one or more receivers. Data from all receivers is pushed to the first processor, which performs processing on it and then pushes it to the next processor and so on until the last processor in the pipeline pushes the data to the exporters. Each exporter gets a copy of each data element. The last processor uses a data fan-out connector to fan out (distribute) the data to multiple exporters.
23+
* :ref:`Collector for Kubernetes <collector-kubernetes-intro>`
24+
* :ref:`Collector for Linux <collector-linux-intro>`
25+
* :ref:`Collector for Windows <collector-windows-intro>`
2426

25-
You can also use connectors to connect two pipelines: it consumes data as an exporter at the end of one pipeline and emits data as a receiver at the start of another pipeline. It may consume and emit data of the same data type, or of different data types. A connector may generate and emit data to summarize the consumed data, or it may simply replicate or route data. Learn more at:ref:`otel-components-connectors`.
27+
The following applies:
28+
29+
* You need to specify a data type in your pipeline configuration. All the receivers, exporters, and processors you use in a pipeline must support the particular data type, otherwise you'll get the ``ErrDataTypeIsNotSupported`` error message when the configuration is loaded.
30+
31+
* A pipeline can contain one or more receivers.
32+
33+
* Data from all receivers is pushed to the first processor, which performs processing on it and then pushes it to the next processor and so on until the last processor in the pipeline uses a data fan-out connector to fan out (distribute) the data to multiple exporters.
34+
35+
* Note that some types of processor "mutate" (duplicate) data before they pass it on to the next processor.
36+
37+
* If a pipeline uses more than one exporter, each exporter receives a copy of each data element from the last processor.
38+
39+
* In case of failure, the rest of exporters continue to work independently.
40+
41+
* You can configure exporters to "mutate" (duplicate) the data they receive. In the Splunk OTel Collector this option is not enabled.
42+
43+
Connect pipelines with connectors
44+
--------------------------------------------------------------------
45+
46+
You can use connectors to connect two pipelines. Connectors consume data as an exporter at the end of one pipeline and emit data as a receiver at the start of another pipeline. They can consume and emit data of the same data type, or of different data types. Use connectors to generate and emit data which summarizes the data you've already consumed, or to simply replicate or route data.
47+
48+
Learn more at:ref:`otel-components-connectors`.
2649

2750
Example of a pipeline configuration
2851
--------------------------------------------------------------------
@@ -40,7 +63,7 @@ A pipeline configuration typically looks like this:
4063
processors: [memory_limiter, batch]
4164
exporters: [otlp, splunk_hec, jaeger, zipkin]
4265
43-
This example defines a pipeline for ``traces``, with three receivers, two processors, and four exporters. The following table describes the receivers, processors, and exporters used in this example. For more details, see :ref:`Collector components <otel-components>`.
66+
This example defines a pipeline for ``traces``, with three receivers, two processors, and four exporters. The following table describes the receivers, processors, and exporters used in this example.
4467

4568
.. list-table::
4669
:widths: 25 50 25
@@ -80,37 +103,7 @@ This example defines a pipeline for ``traces``, with three receivers, two proces
80103
Metadata transformations
81104
============================================
82105

83-
Metadata refers to the name/value pair added to telemetry data. OpenTelemetry calls this ``Attributes`` on ``Spans``, ``Labels`` on ``Metrics``, and ``Fields`` on ``Logs``. See :new-page:`Resource SDK <https://github.com/open-telemetry/opentelemetry-specification/blob/49c2f56f3c0468ceb2b69518bcadadd96e0a5a8b/specification/resource/sdk.md>`, :new-page:`Metrics API <https://github.com/open-telemetry/opentelemetry-specification/blob/49c2f56f3c0468ceb2b69518bcadadd96e0a5a8b/specification/metrics/api.md>`, and :new-page:`Trace Semantic Conventions <https://github.com/open-telemetry/opentelemetry-specification/blob/52cc12879e8c2d372c5200c00d4574fa73996369/specification/trace/semantic_conventions/README.md>` in GitHub for additional details.
84-
85-
Attributes
86-
--------------------------
87-
88-
Attributes are a list of zero or more key-value pairs. An attribute must have the following properties:
89-
90-
* The attribute key, which must be a non-null and non-empty string.
91-
* The attribute value, which is one of these types:
92-
93-
* A primitive type: string, boolean, double precision floating point (IEEE 754-1985) or signed 64-bit integer.
94-
* An array of primitive type values. The array must be homogeneous. That is, it must not contain values of different types. For protocols that do not natively support array values, represent those values as JSON strings.
95-
96-
Attribute values expressing a numerical value of zero, an empty string, or an empty array are considered meaningful and must be stored and passed on to processors or exporters.
97-
98-
Attribute values of ``null`` are not valid and attempting to set a ``null`` value is undefined behavior.
99-
100-
``null`` values are not allowed in arrays. However, if it is impossible to make sure that no ``null`` values are accepted (for example, in languages that do not have appropriate compile-time type checking), ``null`` values within arrays MUST be preserved as-is (that is, passed on to processors or exporters as ``null``). If exporters do not support exporting ``null`` values, you can replace those values by 0, ``false``, or empty strings. Changing these values is required for map and dictionary structures represented as two arrays with indices that are kept in sync (for example, two attributes ``header_keys`` and ``header_values``, both containing an array of strings to represent a mapping ``header_keys[i] -> header_values[i]``).
101-
102-
Labels
103-
-----------------------------------------
104-
105-
Labels are name/value pairs added to metric data points. Labels are deprecated from the OpenTelemetry specification. Use attributes instead of labels.
106-
107-
Fields
108-
---------------------------------------
109-
110-
Fields are name/value pairs added to log records. Each record contains two kinds of fields:
111-
112-
* Named top-level fields of specific type and meaning.
113-
* Fields stored as ``map<string, any>``, which can contain arbitrary values of different types. The keys and values for well-known fields follow semantic conventions for key names and possible values that allow all parties that work with the field to have the same interpretation of the data.
106+
Metadata refers to the name/value pair added to telemetry data. Learn more at :ref:`otel-tags`.
114107

115108
.. _pipelines-next:
116109

gdi/opentelemetry/opentelemetry.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ Splunk Observability Cloud offers a guided setup to install the Collector:
238238
<h3>Advanced install<a name="collector-intro-install" class="headerlink" href="#collector-intro-install" title="Permalink to this headline">¶</a></h3>
239239
</embed>
240240

241-
The Splunk distribution of the OpenTelemetry Collector is supported on and packaged for a variety of platforms, including:
241+
The Splunk Distribution of the OpenTelemetry Collector is supported on and packaged for a variety of platforms, including:
242242

243243
* :ref:`Collector for Kubernetes <collector-kubernetes-intro>`
244244
* :ref:`Collector for Linux <collector-linux-intro>`

gdi/opentelemetry/tags.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Use tags or attributes in OpenTelemetry
55
*******************************************************
66

77
.. meta::
8-
:description: Add tags to your Splunk Distribution of OpenTelemetry Collector configuration. You can include span tags in settings for the batch processor in your configuration YAML file.
8+
:description: Add tags to your Splunk Distribution of the OpenTelemetry Collector configuration. You can include span tags in settings for the batch processor in your configuration YAML file.
99

1010
Tags are key-value pairs of data associated with recorded measurements to provide contextual information, distinguish, and group metrics during analysis and inspection.
1111

@@ -162,3 +162,11 @@ For example, suppose your application sends in data for a metric named ``custom.
162162

163163
Splunk Observability Cloud provides a report that allows for management of metrics usage, and you can create rules to drop undesirable dimensions. See more at :ref:`subscription-overview`.
164164

165+
Learn more
166+
------------------------------------------------------------
167+
168+
For additional details see the following resources in GitHub:
169+
170+
* :new-page:`Resource SDK <https://github.com/open-telemetry/opentelemetry-specification/blob/49c2f56f3c0468ceb2b69518bcadadd96e0a5a8b/specification/resource/sdk.md>`
171+
* :new-page:`Metrics API <https://github.com/open-telemetry/opentelemetry-specification/blob/49c2f56f3c0468ceb2b69518bcadadd96e0a5a8b/specification/metrics/api.md>`
172+
* :new-page:`Trace Semantic Conventions <https://github.com/open-telemetry/opentelemetry-specification/blob/52cc12879e8c2d372c5200c00d4574fa73996369/specification/trace/semantic_conventions/README.md>`

splunkplatform/unified-id/unified-identity.rst

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,41 @@ When you integrate your Splunk Cloud Platform and Splunk Observability Cloud ins
2121
Who can access Single Sign On (SSO) and the benefits of Unified Identity?
2222
==========================================================================================
2323

24-
All customers who have both Splunk Cloud Platform and Splunk Observability Cloud can access Unified Identity. Users must be on Splunk Cloud Platform version 9.x and higher. The AWS region for your Splunk Cloud Platform instance must be the same as your Splunk Observability Cloud instance realm. Unified Identity is not supported in GovCloud regions.
24+
All customers who have both Splunk Cloud Platform and Splunk Observability Cloud can access Unified Identity. Users must be on Splunk Cloud Platform version 9.x and higher. The AWS or GCP region for your Splunk Cloud Platform instance must map to your Splunk Observability Cloud instance realm as shown in the following table:
25+
26+
.. list-table::
27+
:header-rows: 1
28+
:width: 100%
29+
30+
* - :strong:`Splunk Observability Cloud realm`
31+
- :strong:`AWS Region`
32+
- :strong:`GCP Region`
33+
* - us0
34+
- AWS US East Virginia (us-east-1)
35+
-
36+
* - us1
37+
- AWS US West Oregon (us-west-2)
38+
-
39+
* - us2
40+
-
41+
- GCP US Oregon (us-west-1)
42+
* - eu0
43+
- AWS EU Dublin (eu-west-1)
44+
-
45+
* - eu1
46+
- AWS EU Frankfurt (eu-central-1)
47+
-
48+
* - eu2
49+
- AWS EU London (eu-west-2)
50+
-
51+
* - au0
52+
- AWS AP Sydney (ap-southeast-2)
53+
-
54+
* - jp0
55+
- AWS AP Tokyo (ap-northeast-1)
56+
-
57+
58+
.. note:: Unified Identity is not supported in GovCloud regions.
2559

2660

2761
.. _unified-identity-benefits:

synthetics/browser-test/set-up-browser-test.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -472,9 +472,11 @@ The following image shows how to configure a test to go to a URL, wait for 10 se
472472
.. image:: /_images/synthetics/wait-times-example.png
473473
:alt: This image shows a browser test with three steps: go to url, wait 20 seconds, then log in.
474474

475+
.. _configurable-wait-times:
475476

476-
Limits and defaults for configurable wait times
477+
Limits and defaults for configurable wait times
477478
------------------------------------------------------
479+
478480
Here are the limits for each type of wait time. The maximum limit for a run is 30 minutes, after which it times out.
479481

480482

synthetics/browser-test/set-up-transactional-browser-test.rst

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ A step doesn't generate its own dedicated metrics, but it counts toward the metr
4646

4747
Types of steps you can include in your Browser Tests
4848
-----------------------------------------------------------
49-
The following table describes the types of steps you can include:
49+
Assertions are checks to see what state an object exists in, for example if text is present or an element is visible.
50+
The following table describes the types of steps you can include for actions:
5051

5152
.. list-table::
5253
:header-rows: 1
@@ -58,15 +59,15 @@ The following table describes the types of steps you can include:
5859
* - Accept alert
5960
- Accept an alert that appears on the page.
6061

61-
* - Dismiss alert
62-
- Dismiss an alert that appears on the page.
63-
6462
* - Clear
6563
- Clear an element you identify under :guilabel:`Selector`. Optionally, wait for navigation.
6664

6765
* - Click
6866
- Click on an element you identify under :guilabel:`Selector`. Optionally, wait for navigation.
6967

68+
* - Dismiss alert
69+
- Dismiss an alert that appears on the page.
70+
7071
* - Fill in field
7172
- Fill a field you identify under :guilabel:`Selector` with a value you provide under :guilabel:`Value`. Optionally, wait for navigation. For security and reusability, use a built-in, custom, or global variable to provide the value. See :ref:`global-variables` to learn more.
7273

@@ -88,26 +89,9 @@ The following table describes the types of steps you can include:
8889
* - Switch to main
8990
- Switch focus back to the main frame of the webpage.
9091

91-
* - Wait for text present
92-
- Wait until the text identified in the key-value pair under :guilabel:`Value` appears on the webpage.
93-
94-
* - Wait for text present
95-
- Wait until the text identified in the key-value pair under :guilabel:`Value` appears on the webpage.
96-
97-
* - Wait for text not present
98-
- Wait until the text identified in the key-value pair under :guilabel:`Value` is not present on the webpage.
99-
100-
* - Wait for element present
101-
- Wait until the element you identify under :guilabel:`Selector` is present on the webpage.
102-
103-
* - Wait for element not present
104-
- Wait until the element you identify under :guilabel:`Selector` is not present on the webpage.
105-
106-
* - Wait for element visible
107-
- Wait until the element you identify under :guilabel:`Selector` is visible on the webpage.
92+
* - Wait
93+
- Wait a certain number of minutes. See, :ref:`configurable-wait-times`.
10894

109-
* - Wait for element not visible
110-
- Wait until the element you identify under :guilabel:`Selector` is not visible on the webpage.
11195

11296

11397

0 commit comments

Comments
 (0)