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

Commit 665bc11

Browse files
Merge pull request #1586 from splunk/repo-sync
Pulling refs/heads/main into main
2 parents b1dd977 + 6390674 commit 665bc11

File tree

7 files changed

+154
-15
lines changed

7 files changed

+154
-15
lines changed

Dockerfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@ RUN apt-get update && \
88
RUN pip3 install --upgrade pip
99
RUN pip3 install -r requirements.txt --force-reinstall --no-cache-dir --root-user-action=ignore
1010
RUN pip3 install sphinx-autobuild --root-user-action=ignore
11+
RUN pip3 install standard-imghdr
1112
ENTRYPOINT ["tail", "-f", "/dev/null"]

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ To rotate an access token with the API, use the ``POST /token/{name}/rotate`` en
237237

238238
.. code-block:: bash
239239
240-
curl -X POST "https://api.{realm}.signalfx.com/v2/token/{name}/rotate?graceful={gracePeriod}" \
240+
curl -X POST "https://api.{realm}.signalfx.com/v2/token/{name}/rotate?graceful={gracePeriod}&secondsUntilExpiry={secondsUntilExpiry}" \
241241
-H "Content-type: application/json" \
242242
-H "X-SF-TOKEN: <your-user-session-api-token-value>"
243243
@@ -247,6 +247,7 @@ Follow these steps:
247247
#. Enter your API session token in the ``your-user-session-api-token-value`` field. To find or create an API session token, see :ref:`admin-api-access-tokens`.
248248
#. Provide the name of the token you want to rotate in the ``name`` field.
249249
#. Optionally, provide a grace period, in seconds, in the ``gracePeriod`` field.
250+
#. Optionally, provide the seconds until your token expires in the ``secondsUntilExpiry`` field. This can be any value between 0 second and 5,676,000,000 seconds (18 years), inclusive. If left unspecified, the token remains valid for 30 days.
250251
#. Call the API endpoint to rotate the token.
251252

252253
For example, the following API call rotates ``myToken`` and sets a grace period of 604800 seconds (7 days) before the previous token secret expires.

gdi/opentelemetry/collector-kubernetes/kubernetes-config-advanced.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -503,3 +503,32 @@ Cluster Receiver support
503503
The Cluster receiver is a 1-replica deployment of the OpenTelemetry Collector. Because the Kubernetes control plane can select any available node to run the cluster receiver pod (unless ``clusterReceiver.nodeSelector`` is explicitly set to pin the pod to a specific node), ``hostPath`` or ``local`` volume mounts don't work for such environments.
504504

505505
Data persistence is currently not applicable to the Kubernetes cluster metrics and Kubernetes events.
506+
507+
Monitor OpenShift infrastructure nodes
508+
============================================
509+
510+
By default, the Splunk Distribution of OpenTelemetry Collector for Kubernetes doesn't collect data from OpenShift infrastructure nodes.
511+
512+
You can customize the Collector Helm Chart file to activate data collection from OpenShift infrastructure nodes. To do so, complete the following steps:
513+
514+
#. Open your values.yaml file for the Helm Chart.
515+
#. Copy and paste the following YAML snippet into the values.yaml file:
516+
517+
.. code-block:: yaml
518+
519+
tolerations:
520+
- key: node-role.kubernetes.io/master
521+
effect: NoSchedule
522+
- key: node-role.kubernetes.io/control-plane
523+
effect: NoSchedule
524+
- key: node-role.kubernetes.io/infra
525+
effect: NoSchedule
526+
operator: Exists
527+
528+
#. Install the Collector using the Helm Chart:
529+
530+
.. code-block:: bash
531+
532+
helm install my-splunk-otel-collector --values values.yaml splunk-otel-collector-chart/splunk-otel-collector
533+
534+
.. note:: Monitoring OpenShift infrastructure nodes might pose a security risk depending on which method you used to create the Kubernetes environment.

gdi/opentelemetry/components/redis-receiver.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Get started
2121

2222
Follow these steps to configure and activate the component:
2323

24-
1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
24+
1. Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
2525

