You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: gdi/opentelemetry/collector-windows/install-windows.rst
+65-67Lines changed: 65 additions & 67 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -105,77 +105,75 @@ Options of the installer script for Windows
105
105
The Windows installer script supports the following options:
106
106
107
107
.. list-table::
108
-
:header-rows: 1
109
-
:width: 100%
110
-
:widths: 30 40 30
111
-
112
-
* - Option
113
-
- Description
114
-
- Default value
115
-
* - ``access_token``
116
-
- The token used to send metric data to Splunk.
117
-
-
118
-
* - ``realm``
119
-
- The Splunk realm to use. The ingest, API, trace, and HEC endpoint URLs are automatically created using this value. To find your Splunk realm, see :ref:`Note about realms <about-realms>`.
120
-
- ``us0``
121
-
* - ``memory``
122
-
- Total memory in MIB to allocate to the Collector. Automatically calculates the ballast size. See :ref:`otel-sizing` for more information.
123
-
- ``512``
124
-
* - ``mode``
125
-
- Configure the Collectorservice to run in host monitoring (``agent``) or data forwarding (``gateway``).
126
-
- ``agent``
127
-
* - ``network_interface``
128
-
- The network interface the Collectorreceivers listen on.
129
-
- ``0.0.0.0``
130
-
* - ``ingest_url``
131
-
- Set the base ingest URL explicitly instead of the URL inferred from the specified realm.
132
-
- ``https://ingest.REALM.signalfx.com``
133
-
* - ``api_url``
134
-
- Set the base API URL explicitly instead of the URL inferred from the specified realm.
135
-
- ``https://api.REALM.signalfx.com``
136
-
* - ``trace_url``
137
-
- Set the trace endpoint URL explicitly instead of the endpoint inferred from the specified realm.
138
-
- ``https://ingest.REALM.signalfx.com/v2/trace``
139
-
* - ``hec_url``
140
-
- Set the HEC endpoint URL explicitly instead of the endpoint inferred from the specified realm.
141
-
- ``https://ingest.REALM.signalfx.com/v1/log``
142
-
* - ``hec_token``
143
-
- Set the HEC token if it's different than the specified Splunk access token.
144
-
-
145
-
- ``$false``
146
-
* - ``with_dotnet_instrumentation``
147
-
- Whether to install and configure .NET tracing to forward .NET application traces to the local collector.
148
-
- ``$false``
149
-
* - ``deployment_env``
150
-
- A system-wide environment tag used by .NET instrumentation. Sets the ``SIGNALFX_ENV`` environment variable. Ignored if ``-with_dotnet_instrumentation`` is set to ``false``.
151
-
-
152
-
* - ``bundle_dir``
153
-
- The location of your Smart Agent bundle for monitor functionality.
- If true then certificates aren't checked when downloading resources.
157
-
- ``$false``
158
-
* - ``collector_version``
159
-
- Specify a specific version of the Collector to install.
160
-
- Latest version available
161
-
* - ``stage``
162
-
- The package stage to install from [``test``, ``beta``, ``release``].
163
-
- ``release``
164
-
* - ``collector_msi_url``
165
-
- When installing the Collector, instead of downloading the package, use this local path to a Splunk OpenTelemetry Collector MSI package. If specified, the ``-collector_version`` and ``-stage`` parameters are ignored.
- Specify a local path to a Splunk OpenTelemetry Collector MSI package to install instead of downloading the package. If specified, the ``-collector_version`` and ``-stage`` parameters will be ignored.
169
-
-
170
-
* - ``msi_public_properties``
171
-
- Specify public MSI properties to be used when installing the Splunk OpenTelemetry Collector MSI package.
172
-
-
108
+
:header-rows: 1
109
+
:width: 100%
110
+
:widths: 30 40 30
111
+
112
+
* - Option
113
+
- Description
114
+
- Default value
115
+
* - ``access_token``
116
+
- The token used to send metric data to Splunk.
117
+
-
118
+
* - ``realm``
119
+
- The Splunk realm to use. The ingest, API, trace, and HEC endpoint URLs are automatically created using this value. To find your Splunk realm see :ref:`Note about realms <about-realms>`.
120
+
- ``us0``
121
+
* - ``memory``
122
+
- Total memory in MIB to allocate to the Collector. Automatically calculates the ballast size. See :ref:`otel-sizing` for more information.
123
+
- ``512``
124
+
* - ``mode``
125
+
- Configure the Collectorservice to run in host monitoring (``agent``) or data forwarding (``gateway``).
126
+
- ``agent``
127
+
* - ``network_interface``
128
+
- The network interface the Collectorreceivers listen on.
129
+
- ``0.0.0.0``
130
+
* - ``ingest_url``
131
+
- Set the base ingest URL explicitly instead of the URL inferred from the specified realm.
132
+
- ``https://ingest.REALM.signalfx.com``
133
+
* - ``api_url``
134
+
- Set the base API URL explicitly instead of the URL inferred from the specified realm.
135
+
- ``https://api.REALM.signalfx.com``
136
+
* - ``trace_url``
137
+
- Set the trace endpoint URL explicitly instead of the endpoint inferred from the specified realm.
138
+
- ``https://ingest.REALM.signalfx.com/v2/trace``
139
+
* - ``hec_url``
140
+
- Set the HEC endpoint URL explicitly instead of the endpoint inferred from the specified realm.
141
+
- ``https://ingest.REALM.signalfx.com/v1/log``
142
+
* - ``hec_token``
143
+
- Set the HEC token if it's different than the specified Splunk access token.
144
+
-
145
+
- ``$false``
146
+
* - ``with_dotnet_instrumentation``
147
+
- Whether to install and configure .NET tracing to forward .NET application traces to the local collector.
148
+
- ``$false``
149
+
* - ``deployment_env``
150
+
- A system-wide environment tag used by .NET instrumentation. Sets the ``SIGNALFX_ENV`` environment variable. Ignored if ``-with_dotnet_instrumentation`` is set to ``false``.
151
+
-
152
+
* - ``bundle_dir``
153
+
- The location of your Smart Agent bundle for monitor functionality.
- If true then certificates aren't checked when downloading resources.
157
+
- ``$false``
158
+
* - ``collector_version``
159
+
- Specify a specific version of the Collector to install.
160
+
- Latest version available
161
+
* - ``stage``
162
+
- The package stage to install from [``test``, ``beta``, ``release``].
163
+
- ``release``
164
+
* - ``collector_msi_url``
165
+
- When installing the Collector, instead of downloading the package, use this local path to a Splunk OpenTelemetry Collector MSI package. If specified, the ``-collector_version`` and ``-stage`` parameters are ignored.
- Specify a local path to a Splunk OpenTelemetry Collector MSI package to install instead of downloading the package. If specified, the ``-collector_version`` and ``-stage`` parameters will be ignored.
169
+
-
170
+
* - ``msi_public_properties``
171
+
- Specify public MSI properties to be used when installing the Splunk OpenTelemetry Collector MSI package.
0 commit comments