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

Commit bb97ad2

Browse files
WIP
1 parent 8d8e48f commit bb97ad2

File tree

2 files changed

+92
-5
lines changed

2 files changed

+92
-5
lines changed

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: 89 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,93 @@ 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+
53+
Configuration example
54+
----------------------------------------------------------------------
55+
56+
See the following config example:
57+
58+
.. code:: yaml
59+
60+
vcenter:
61+
endpoint: http://vcsa.host.localnet
62+
username: otelu
63+
password: ${env:VCENTER_PASSWORD}
64+
collection_interval: 5m
65+
metrics:
66+
vcenter.host.cpu.utilization:
67+
enabled: false
68+
69+
Configuration settings
70+
-------------------------------------------------
71+
72+
The following setting are required:
73+
74+
75+
76+
Settings
77+
======================
78+
79+
The following table shows the configuration options for the vCenter receiver:
80+
81+
.. raw:: html
82+
83+
<div class="metrics-standard" category="included" url="https://raw.githubusercontent.com/splunk/collector-config-tools/main/cfg-metadata/receiver/vcenter.yaml"></div>
84+
85+
.. _redis-receiver-metrics:
86+
87+
Metrics
88+
=====================
89+
90+
The following metrics, resource attributes, and attributes are available.
91+
92+
.. raw:: html
93+
94+
<div class="metrics-component" category="included" url="https://raw.githubusercontent.com/splunk/collector-config-tools/main/metric-metadata/vcenterreceiver.yaml"></div>
95+
96+
Troubleshooting
97+
======================
98+
99+
.. include:: /_includes/troubleshooting-components.rst

0 commit comments

Comments
 (0)