From 39e13693759589120ba1f1add57d55afcd53eaa9 Mon Sep 17 00:00:00 2001 From: Antoine Toulme Date: Fri, 8 Dec 2023 14:54:27 -0800 Subject: [PATCH] deprecate signalfx-forwarder --- cmd/otelcol/config/collector/agent_config.yaml | 7 ++----- cmd/otelcol/config/collector/ecs_ec2_config.yaml | 7 ++----- cmd/otelcol/config/collector/fargate_config.yaml | 7 ++----- cmd/otelcol/config/collector/full_config_linux.yaml | 10 ++-------- cmd/otelcol/config/collector/otlp_config_linux.yaml | 10 ++-------- deployments/nomad/otel-agent.nomad | 4 ---- .../pkg/monitors/forwarder/metadata.yaml | 3 +++ .../signalfx-agent/pkg/monitors/forwarder/monitor.go | 1 + pkg/receiver/smartagentreceiver/README.md | 11 +---------- tests/general/default_config_test.go | 10 +++------- 10 files changed, 18 insertions(+), 52 deletions(-) diff --git a/cmd/otelcol/config/collector/agent_config.yaml b/cmd/otelcol/config/collector/agent_config.yaml index 1930c78037..a87622988e 100644 --- a/cmd/otelcol/config/collector/agent_config.yaml +++ b/cmd/otelcol/config/collector/agent_config.yaml @@ -82,9 +82,6 @@ receivers: - source_labels: [ __name__ ] regex: '.*grpc_io.*' action: drop - smartagent/signalfx-forwarder: - type: signalfx-forwarder - listenAddress: "${SPLUNK_LISTEN_INTERFACE}:9080" smartagent/processlist: type: processlist signalfx: @@ -167,7 +164,7 @@ service: extensions: [health_check, http_forwarder, zpages, memory_ballast, smartagent] pipelines: traces: - receivers: [jaeger, otlp, smartagent/signalfx-forwarder, zipkin] + receivers: [jaeger, otlp, zipkin] processors: - memory_limiter - batch @@ -177,7 +174,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 diff --git a/cmd/otelcol/config/collector/ecs_ec2_config.yaml b/cmd/otelcol/config/collector/ecs_ec2_config.yaml index 2505418442..9cceea9c7b 100644 --- a/cmd/otelcol/config/collector/ecs_ec2_config.yaml +++ b/cmd/otelcol/config/collector/ecs_ec2_config.yaml @@ -76,9 +76,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}" @@ -146,7 +143,7 @@ service: extensions: [health_check, http_forwarder, zpages, memory_ballast] pipelines: traces: - receivers: [jaeger, otlp, zipkin, smartagent/signalfx-forwarder] + receivers: [jaeger, otlp, zipkin] processors: - memory_limiter - batch @@ -154,7 +151,7 @@ service: #- 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: diff --git a/cmd/otelcol/config/collector/fargate_config.yaml b/cmd/otelcol/config/collector/fargate_config.yaml index 54cffdac16..142d280be1 100644 --- a/cmd/otelcol/config/collector/fargate_config.yaml +++ b/cmd/otelcol/config/collector/fargate_config.yaml @@ -55,9 +55,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} @@ -120,7 +117,7 @@ service: extensions: [health_check, http_forwarder, zpages, memory_ballast] pipelines: traces: - receivers: [jaeger, otlp, zipkin, smartagent/signalfx-forwarder] + receivers: [jaeger, otlp, zipkin] processors: - memory_limiter - batch @@ -128,7 +125,7 @@ service: #- 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: diff --git a/cmd/otelcol/config/collector/full_config_linux.yaml b/cmd/otelcol/config/collector/full_config_linux.yaml index c808925f2d..97fa15be6a 100644 --- a/cmd/otelcol/config/collector/full_config_linux.yaml +++ b/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 @@ -776,14 +770,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: diff --git a/cmd/otelcol/config/collector/otlp_config_linux.yaml b/cmd/otelcol/config/collector/otlp_config_linux.yaml index 7778fb703f..3dd7dad23b 100644 --- a/cmd/otelcol/config/collector/otlp_config_linux.yaml +++ b/cmd/otelcol/config/collector/otlp_config_linux.yaml @@ -38,12 +38,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 @@ -108,14 +102,14 @@ service: extensions: [health_check, http_forwarder, zpages, memory_ballast] 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: diff --git a/deployments/nomad/otel-agent.nomad b/deployments/nomad/otel-agent.nomad index 6eb642c816..651f79c4c5 100644 --- a/deployments/nomad/otel-agent.nomad +++ b/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" diff --git a/internal/signalfx-agent/pkg/monitors/forwarder/metadata.yaml b/internal/signalfx-agent/pkg/monitors/forwarder/metadata.yaml index e1b601950c..e019d8fc94 100644 --- a/internal/signalfx-agent/pkg/monitors/forwarder/metadata.yaml +++ b/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: diff --git a/internal/signalfx-agent/pkg/monitors/forwarder/monitor.go b/internal/signalfx-agent/pkg/monitors/forwarder/monitor.go index e68cdc296b..d19370eedb 100644 --- a/internal/signalfx-agent/pkg/monitors/forwarder/monitor.go +++ b/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()) diff --git a/pkg/receiver/smartagentreceiver/README.md b/pkg/receiver/smartagentreceiver/README.md index 99cdb4f9c3..8bf2ac4dd2 100644 --- a/pkg/receiver/smartagentreceiver/README.md +++ b/pkg/receiver/smartagentreceiver/README.md @@ -27,12 +27,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`, @@ -51,8 +45,6 @@ Example: ```yaml receivers: - smartagent/signalfx-forwarder: - type: signalfx-forwarder smartagent/postgresql: type: postgresql host: mypostgresinstance @@ -87,7 +79,6 @@ service: receivers: - smartagent/postgresql - smartagent/kafka - - smartagent/signalfx-forwarder processors: - resourcedetection exporters: @@ -101,7 +92,7 @@ service: - signalfx traces: receivers: - - smartagent/signalfx-forwarder + - otlp processors: - resourcedetection exporters: diff --git a/tests/general/default_config_test.go b/tests/general/default_config_test.go index 22f3b36c57..4e74bdd258 100644 --- a/tests/general/default_config_test.go +++ b/tests/general/default_config_test.go @@ -346,11 +346,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", "memory_ballast", "smartagent"}, @@ -366,7 +362,7 @@ 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"}, @@ -374,7 +370,7 @@ func TestDefaultAgentConfig(t *testing.T) { "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"}, }, }, },