Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
78e4399
initial commit
mbechtold-splunk Oct 1, 2024
3f8c03c
Fix formatting of code and parameter samples.
Oct 31, 2024
db41eb3
Updated the version for Sphinx to 6.2.0 in the file.
jcatera-splunk Nov 1, 2024
52d5c6c
Add optional step for org token expiry
trangl-splunk Nov 4, 2024
a30b1e2
Add formatting
trangl-splunk Nov 5, 2024
afc521b
Add expiry field to code sample
trangl-splunk Nov 5, 2024
bb97ad2
WIP
aurbiztondo-splunk Nov 5, 2024
08e5936
WIP
aurbiztondo-splunk Nov 5, 2024
47c478f
Draft
aurbiztondo-splunk Nov 5, 2024
e697467
Fix
aurbiztondo-splunk Nov 5, 2024
c787260
Code syntax fix
trangl-splunk Nov 6, 2024
206462d
Merge pull request #2418 from splunk/adasplunk-O11YDOCS-6384
adasplunk Nov 6, 2024
8f3106c
Update admin/authentication/authentication-tokens/org-tokens.rst
trangl-splunk Nov 6, 2024
45e25b6
josh suggestion
mbechtold-splunk Nov 6, 2024
b49fc13
Merge pull request #2425 from splunk/trangl-docguild-27453-org-token-…
trangl-splunk Nov 6, 2024
4cae71a
Merge pull request #2360 from splunk/mbechtold-6481-k8s-infra-nodes
mbechtold-splunk Nov 6, 2024
2f4773d
Merge pull request #2420 from splunk/jcatera-build-fix
puribe-splunk Nov 6, 2024
6c4f819
initial commit
mbechtold-splunk Nov 6, 2024
2359265
fix
mbechtold-splunk Nov 6, 2024
7a5818d
Merge pull request #2430 from splunk/automatic-discovery-rabbit-apache
mbechtold-splunk Nov 6, 2024
4e231b3
Revert Sphinx version change
pauljwil Nov 6, 2024
f98e8de
Merge pull request #2431 from splunk/pwilliams-broken-nav
pauljwil Nov 6, 2024
48b860e
DOCS-999 - Fix bug
puribe-splunk Nov 6, 2024
86591cb
Merge pull request #2432 from splunk/bugfix/DOCS-999-Missing-lib
puribe-splunk Nov 6, 2024
b55e5fa
Merge pull request #2428 from splunk/urbiz-OD6302-vsphere-rx
aurbiztondo-splunk Nov 7, 2024
6390674
Merge branch 'main' into repo-sync
aurbiztondo-splunk Nov 7, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ RUN apt-get update && \
RUN pip3 install --upgrade pip
RUN pip3 install -r requirements.txt --force-reinstall --no-cache-dir --root-user-action=ignore
RUN pip3 install sphinx-autobuild --root-user-action=ignore
RUN pip3 install standard-imghdr
ENTRYPOINT ["tail", "-f", "/dev/null"]
3 changes: 2 additions & 1 deletion admin/authentication/authentication-tokens/org-tokens.rst
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ To rotate an access token with the API, use the ``POST /token/{name}/rotate`` en

.. code-block:: bash

curl -X POST "https://api.{realm}.signalfx.com/v2/token/{name}/rotate?graceful={gracePeriod}" \
curl -X POST "https://api.{realm}.signalfx.com/v2/token/{name}/rotate?graceful={gracePeriod}&secondsUntilExpiry={secondsUntilExpiry}" \
-H "Content-type: application/json" \
-H "X-SF-TOKEN: <your-user-session-api-token-value>"

Expand All @@ -247,6 +247,7 @@ Follow these steps:
#. 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`.
#. Provide the name of the token you want to rotate in the ``name`` field.
#. Optionally, provide a grace period, in seconds, in the ``gracePeriod`` field.
#. 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.
#. Call the API endpoint to rotate the token.

For example, the following API call rotates ``myToken`` and sets a grace period of 604800 seconds (7 days) before the previous token secret expires.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -503,3 +503,32 @@ Cluster Receiver support
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.

Data persistence is currently not applicable to the Kubernetes cluster metrics and Kubernetes events.

Monitor OpenShift infrastructure nodes
============================================

By default, the Splunk Distribution of OpenTelemetry Collector for Kubernetes doesn't collect data from OpenShift infrastructure nodes.

You can customize the Collector Helm Chart file to activate data collection from OpenShift infrastructure nodes. To do so, complete the following steps:

#. Open your values.yaml file for the Helm Chart.
#. Copy and paste the following YAML snippet into the values.yaml file:

.. code-block:: yaml

tolerations:
- key: node-role.kubernetes.io/master
effect: NoSchedule
- key: node-role.kubernetes.io/control-plane
effect: NoSchedule
- key: node-role.kubernetes.io/infra
effect: NoSchedule
operator: Exists

#. Install the Collector using the Helm Chart:

.. code-block:: bash

helm install my-splunk-otel-collector --values values.yaml splunk-otel-collector-chart/splunk-otel-collector

.. note:: Monitoring OpenShift infrastructure nodes might pose a security risk depending on which method you used to create the Kubernetes environment.
6 changes: 3 additions & 3 deletions gdi/opentelemetry/components/redis-receiver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Get started

Follow these steps to configure and activate the component:

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

- :ref:`otel-install-linux`
- :ref:`otel-install-windows`
Expand Down Expand Up @@ -56,9 +56,9 @@ To complete the configuration, include the receiver in the ``metrics`` pipeline
receivers: [redis]

Configuration settings
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-------------------------------------------------

The following setting is required:
The following settings are required:

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

Expand Down
106 changes: 104 additions & 2 deletions gdi/opentelemetry/components/vcenter-receiver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,108 @@ vCenter receiver
.. meta::
:description: The vCenter receiver supports ESXi and vCenter.

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

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.
Prerequisites
======================

This receiver supports ESXi and vCenter versions 7.0 and 8.

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.

Get started
======================

Follow these steps to configure and activate the component:

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

- :ref:`otel-install-linux`
- :ref:`otel-install-windows`
- :ref:`otel-install-k8s`

2. Configure the receiver creator receiver as described in the next section.
3. Restart the Collector.

Sample configuration
----------------------------------------------------------------------

To activate the vCenter receiver in the Collector, add ``vecenter`` to the ``receivers`` section of your configuration file, as shown in the following example:

.. code:: yaml

receivers:
vcenter:

To complete the configuration, include the receiver in the ``metrics`` pipeline of the ``service`` section of your configuration file. For example:

.. code:: yaml

service:
pipelines:
metrics:
receivers: [vcenter]

Configuration example
----------------------------------------------------------------------

See the following config example:

.. code:: yaml

vcenter:
endpoint: http://vcsa.host.localnet
username: otelu
password: ${env:VCENTER_PASSWORD}
collection_interval: 5m
metrics:
vcenter.host.cpu.utilization:
enabled: false

Configuration settings
-------------------------------------------------

The following settings are required:

* ``password``

* ``username``

* ``endpoint``. Endpoint to the vCenter Server or ESXi host that has the SDK path enabled.

* Use the <protocol>://<hostname> format, for example ``https://vcsa.hostname.localnet``.

The following settings are optional:

* ``collection_interval``. ``2m`` by default. This receiver collects metrics on an interval. If the vCenter is large, increase this value.

* Valid time units are ``ns``, ``us`` (or ``µs``), ``ms``, ``s``, ``m``, ``h``.

* ``initial_delay``. ``1s`` by default. Defines how long the receiver waits before starting.

* ``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.

Settings
======================

The following table shows the configuration options for the vCenter receiver:

.. raw:: html

<div class="metrics-standard" category="included" url="https://raw.githubusercontent.com/splunk/collector-config-tools/main/cfg-metadata/receiver/vcenter.yaml"></div>

.. _vcenter-receiver-metrics:

Metrics
=====================

The following metrics, resource attributes, and attributes are available.

.. raw:: html

<div class="metrics-component" category="included" url="https://raw.githubusercontent.com/splunk/collector-config-tools/main/metric-metadata/vcenterreceiver.yaml"></div>

Troubleshooting
======================

.. include:: /_includes/troubleshooting-components.rst
6 changes: 6 additions & 0 deletions gdi/opentelemetry/discovery-mode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@ Automatic discovery supports the following host services and applications:
* - Service
- Receiver

* - Apache Web Server
- Apache Web Server receiver. See :ref:`apache-receiver`.

* - MySQL
- MySQL receiver. See :ref:`mysql-receiver`

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

* - RabbitMQ
- RabbitMQ receiver. See :ref:`rabbitmq-receiver`.

* - Redis
- Redis receiver. See :ref:`redis-receiver`

Expand Down
18 changes: 9 additions & 9 deletions synthetics/test-config/private-locations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,17 +144,17 @@ Configuring Proxy Settings for Private Locations

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

* HTTP_PROXY: Specifies the proxy server for HTTP traffic.
* ``HTTP_PROXY``: Specifies the proxy server for HTTP traffic.

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

* HTTPS_PROXY: Specifies the proxy server for HTTPS traffic.
* ``HTTPS_PROXY``: Specifies the proxy server for HTTPS traffic.

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

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

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

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

Expand All @@ -165,15 +165,15 @@ For example, here is what a command might look like after you modify it to fit y

In this example:

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

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

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.

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:

1. :strong:`Ensure Proper NO_PROXY Setup`:
1. :strong:`Ensure proper NO_PROXY setup`:

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

Expand Down
Loading