Skip to content

Commit 2edce8f

Browse files
Merge pull request splunk#1735 from splunk/repo-sync
Pulling refs/heads/main into main
2 parents 4bb93dc + e660966 commit 2edce8f

File tree

11 files changed

+130
-42
lines changed

11 files changed

+130
-42
lines changed

admin/authentication/authentication-tokens/org-tokens.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -201,8 +201,6 @@ To finish creating the token, select an expiration date for the token.
201201

202202
* :menuselection:`Only admins can receive alert`: Only admins receive an alert when the token is close to its expiration date.
203203
* :menuselection:`Admins and users or teams with token permissions can receive alert`: Admins and any users with token permissions receive an alert when the token is close to its expiration date.
204-
205-
#. (Optional) Set a time for when Splunk Observability Cloud sends an expiration alert. For example, a value of 7 days means Splunk Observability Cloud will send an alert 7 days before the token expires.
206204
#. Select :guilabel:`Create` to finish creating the new token.
207205

208206
.. _access-token-rotate:
@@ -299,4 +297,4 @@ To change limits for your access tokens, including host and container limits, fo
299297
#. Select the token actions menu (|verticaldots|), and select :guilabel:`Manage limits`.
300298
#. In the :guilabel:`Manage limits` menu, add the new token limits.
301299

302-
To learn more about token limits, see :ref:`admin-manage-usage`.
300+
To learn more about token limits, see :ref:`admin-manage-usage`.

gdi/get-data-in/application/java/java-otel-requirements.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,14 @@ Supported libraries and frameworks
4545

4646
The Splunk Distribution of OpenTelemetry Java instruments numerous libraries, frameworks, and application servers.
4747

48+
.. note:: To deactivate specific instrumentations, see :ref:`java-instrumentation-issues`.
49+
4850
.. raw:: html
4951

5052
<div class="instrumentation" section="instrumentations" url="https://raw.githubusercontent.com/splunk/o11y-gdi-metadata/main/apm/splunk-otel-java/metadata.yaml" data-renaming='{"keys": "Identifier", "description": "Description", "stability": "Stability", "support": "Support", "instrumented_components": "Components", "signals": "Signals", "source_href": "Source", "settings": "Settings", "dependencies": "Dependencies", "supported_versions": "Supported versions", "name": "Name", "package_href": "Package URL", "version": "Version", "instrument": "Type", "metric_name": "Metric name", "metrics": "Metrics", "env": "Environment variable", "default": "Default", "type": "Type", "category": "Category"}'></div>
5153

5254
For a complete list of supported libraries and frameworks, see :new-page:`Supported libraries <https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/supported-libraries.md>` in the OpenTelemetry documentation.
5355

54-
.. note:: To deactivate specific instrumentations, see :ref:`java-instrumentation-issues`.
55-
56-
5756
.. _java-otel-connector-requirement:
5857

5958
Install and configure the Splunk Distribution of OpenTelemetry Collector

gdi/get-data-in/connect/aws/aws-prereqs.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,8 @@ On top of the required permissions, you also need to include the specific permis
218218

219219
These are these permissions to allow Splunk Observability Cloud to collect AWS tags and properties:
220220

221+
- ``"acm:DescribeCertificate"``
222+
- ``"acm:ListCertificates"``
221223
- ``"airflow:ListEnvironments"``
222224
- ``"airflow:GetEnvironment"``
223225
- ``"apigateway:GET"``

gdi/monitors-monitoring/cadvisor.rst

Lines changed: 86 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,50 @@ cAdvisor
88

99
The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the
1010
cAdvisor monitor type to pull metrics directly from cAdvisor. By
11-
default, it runs on port 4194, but it can be configured to any other
12-
port.
11+
default, it runs on port 4193, but it can be configured to any other
12+
port.
13+
14+
This integration is available on Kubernetes, Linux, and Windows.
15+
16+
cAdvisor with Kubernetes
17+
------------------------
1318