2626
- :ref:`otel-install-linux`
2727
- :ref:`otel-install-windows`
@@ -56,9 +56,9 @@ To complete the configuration, include the receiver in the ``metrics`` pipeline
5656
receivers: [redis]
5757
5858
Configuration settings
59-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
59+
-------------------------------------------------
6060

61-
The following setting is required:
61+
The following settings are required:
6262

6363
* ``endpoint``: The hostname and port of the Redis instance, separated by a colon. No default value.
6464

gdi/opentelemetry/components/vcenter-receiver.rst

Lines changed: 104 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,108 @@ vCenter receiver
77
.. meta::
88
:description: The vCenter receiver supports ESXi and vCenter.
99

10-
The Splunk Distribution of the OpenTelemetry Collector supports the vCenter receiver. Documentation is planned for a future release.
10+
The vCenter receiver fetches metrics from a vCenter or ESXi host running VMware vSphere APIs.
1111

12-
To find information about this component in the meantime, see :new-page:`vCenter receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/vcenterreceiver>` on GitHub.
12+
Prerequisites
13+
======================
14+
15+
This receiver supports ESXi and vCenter versions 7.0 and 8.
16+
17+
To retrieve data you need to assign a read-only user to vSphere with permissions to the vCenter server, cluster and all subsequent resources being monitored.
18+
19+
Get started
20+
======================
21+
22+
Follow these steps to configure and activate the component:
23+
24+
1. Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
25+
26+
- :ref:`otel-install-linux`
27+
- :ref:`otel-install-windows`
28+
- :ref:`otel-install-k8s`
29+
30+
2. Configure the receiver creator receiver as described in the next section.
31+
3. Restart the Collector.
32+
33+
Sample configuration
34+
----------------------------------------------------------------------
35+
36+
To activate the vCenter receiver in the Collector, add ``vecenter`` to the ``receivers`` section of your configuration file, as shown in the following example:
37+
38+
.. code:: yaml
39+
40+
receivers:
41+
vcenter:
42+
43+
To complete the configuration, include the receiver in the ``metrics`` pipeline of the ``service`` section of your configuration file. For example:
44+
45+
.. code:: yaml
46+
47+
service:
48+
pipelines:
49+
metrics:
50+
receivers: [vcenter]
51+
52+
Configuration example
53+
----------------------------------------------------------------------
54+
55+
See the following config example:
56+
57+
.. code:: yaml
58+
59+
vcenter:
60+
endpoint: http://vcsa.host.localnet
61+
username: otelu
62+
password: ${env:VCENTER_PASSWORD}
63+
collection_interval: 5m
64+
metrics:
65+
vcenter.host.cpu.utilization:
66+
enabled: false
67+
68+
Configuration settings
69+
-------------------------------------------------
70+
71+
The following settings are required:
72+
73+
* ``password``
74+
75+
* ``username``
76+
77+
* ``endpoint``. Endpoint to the vCenter Server or ESXi host that has the SDK path enabled.
78+
79+
* Use the <protocol>://<hostname> format, for example ``https://vcsa.hostname.localnet``.
80+
81+
The following settings are optional:
82+
83+
* ``collection_interval``. ``2m`` by default. This receiver collects metrics on an interval. If the vCenter is large, increase this value.
84+
85+
* Valid time units are ``ns``, ``us`` (or ``µs``), ``ms``, ``s``, ``m``, ``h``.
86+
87+
* ``initial_delay``. ``1s`` by default. Defines how long the receiver waits before starting.
88+
89+
* ``tls``. TLS control. By default insecure settings are rejected and certificate verification is on. Will use defaults for configtls.ClientConfig. Learn more at :new-page:`TLS Configuration Settings <https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md>` in GitHub.
90+
91+
Settings
92+
======================
93+
94+
The following table shows the configuration options for the vCenter receiver:
95+
96+
.. raw:: html
97+
98+
<div class="metrics-standard" category="included" url="https://raw.githubusercontent.com/splunk/collector-config-tools/main/cfg-metadata/receiver/vcenter.yaml"></div>
99+
100+
.. _vcenter-receiver-metrics:
101+
102+
Metrics
103+
=====================
104+
105+
The following metrics, resource attributes, and attributes are available.
106+
107+
.. raw:: html
108+
109+
<div class="metrics-component" category="included" url="https://raw.githubusercontent.com/splunk/collector-config-tools/main/metric-metadata/vcenterreceiver.yaml"></div>
110+
111+
Troubleshooting
112+
======================
113+
114+
.. include:: /_includes/troubleshooting-components.rst

