deprecate signalfx-forwarder (#4039)

Author: atoulme

cmd/otelcol/config/collector/agent_config.yaml

@@ -83,9 +83,6 @@ receivers:
           - source_labels: [ __name__ ]
             regex: 'otelcol_processor_batch_.*'
             action: drop
-  smartagent/signalfx-forwarder:
-    type: signalfx-forwarder
-    listenAddress: "${SPLUNK_LISTEN_INTERFACE}:9080"
   smartagent/processlist:
     type: processlist
   signalfx:
@@ -168,7 +165,7 @@ service:
   extensions: [health_check, http_forwarder, zpages, smartagent]
   pipelines:
     traces:
-      receivers: [jaeger, otlp, smartagent/signalfx-forwarder, zipkin]
+      receivers: [jaeger, otlp, zipkin]
       processors:
       - memory_limiter
       - batch
@@ -178,7 +175,7 @@ service:
       # Use instead when sending to gateway
       #exporters: [otlp, signalfx]
     metrics:
-      receivers: [hostmetrics, otlp, signalfx, smartagent/signalfx-forwarder]
+      receivers: [hostmetrics, otlp, signalfx]
       processors: [memory_limiter, batch, resourcedetection]
       exporters: [signalfx]
       # Use instead when sending to gateway

cmd/otelcol/config/collector/ecs_ec2_config.yaml

@@ -77,9 +77,6 @@ receivers:
     #access_token_passthrough: true
   zipkin:
     endpoint: 0.0.0.0:9411
-  smartagent/signalfx-forwarder:
-    type: signalfx-forwarder
-    listenAddress: 0.0.0.0:9080
   smartagent/ecs-metadata:
     type: ecs-metadata
     metadataEndpoint: "${env:ECS_TASK_METADATA_ENDPOINT}"
@@ -147,15 +144,15 @@ service:
   extensions: [health_check, http_forwarder, zpages]
   pipelines:
     traces:
-      receivers: [jaeger, otlp, zipkin, smartagent/signalfx-forwarder]
+      receivers: [jaeger, otlp, zipkin]
       processors:
         - memory_limiter
         - batch
         - resourcedetection
         #- resource/add_environment
       exporters: [sapm, signalfx]
     metrics:
-      receivers: [hostmetrics, otlp, signalfx, smartagent/signalfx-forwarder, smartagent/ecs-metadata]
+      receivers: [hostmetrics, otlp, signalfx, smartagent/ecs-metadata]
       processors: [memory_limiter, batch, filter, resourcedetection]
       exporters: [signalfx]
     metrics/internal:

cmd/otelcol/config/collector/fargate_config.yaml

@@ -56,9 +56,6 @@ receivers:
     #access_token_passthrough: true
   zipkin:
     endpoint: 0.0.0.0:9411
-  smartagent/signalfx-forwarder:
-    type: signalfx-forwarder
-    listenAddress: 0.0.0.0:9080
   smartagent/ecs-metadata:
     type: ecs-metadata
     excludedImages: ${env:ECS_METADATA_EXCLUDED_IMAGES}
@@ -121,15 +118,15 @@ service:
   extensions: [health_check, http_forwarder, zpages]
   pipelines:
     traces:
-      receivers: [jaeger, otlp, zipkin, smartagent/signalfx-forwarder]
+      receivers: [jaeger, otlp, zipkin]
       processors:
         - memory_limiter
         - batch
         - resourcedetection
         #- resource/add_environment
       exporters: [sapm, signalfx]
     metrics:
-      receivers: [otlp, signalfx, smartagent/signalfx-forwarder, smartagent/ecs-metadata, prometheus/internal]
+      receivers: [otlp, signalfx, smartagent/ecs-metadata, prometheus/internal]
       processors: [memory_limiter, batch, resourcedetection]
       exporters: [signalfx]
     logs:

cmd/otelcol/config/collector/full_config_linux.yaml

@@ -81,12 +81,6 @@ receivers:
     # default = false
     #access_token_passthrough: true
 
-  # Enables the Smart Agent's SignalFx Forwarder with default settings
-  # - listenAddress: 127.0.0.1:9080
-  # - serverTimeout: 5 (seconds)
-  smartagent/signalfx-forwarder:
-    type: signalfx-forwarder
-
   # Enables the zipkin receiver with default settings
   #  - grpc (default endpoint = 0.0.0.0:9411)
   # Full configuration here: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/zipkinreceiver
@@ -771,14 +765,14 @@ service:
   # NOTE: Receivers expose ports so ensure no other application uses the same ports
   pipelines:
     traces:
-      receivers: [jaeger, otlp, smartagent/signalfx-forwarder, zipkin]
+      receivers: [jaeger, otlp, zipkin]
       processors:
       - memory_limiter
       - batch
       #- resource/add_environment
       exporters: [sapm, signalfx]
     metrics:
-      receivers: [otlp, signalfx, smartagent/signalfx-forwarder]
+      receivers: [otlp, signalfx]
       processors: [memory_limiter, batch]
       exporters: [signalfx]
     metrics/internal:

cmd/otelcol/config/collector/otlp_config_linux.yaml

@@ -44,12 +44,6 @@ receivers:
     #access_token_passthrough: true
   signalfx:
     endpoint: 0.0.0.0:9943
-    # Whether to preserve incoming access token and use instead of exporter token
-    # default = false
-    #access_token_passthrough: true
-  smartagent/signalfx-forwarder:
-    type: signalfx-forwarder
-    listenAddress: 0.0.0.0:9080
   zipkin:
     endpoint: 0.0.0.0:9411
 
@@ -109,14 +103,14 @@ service:
   extensions: [health_check, http_forwarder, zpages]
   pipelines:
     traces:
-      receivers: [jaeger, otlp, smartagent/signalfx-forwarder, zipkin]
+      receivers: [jaeger, otlp, zipkin]
       processors:
       - memory_limiter
       - batch
       #- resource/add_environment
       exporters: [otlphttp, signalfx]
     metrics:
-      receivers: [otlp, signalfx, smartagent/signalfx-forwarder]
+      receivers: [otlp, signalfx]
       processors: [memory_limiter, batch]
       exporters: [signalfx]
     metrics/internal:

deployments/nomad/otel-agent.nomad

@@ -186,9 +186,6 @@ receivers:
           - ${HOSTNAME}:8889
   signalfx:
     endpoint: 0.0.0.0:9943
-  smartagent/signalfx-forwarder:
-    listenAddress: 0.0.0.0:9080
-    type: signalfx-forwarder
   zipkin:
     endpoint: 0.0.0.0:9411
 processors:
@@ -253,7 +250,6 @@ service:
       receivers:
       - otlp
       - jaeger
-      - smartagent/signalfx-forwarder
       - zipkin
 EOF
         destination = "local/config/otel-agent-config.yaml"

internal/signalfx-agent/pkg/monitors/forwarder/metadata.yaml

@@ -10,6 +10,9 @@ monitors:
 
     The `defaultSpanTagsFromEndpoint` and `extraSpanTagsFromEndpoint` config
     options are not compatible with the `signalfx-forwarder` monitor.
+    
+    **This monitor is deprecated, the [otlpreceiver](https://github.com/open-telemetry/opentelemetry-collector/tree/main/receiver/otlpreceiver)
+    should be used instead.**
   metrics:
   monitorType: signalfx-forwarder
   properties:

internal/signalfx-agent/pkg/monitors/forwarder/monitor.go

@@ -46,6 +46,7 @@ type Monitor struct {
 func (m *Monitor) Configure(conf *Config) error {
 	m.logger = utils.NewThrottledLogger(logrus.WithFields(logrus.Fields{"monitorType": monitorType, "monitorID": conf.MonitorID}), 30*time.Second)
 	m.golibLogger = &utils.LogrusGolibShim{FieldLogger: m.logger.FieldLogger}
+	m.logger.Warn("The `signalfx-forwarder` is deprecated and will be removed in a future release. Please use the signalfx receiver instead.")
 
 	var ctx context.Context
 	ctx, m.cancel = context.WithCancel(context.Background())

pkg/receiver/smartagentreceiver/README.md

@@ -29,12 +29,6 @@ of your Collector configuration.
 1. Instead of using `discoveryRule`, use the Collector's
 [Receiver Creator](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/receivercreator/README.md)
 and [Observer extensions](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/observer/README.md).
-1. If you're using a [SignalFx Forwarder](https://github.com/signalfx/signalfx-agent/blob/main/docs/monitors/signalfx-forwarder.md)
-monitor, add it to both a `traces` and a `metrics` pipeline, and use a
-[Sapm exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/sapmexporter/README.md)
-and a 
-[SignalFx exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/signalfxexporter/README.md),
-as each pipeline's exporter, respectively.
 1. To replace or modify metrics, use
 [Collector processors](https://github.com/open-telemetry/opentelemetry-collector/blob/main/processor/README.md).
 1. If you have a monitor that sends [events](https://dev.splunk.com/observability/docs/datamodel/custom_events) (e.g. `kubernetes-events`,
@@ -53,8 +47,6 @@ Example:
 
 ```yaml
 receivers:
-  smartagent/signalfx-forwarder:
-    type: signalfx-forwarder
   smartagent/postgresql:
     type: postgresql
     host: mypostgresinstance
@@ -89,7 +81,6 @@ service:
       receivers:
         - smartagent/postgresql
         - smartagent/kafka
-        - smartagent/signalfx-forwarder
       processors:
         - resourcedetection
       exporters:
@@ -103,7 +94,7 @@ service:
         - signalfx
     traces:
       receivers:
-        - smartagent/signalfx-forwarder
+        - otlp
       processors:
         - resourcedetection
       exporters:

tests/general/default_config_test.go

@@ -362,11 +362,7 @@ func TestDefaultAgentConfig(t *testing.T) {
 					},
 					"signalfx":               map[string]any{"endpoint": fmt.Sprintf("%s:9943", ip)},
 					"smartagent/processlist": map[string]any{"type": "processlist"},
-					"smartagent/signalfx-forwarder": map[string]any{
-						"listenAddress": fmt.Sprintf("%s:9080", ip),
-						"type":          "signalfx-forwarder",
-					},
-					"zipkin": map[string]any{"endpoint": fmt.Sprintf("%s:9411", ip)}},
+					"zipkin":                 map[string]any{"endpoint": fmt.Sprintf("%s:9411", ip)}},
 				"service": map[string]any{
 					"telemetry":  map[string]any{"metrics": map[string]any{"address": fmt.Sprintf("%s:8888", ip)}},
 					"extensions": []any{"health_check", "http_forwarder", "zpages", "smartagent"},
@@ -382,15 +378,15 @@ func TestDefaultAgentConfig(t *testing.T) {
 						"metrics": map[string]any{
 							"exporters":  []any{"signalfx"},
 							"processors": []any{"memory_limiter", "batch", "resourcedetection"},
-							"receivers":  []any{"hostmetrics", "otlp", "signalfx", "smartagent/signalfx-forwarder"}},
+							"receivers":  []any{"hostmetrics", "otlp", "signalfx"}},
 						"metrics/internal": map[string]any{
 							"exporters":  []any{"signalfx"},
 							"processors": []any{"memory_limiter", "batch", "resourcedetection"},
 							"receivers":  []any{"prometheus/internal"}},
 						"traces": map[string]any{
 							"exporters":  []any{"sapm", "signalfx"},
 							"processors": []any{"memory_limiter", "batch", "resourcedetection"},
-							"receivers":  []any{"jaeger", "otlp", "smartagent/signalfx-forwarder", "zipkin"},
+							"receivers":  []any{"jaeger", "otlp", "zipkin"},
 						},
 					},
 				},