1419
If you are using Kubernetes, consider the
1520
:ref:`kubelet-stats-receiver` because many Kubernetes nodes do not
1621
expose cAdvisor on a network port, even though they are running it
1722
within Kubelet.
1823

24+
If you are using Kubernetes, consider the Kubelet stats receiver
25+
because many Kubernetes nodes do not expose cAdvisor on a network port,
26+
even though they are running it within Kubelet.
27+
28+
In some managed Kubernetes environments, such as Amazon EKS, you cannot
29+
directly access cAdvisor metrics due to the cluster provider's
30+
security and control design. For example, in Amazon EKS,
31+
the ``kubeletstats`` receiver cannot directly collect cAdvisor metrics.
32+
This constraint is specific to managed environments and is not a restriction
33+
of the Splunk Distribution of OpenTelemetry Collector.
34+
35+
You can, however, indirectly collect cAdvisor metrics exposed through
36+
the Kubernetes proxy metric server using a receiver with the required configuration.
37+
We recommend using the :ref:`Prometheus receiver <prometheus_receiver>`
38+
to scrape metrics from the proxy metric server.
39+
40+
41+
cAdvisor with Docker
42+
---------------------
43+
1944
If you are running containers with Docker, retrieved metrics might
20-
overlap with ``docker-container-stats``\ '. Consider not enabling the
45+
overlap with ``docker-container-stats``. Consider not enabling the
2146
Docker monitor in a Kubernetes environment, or else use filtering to
2247
allow only certain metrics. This will cause the built-in Docker
2348
dashboards to be blank, but container metrics will be available on the
2449
Kubernetes dashboards instead.
2550

26-
This integration is available on Kubernetes, Linux, and Windows.
2751

2852
Benefits
2953
--------
3054

31-
32-
3355
.. raw:: html
3456

3557
<div class="include-start" id="benefits.rst"></div>
@@ -41,13 +63,9 @@ Benefits
4163
<div class="include-stop" id="benefits.rst"></div>
4264

4365

44-
45-
4666
Installation
4767
------------
4868

49-
50-
5169
.. raw:: html
5270

5371
<div class="include-start" id="collector-installation-linux.rst"></div>
@@ -59,13 +77,9 @@ Installation
5977
<div class="include-stop" id="collector-installation-linux.rst"></div>
6078

6179

62-
63-
6480
Configuration
6581
-------------
6682

67-
68-
6983
.. raw:: html
7084

7185
<div class="include-start" id="configuration.rst"></div>
@@ -77,10 +91,11 @@ Configuration
7791
<div class="include-stop" id="configuration.rst"></div>
7892

7993

94+
Examples
95+
^^^^^^^^
8096

81-
82-
Example
83-
~~~~~~~
97+
Activate integration
98+
####################
8499

85100
To activate this integration, add the following to your Collector
86101
configuration:
@@ -102,8 +117,60 @@ section of your configuration file:
102117
metrics:
103118
receivers: [smartagent/cadvisor]
104119
120+
.. _prometheus_receiver:
121+
122+
Prometheus receiver
123+
###################
124+
125+
The following example shows how to configure a Prometheus receiver
126+
to scrape cAdvisor metrics securely from Kubernetes nodes using TLS and authorization
127+
credentials.
128+
129+
.. code:: yaml
130+
131+
agent:
132+
config:
133+
receivers:
134+
prometheus/cadvisor:
135+
config:
136+
scrape_configs:
137+
- job_name: cadvisor
138+
tls_config:
139+
ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
140+
authorization:
141+
credentials_file: /var/run/secrets/kubernetes.io/serviceaccount/token
142+
scheme: https
143+
kubernetes_sd_configs:
144+
- role: node
145+
relabel_configs:
146+
- replacement: 'kubernetes.default.svc.cluster.local:443'
147+
target_label: __address__
148+
- regex: (.+)
149+
replacement: '/api/v1/nodes/$${1}/proxy/metrics/cadvisor'
150+
source_labels:
151+
- __meta_kubernetes_node_name
152+
target_label: __metrics_path__
153+
service:
154+
pipelines:
155+
metrics:
156+
exporters:
157+
- signalfx
158+
processors:
159+
- memory_limiter
160+
- batch
161+
- resourcedetection
162+
- resource
163+
receivers:
164+
- hostmetrics
165+
- kubeletstats
166+
- otlp
167+
- prometheus/cadvisor
168+
- receiver_creator
169+
- signalfx
170+
171+
105172
Configuration settings
106-
~~~~~~~~~~~~~~~~~~~~~~
173+
^^^^^^^^^^^^^^^^^^^^^^
107174

108175
The following table shows the configuration options for this receiver:
109176

@@ -135,9 +202,7 @@ The following metrics are available for this integration:
135202
<div class="metrics-yaml" url="https://raw.githubusercontent.com/signalfx/splunk-otel-collector/main/internal/signalfx-agent/pkg/monitors/cadvisor/metadata.yaml"></div>
136203

137204
Notes
138-
~~~~~
139-
140-
205+
^^^^^
141206

142207
.. raw:: html
143208

@@ -155,8 +220,6 @@ Notes
155220
Troubleshooting
156221
---------------
157222

158-
159-
160223
.. raw:: html
161224

162225
<div class="include-start" id="troubleshooting-components.rst"></div>

gdi/opentelemetry/components/http-forwarder-extension.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,5 @@ HTTP forwarder extension
99

1010
The Splunk Distribution of the OpenTelemetry Collector supports the HTTP forwarder extension. Documentation is planned for a future release.
1111

12+
Splunk Observability Cloud uses OpenTelemetry to correlate telemetry types. To do this, your telemetry field names or metadata key names must exactly match the metadata key names used by both OpenTelemetry and Splunk Observability Cloud. To ensure your metadata key names are correctly named, see :ref:`relatedcontent-collector`.
13+

release-notes/2025-4-rn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ April 22, 2025 release
2020
* - New feature or enhancement
2121
- Description
2222
* - Splunk Synthetic Monitoring audit logs
23-
- Use the Synthetics API to retrieve audit logs. These logs provide a detailed history of any changes made to Synthetics resources, such as tests, downtime configurations, TOTP tokens, private locations, and more. Audit logs enable you to track every change within your environment for regulatory and compliance needs, and to identify the root cause of performance issues or failures.
23+
- Use the Synthetics API to retrieve audit logs. These logs provide a detailed history of any changes made to Synthetics resources, such as tests, downtime configurations, TOTP tokens, private locations, and more. Audit logs enable you to track every change within your environment for regulatory and compliance needs, and to identify the root cause of performance issues or failures. See :new-page:`Synthetics audit API <https://dev.splunk.com/observability/reference/api/synthetics_audits/latest>` to learn more.
2424
* - Curated APM teams landing page updates
2525
- View your Splunk APM services, dashboards, top alerts, and the team members of every team you are part of from the teams landing page. Preview potential teams by selecting :guilabel:`View all teams` to join teams you're not yet a member of. See :ref:`admin-configure-page` to learn more.
2626
* - Guided setup updates for getting GCP data in

rum/rum-session-replay.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ This example shows the order in which to initialize the scripts:
4040

4141
.. code-block:: html
4242

