Document signalfx-forwarder as metric and trace receiver

signalfx · Mar 31, 2021 · d94ad33 · d94ad33
1 parent 75483af
commit d94ad33
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/docs/signalfx-smart-agent-migration.md b/docs/signalfx-smart-agent-migration.md
@@ -6,8 +6,8 @@ for the [SignalFx Smart Agent](https://github.com/signalfx/signalfx-agent).
 This distribution provides helpful components to assist current Smart Agent
 users in their transition to OpenTelemetry Collector and ensure no functionality
 loss.  The [Smart Agent
-Receiver](./internal/receiver/smartagentreceiver/README.md), its associated
-[extension](./internal/extension/smartagentextension/README.md), and other
+Receiver](../internal/receiver/smartagentreceiver/README.md), its associated
+[extension](../internal/extension/smartagentextension/README.md), and other
 Collector components provide a means of integrating all Smart Agent metric
 monitors into your Collector pipelines.
 
@@ -57,8 +57,8 @@ monitors:
 
 Below is an equivalent, recommended Collector configuration.  Notice that the
 `signalfx-forwarder` monitor's associated `smartagent/signalfx-forwarder` receiver instance
-is part of a `traces` pipeline using the `sapm` exporter.  The additional metric
-monitors utilize the
+is part of both `metrics` and `traces` pipelines using the `signalfx` and `sapm` exporters,
+respectively. The additional metric monitors utilize the
 [Receiver Creator](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/master/receiver/receivercreator/README.md):
 
 ```yaml
@@ -134,6 +134,7 @@ service:
     metrics:
       receivers:
         - receivor_creator
+        - smartagent/signalfx-forwarder
       processors:
         - resourcedetection
       exporters:

diff --git a/internal/receiver/smartagentreceiver/README.md b/internal/receiver/smartagentreceiver/README.md
@@ -16,8 +16,9 @@ Each `smartagent` receiver configuration acts a drop-in replacement for each sup
 and associated [Observer extensions](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/master/extension/observer/README.md)
 should be used.
 1. The [`signalfx-forwarder`](https://github.com/signalfx/signalfx-agent/blob/master/docs/monitors/signalfx-forwarder.md)
-monitor should be made part of a `traces` pipeline utilizing the [`sapm`
-exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/sapmexporter/README.md)
+monitor should be made part of both `metrics` and `traces` pipelines utilizing the
+[`signalfx`](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/signalfxexporter/README.md)
+and [`sapm`](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/sapmexporter/README.md) exporters, respectively.
 1. All metric content replacement and transformation rules should utilize existing
 [Collector processors](https://github.com/open-telemetry/opentelemetry-collector/blob/master/processor/README.md).
 1. Monitors with [dimension property and tag update
@@ -76,6 +77,7 @@ service:
       receivers:
         - smartagent/postgresql
         - smartagent/kafka
+        - smartagent/signalfx-forwarder
       processors:
         - resourcedetection
       exporters: