Merge pull request #1767 from splunk/urbiz-OD24287-sfx-rx

[DG24287]: SignalFx receiver tweaks

Author: aurbiztondo-splunk

gdi/opentelemetry/components/signalfx-receiver.rst

@@ -7,26 +7,25 @@ SignalFx receiver
 .. meta::
       :description: The SignalFx receiver allows the Splunk Distribution of OpenTelemetry Collector to collect metrics and logs in SignalFx proto format.
 
-The SignalFx receiver is a native OTel component that allows the Splunk Distribution of OpenTelemetry Collector to collect metrics and logs in SignalFx proto format. Supported pipeline types are ``metrics`` and ``logs``. See :ref:`otel-data-processing` for more information.
-
-For more information on the SignalFx proto format, see :new-page:`Send Traces, Metrics, and Events <https://dev.splunk.com/observability/reference/api/ingest_data/latest>` in the Splunk Developer Program documentation.
+The SignalFx receiver is a native OpenTelemetry component that allows the Splunk Distribution of OpenTelemetry Collector to collect data in SignalFx proto format. Supported pipeline types are ``metrics`` and ``logs``. See :ref:`otel-data-processing` for more information.
 
 .. note:: While the SignalFx Smart Agent has reached End of Support, OTel native components such as the Smart Agent receiver, the SignalFx receiver, and the SignalFx exporter are available and supported. For information on the exporter, see :ref:`signalfx-exporter`.
 
+The SignalFx receiver accepts:
+
+* Metrics in the SignalFx proto format. For more information, see :new-page:`SignalFx metrics protobuf <https://github.com/signalfx/com_signalfx_metrics_protobuf>`.
+* Events (logs) in the SignalFx proto format. For more information, see :new-page:`Send Traces, Metrics, and Events <https://dev.splunk.com/observability/reference/api/ingest_data/latest>` in the Splunk Developer Program documentation.
+
 Get started
 ======================
 
 .. note:: 
 
-  This component is included in the default configuration of the Splunk Distribution of the OpenTelemetry Collector when deploying in host monitoring (agent) mode. See :ref:`otel-deployment-mode` for more information. 
+  This component is included in the default configuration of the Splunk Distribution of the OpenTelemetry Collector in the ``metrics`` and ``logs/signalfx`` pipelines when deploying in host monitoring (agent) mode. See :ref:`otel-deployment-mode` for more information. 
 
   For details about the default configuration, see :ref:`otel-kubernetes-config`, :ref:`linux-config-ootb`, or :ref:`windows-config-ootb`. You can customize your configuration any time as explained in this document.
 
-.. caution:: Don't remove the ``signalfx`` receiver from the default configuration. If you need to change its settings, use the existing receiver or create a separate receiver configuration.
-
-By default, the Splunk Distribution of OpenTelemetry Collector includes the SignalFx receiver in the ``metrics`` and ``logs/signalfx`` pipelines. 
-
-Follow these steps to configure and activate the component:
+Follow these steps to configure and activate the receiver:
 
 1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
 
@@ -40,6 +39,8 @@ Follow these steps to configure and activate the component:
 Default configuration
 ----------------------
 
+.. caution:: Don't remove the ``signalfx`` receiver from the default configuration. If you need to change its settings, use the existing receiver or create a separate receiver configuration.
+
 To use the ``signalfx`` receiver in the Splunk Distribution of the OpenTelemetry Collector, add the following to your config file:
 
 .. code-block:: yaml
@@ -48,8 +49,8 @@ To use the ``signalfx`` receiver in the Splunk Distribution of the OpenTelemetry
     signalfx:
       endpoint: 0.0.0.0:9943
       # Whether to preserve incoming access token and
-      #  use instead of exporter token. Default value is false.
-      #access_token_passthrough: true
+      # use instead of exporter token. Default value is false.
+      # access_token_passthrough: true
 
 Next, configure both the metrics and logs pipelines. Make sure to also add the SignalFx exporter as in the following example:
 
@@ -69,7 +70,7 @@ Next, configure both the metrics and logs pipelines. Make sure to also add the S
 Sample configuration
 --------------------------------------------
 
-This is a sample config for the receiver:
+This is a sample config for the SignalFx receiver:
 
 .. code-block:: yaml
 
@@ -93,7 +94,7 @@ The following table shows the configuration options for the SignalFx receiver:
 
   <div class="metrics-standard" category="included" url="https://raw.githubusercontent.com/splunk/collector-config-tools/main/cfg-metadata/receiver/signalfx.yaml"></div>
 
-.. caution:: If you use the ``access_token_passthrough`` setting with any exporter other than the SignalFx exporter, the receiver might reveal all organization access tokens. If you activate this seeting, you must use the SignalFx receiver with the SignalFx exporter.
+.. caution:: If you use the ``access_token_passthrough`` setting with any exporter other than the SignalFx exporter, the receiver might reveal all organization access tokens. If you activate this setting, you must use the SignalFx receiver with the SignalFx exporter.
 
 Troubleshooting
 ======================