43-
<script src="https://cdn.signalfx.com/o11y-gdi-rum/latest/splunk-otel-web.js" crossorigin="anonymous"></script>
44-
<script src="https://cdn.signalfx.com/o11y-gdi-rum/latest/splunk-otel-web-session-recorder.js" crossorigin="anonymous"></script>
43+
<script src="https://cdn.signalfx.com/o11y-gdi-rum/latest/splunk-otel-web.js" crossOrigin="anonymous"></script>
44+
<script src="https://cdn.signalfx.com/o11y-gdi-rum/latest/splunk-otel-web-session-recorder.js" crossOrigin="anonymous"></script>
4545
<script>
4646
SplunkRum.init({
4747
realm: '<realm>',
@@ -63,7 +63,7 @@ Initialize this code snippet to set up session replay through Splunk CDN.
6363

6464
.. code-block:: html
6565

66-
<script src="https://cdn.signalfx.com/o11y-gdi-rum/latest/splunk-otel-web-session-recorder.js" crossorigin="anonymous"></script>
66+
<script src="https://cdn.signalfx.com/o11y-gdi-rum/latest/splunk-otel-web-session-recorder.js" crossOrigin="anonymous"></script>
6767
<script>
6868
SplunkSessionRecorder.init({
6969
realm: '<realm>',
@@ -82,7 +82,7 @@ Self-hosted
8282

8383
.. code-block:: html
8484

85-
<script src="<your-self-hosted-path>/splunk-otel-web-session-recorder.js" crossorigin="anonymous"></script>
85+
<script src="<your-self-hosted-path>/splunk-otel-web-session-recorder.js" crossOrigin="anonymous"></script>
8686

8787

8888
To avoid gaps in your data, load and initialize the Splunk JavaScript Agent asynchronously and as early as possible.

splunkplatform/centralized-rbac.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Centralized user and role management
99
.. meta::
1010
:description: This page describes how Splunk Cloud Platform admins can manage Splunk Observability Cloud roles from Splunk Cloud Platform.
1111

12-
Administrators can now centrally manage users and roles for both Splunk Cloud Platform and Splunk Observability Cloud in Splunk Cloud Platform. Splunk Cloud Platform becomes the role based access control (RBAC) store for Splunk Observability Cloud.
12+
Administrators can centrally manage users and roles for both Splunk Cloud Platform and Splunk Observability Cloud in Splunk Cloud Platform. Splunk Cloud Platform becomes the role based access control (RBAC) store for Splunk Observability Cloud.
1313

1414
Who can access centralized user and role management?
1515
=================================================================================================

splunkplatform/unified-id/unified-identity.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,14 @@ To add a new user to Splunk Observability Cloud after the integration is complet
222222

223223
The user can now log in to Splunk Observability Cloud with their Splunk Cloud Platform permissions.
224224

225+
.. uid-central-rbac:
226+
227+
Centralized user and role management
228+
------------------------------------------------------------------------------------------
229+
Administrators of organizations that have Splunk Cloud Platform and Splunk Observability Cloud can centrally manage users and roles for both in Splunk Cloud Platform. Splunk Cloud Platform becomes the role based access control (RBAC) store for Splunk Observability Cloud.
230+
231+
All customers who have Unified Identity can access centralized user and role management in Splunk Cloud Platform. For more information, see :ref:`centralized-rbac`.
232+
225233

226234
After initial user provisioning
227235
-------------------------------------------------------------------------------------------
@@ -260,6 +268,8 @@ Contact your Splunk Cloud Platform administrator if you receive the following :s
260268

261269
Users receive this error message if their Splunk Cloud Platform administrator did not give them the custom role ``o11y_access``. The ``o11y_access`` role is required to access Splunk Observability Cloud.
262270

271+
If you set up centralized user and role access, make sure to assign the ``o11y_access`` role to all roles that should access Splunk Observability Cloud, not just the user role.
272+
263273

264274
Working in Splunk Observability Cloud after the integration
265275
==========================================================================================

synthetics/set-up-synthetics/set-up-synthetics.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ After you choose which type of test you want to use, follow these steps to set u
111111
Get audit logs
112112
============================================================
113113

114-
Use the Synthetics API to retrieve audit logs. These logs provide a detailed history of any changes made to Synthetics resources, such as tests, downtime configurations, TOTP tokens, private locations, and more. Audit logs enable you to track every change within your environment for regulatory and compliance needs and to identify the root cause of performance issues or failures.
114+
Use the :new-page:`Synthetics audit API <https://dev.splunk.com/observability/reference/api/synthetics_audits/latest>` to retrieve audit logs. These logs provide a detailed history of any changes made to Synthetics resources, such as tests, downtime configurations, TOTP tokens, private locations, and more. Audit logs enable you to track every change within your environment for regulatory and compliance needs and to identify the root cause of performance issues or failures.
115115

116116

117117

0 commit comments

Comments
 (0)