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

Commit 63ae7cf

Browse files
aurbiztondo-splunkaurbiztondo-splunk
committed
WIP
1 parent d6b020e commit 63ae7cf

File tree

6 files changed

+72
-53
lines changed

6 files changed

+72
-53
lines changed

‎gdi/opentelemetry/collector-kubernetes/kubernetes-config-logs.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
.. _kubernetes-config-logs:
33

44
*********************************************************************************
5-
Collect logs and events for the Collector for Kubernetes
5+
Collect logs and events with the Collector for Kubernetes
66
*********************************************************************************
77

88
.. meta::

‎gdi/opentelemetry/collector-linux/linux-config-logs.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
.. _linux-config-logs:
33

44
***************************************************************
5-
Collect logs for the Collector for Linux
5+
Collect logs with the Collector for Linux
66
***************************************************************
77

88
.. meta::

‎gdi/opentelemetry/collector-windows/collector-windows-intro.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Get started with the Collector for Windows
1717
Install the Collector for Windows (manually) <install-windows-manual.rst>
1818
windows-config-ootb.rst
1919
windows-config.rst
20+
windows-config-logs.rst
2021
metrics-ootb-windows.rst
2122
windows-upgrade.rst
2223
windows-uninstall.rst
@@ -31,8 +32,9 @@ To install the Splunk Distribution of the OpenTelemetry Collector for Windows, f
3132
See the default settings and configuration options at:
3233

3334
* :ref:`windows-config-ootb`
34-
* :ref:`otel-windows-config`
3535
* By default, you'll obtain these :ref:`metrics <ootb-metrics-windows>`
36+
* :ref:`otel-windows-config`
37+
* :ref:`windows-config-logs`
3638

3739
.. include:: /_includes/gdi/collector-common-options.rst
3840

‎gdi/opentelemetry/collector-windows/install-windows.rst‎

Lines changed: 0 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -167,55 +167,6 @@ The Windows installer script supports the following options:
167167
- Specify public MSI properties to be used when installing the Splunk OpenTelemetry Collector MSI package.
168168
-
169169

170-
.. _windows-config-logs:
171-
172-
Collect logs for the Collector for Windows
173-
====================================================================
174-
175-
Use the Universal Forwarder to send logs to the Splunk platform. See more at :ref:`collector-with-the-uf`.
176-
177-
.. _fluentd-manual-config-windows:
178-
179-
Collect Windows logs with Fluentd
180-
---------------------------------------
181-
182-
If you wish to collect logs for the target host with Fluentd, use the ``with_fluentd = 1`` option to install and enable Fluentd when installing the Collector. For example:
183-
184-
.. code-block:: PowerShell
185-
186-
& {Set-ExecutionPolicy Bypass -Scope Process -Force; $script = ((New-Object System.Net.WebClient).DownloadString('https://dl.signalfx.com/splunk-otel-collector.ps1')); $params = @{access_token = "<SPLUNK_ACCESS_TOKEN>"; realm = "<SPLUNK_REALM>"; with_fluentd = 1}; Invoke-Command -ScriptBlock ([scriptblock]::Create(". {$script} $(&{$args} @params)"))}
187-
188-
When activated, the Fluentd service is configured by default to collect and forward log events with the ``@SPLUNK`` label to the Collector, which then send these events to the HEC ingest endpoint determined by the ``realm = "<SPLUNK_REALM>"`` option.
189-
For example, ``https://ingest.<SPLUNK_REALM>.signalfx.com/v1/log``.
190-
191-
To configure the package to send log events to a custom HTTP Event Collector (HEC) endpoint URL with a token different than ``<SPLUNK_ACCESS_TOKEN>``, you can specify the following parameters for the installer script:
192-
193-
* ``hec_url = "<SPLUNK_HEC_URL>"``
194-
* ``hec_token = "<SPLUNK_HEC_TOKEN>"``
195-
196-
For example (replace the ``<SPLUNK...>`` values in the command for your configuration):
197-
198-
.. code-block:: PowerShell
199-
200-
& {Set-ExecutionPolicy Bypass -Scope Process -Force; $script = ((New-Object System.Net.WebClient).DownloadString('https://dl.signalfx.com/splunk-otel-collector.ps1')); $params = @{access_token = "<SPLUNK_ACCESS_TOKEN>"; realm = "<SPLUNK_REALM>"; hec_url = "<SPLUNK_HEC_URL>"; hec_token = "<SPLUNK_HEC_TOKEN>"}; Invoke-Command -ScriptBlock ([scriptblock]::Create(". {$script} $(&{$args} @params)"))}
201-
202-
The installation creates the main fluentd configuration file ``<drive>\opt\td-agent\etc\td-agent\td-agent.conf``, where ``<drive>`` is the drive letter for the fluentd installation directory.
203-
204-
You can add custom fluentd source configuration files to the ``<drive>\opt\td-agent\etc\td-agent\conf.d``
205-
directory after installation.
206-
207-
Note the following:
208-
209-
* In this directory, fluentd includes all files with the .conf extension.
210-
* By default, fluentd collects from the Windows Event Log. See ``<drive>\opt\td-agent\etc\td-agent\conf.d\eventlog.conf`` for the default configuration.
211-
212-
After any configuration modification, apply the changes by restarting the system or running the following PowerShell commands:
213-
214-
.. code-block:: PowerShell
215-
216-
Stop-Service fluentdwinsvc
217-
Start-Service fluentdwinsvc
218-
219170
Next steps
220171
==================================
221172