gdi/opentelemetry/discovery-mode.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,9 @@ Automatic discovery supports the following host services and applications:
9292
* - Service
9393
- Receiver
9494

95+
* - Apache Web Server
96+
- Apache Web Server receiver. See :ref:`apache-receiver`.
97+
9598
* - MySQL
9699
- MySQL receiver. See :ref:`mysql-receiver`
97100

@@ -104,6 +107,9 @@ Automatic discovery supports the following host services and applications:
104107
* - NGINX
105108
- Smart Agent with collectd/nginx monitor type. See :ref:`nginx`
106109

110+
* - RabbitMQ
111+
- RabbitMQ receiver. See :ref:`rabbitmq-receiver`.
112+
107113
* - Redis
108114
- Redis receiver. See :ref:`redis-receiver`
109115

synthetics/test-config/private-locations.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -144,17 +144,17 @@ Configuring Proxy Settings for Private Locations
144144

145145
In environments where direct internet access is restricted, you can route synthetic test traffic through a proxy server by configuring the following environment variables:
146146

147-
* HTTP_PROXY: Specifies the proxy server for HTTP traffic.
147+
* ``HTTP_PROXY``: Specifies the proxy server for HTTP traffic.
148148

149-
* Example: export HTTP_PROXY="\http://proxy.example.com:8080"
149+
* Example: ``export HTTP_PROXY="\http://proxy.example.com:8080"``
150150

151-
* HTTPS_PROXY: Specifies the proxy server for HTTPS traffic.
151+
* ``HTTPS_PROXY``: Specifies the proxy server for HTTPS traffic.
152152

153-
* Example: export HTTPS_PROXY="\https://proxy.example.com:8443"
153+
* Example: ``export HTTPS_PROXY="\https://proxy.example.com:8443"``
154154

155-
* NO_PROXY: Specifies a comma-separated list of domains or IP addresses that should bypass the proxy.
155+
* ``NO_PROXY``: Specifies a comma-separated list of domains or IP addresses that should bypass the proxy.
156156

157-
* Example: export NO_PROXY="localhost,127.0.0.1,.internal-domain.com"
157+
* Example: ``export NO_PROXY="localhost,127.0.0.1,.internal-domain.com"``
158158

159159
For example, here is what a command might look like after you modify it to fit your environment:
160160

@@ -165,15 +165,15 @@ For example, here is what a command might look like after you modify it to fit y
165165
166166
In this example:
167167

168-
HTTP_PROXY and HTTPS_PROXY are set to route traffic through a proxy at \http://172.17.0.1:1234.
168+
``HTTP_PROXY`` and ``HTTPS_PROXY`` are set to route traffic through a proxy at ``http://172.17.0.1:1234``.
169169

170-
NO_PROXY is configured to bypass the proxy for local addresses and specific domains like .signalfx.com and .amazonaws.com.
170+
``NO_PROXY`` is configured to bypass the proxy for local addresses and specific domains like .signalfx.com and .amazonaws.com.
171171

172172
Ensure that these variables are correctly configured to comply with your network policies. This setup allows the synthetic tests to communicate securely and efficiently in a controlled network environment.
173173

174174
When using runner, it's important to correctly configure the proxy settings to avoid issues with browser-based tests. The following steps should be followed when setting up their environment:
175175

176-
1. :strong:`Ensure Proper NO_PROXY Setup`:
176+
1. :strong:`Ensure proper NO_PROXY setup`:
177177

178178
- When configuring ``NO_PROXY`` always include the following addresses:
179179

0 commit comments

Comments
 (0)