‎gdi/opentelemetry/collector-windows/windows-config-logs.rst‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
.. _windows-config-logs:
2+
3+
***************************************************************
4+
Collect logs with the Collector for Windows
5+
***************************************************************
6+
7+
.. meta::
8+
9+
:description: Describes how to collect logs for the Splunk Distribution of OpenTelemetry Collector for Linux.
10+
11+
Use the Universal Forwarder to send logs to the Splunk platform. See more at :ref:`collector-with-the-uf`.
12+
13+
.. _fluentd-manual-config-windows:
14+
15+
Collect Windows logs with Fluentd
16+
===========================================================================
17+
18+
Fluentd is turned off by default.
19+
20+
If you wish to collect logs for the target host with Fluentd, use the ``with_fluentd = 1`` option to install and enable Fluentd when installing the Collector.
21+
22+
For example:
23+
24+
.. code-block:: PowerShell
25+
26+
& {Set-ExecutionPolicy Bypass -Scope Process -Force; $script = ((New-Object System.Net.WebClient).DownloadString('https://dl.signalfx.com/splunk-otel-collector.ps1')); $params = @{access_token = "<SPLUNK_ACCESS_TOKEN>"; realm = "<SPLUNK_REALM>"; with_fluentd = 1}; Invoke-Command -ScriptBlock ([scriptblock]::Create(". {$script} $(&{$args} @params)"))}
27+
28+
When activated, the Fluentd service is configured by default to collect and forward log events with the ``@SPLUNK`` label to the Collector, which then send these events to the HEC ingest endpoint determined by the ``realm = "<SPLUNK_REALM>"`` option.
29+
For example, ``https://ingest.<SPLUNK_REALM>.signalfx.com/v1/log``.
30+
31+
To configure the package to send log events to a custom HTTP Event Collector (HEC) endpoint URL with a token different than ``<SPLUNK_ACCESS_TOKEN>``, you can specify the following parameters for the installer script:
32+
33+
* ``hec_url = "<SPLUNK_HEC_URL>"``
34+
* ``hec_token = "<SPLUNK_HEC_TOKEN>"``
35+
36+
For example (replace the ``<SPLUNK...>`` values in the command for your configuration):
37+
38+
.. code-block:: PowerShell
39+
40+
& {Set-ExecutionPolicy Bypass -Scope Process -Force; $script = ((New-Object System.Net.WebClient).DownloadString('https://dl.signalfx.com/splunk-otel-collector.ps1')); $params = @{access_token = "<SPLUNK_ACCESS_TOKEN>"; realm = "<SPLUNK_REALM>"; hec_url = "<SPLUNK_HEC_URL>"; hec_token = "<SPLUNK_HEC_TOKEN>"}; Invoke-Command -ScriptBlock ([scriptblock]::Create(". {$script} $(&{$args} @params)"))}
41+
42+
The installation creates the main fluentd configuration file ``<drive>\opt\td-agent\etc\td-agent\td-agent.conf``, where ``<drive>`` is the drive letter for the fluentd installation directory.
43+
44+
You can add custom fluentd source configuration files to the ``<drive>\opt\td-agent\etc\td-agent\conf.d``
45+
directory after installation.
46+
47+
Note the following:
48+
49+
* In this directory, fluentd includes all files with the .conf extension.
50+
* By default, fluentd collects from the Windows Event Log. See ``<drive>\opt\td-agent\etc\td-agent\conf.d\eventlog.conf`` for the default configuration.
51+
52+
After any configuration modification, apply the changes by restarting the system or running the following PowerShell commands:
53+
54+
.. code-block:: PowerShell
55+
56+
Stop-Service fluentdwinsvc
57+
Start-Service fluentdwinsvc
58+
59+

‎gdi/opentelemetry/troubleshoot-logs.rst‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,14 @@ Troubleshoot Collector logs
88
:description: Describes known issues when collecting logs with the Splunk Distribution of OpenTelemetry Collector.
99

1010

11-
.. note:: See also the :new-page:`OpenTelemetry Project troublehooting docs <https://opentelemetry.io/docs/collector/troubleshooting>` for more information about debugging.
11+
.. note::
12+
13+
To collect logs see:
14+
15+
* :ref:`kubernetes-config-logs`
16+
* :ref:`linux-config-logs`
17+
18+
See also the :new-page:`OpenTelemetry Project troublehooting docs <https://opentelemetry.io/docs/collector/troubleshooting>` for more information about debugging.
1219

1320
Here are some common issues related to log collection on the Collector.
1421

0 commit comments

Comments
 (0)