Skip to content

Commit 2c59550

Browse files
crobert-1crobert-1
authored
[gateway] Remove signalfx receiver from gateway configs (#6887)
* [gateway] Remove signalfx receiver from gateway configs * add changelog * Remove signalfx receiver from nomad pipelines * update expected config in test * add extension to service in test * Add note about signalfx receiver deprecation * changes requested by copilot - Add missing extension to default Nomad gateway config - Fix indentation in default gateway config
1 parent f0d8275 commit 2c59550

File tree

6 files changed

+67
-63
lines changed

6 files changed

+67
-63
lines changed

‎.chloggen/remove_sfx_receiver_gateway.yaml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
2+
change_type: breaking
3+
4+
# The name of the component, or a single word describing the area of concern, (e.g. crosslink)
5+
component: gateway
6+
7+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
8+
note: Remove SignalFx receiver from the default gateway config in favor of the HTTP forwarder extension
9+
10+
# One or more tracking issues related to the change
11+
issues: [6887]
12+
13+
# (Optional) One or more lines of additional information to render under the primary note.
14+
# These lines will be padded with 2 spaces and then inserted directly into the document.
15+
# Use pipe (|) for multiline entries.
16+
subtext: |
17+
This change means that metrics and logs sent to the gateway in the SignalFx format
18+
will no longer be subject to the batch and memory limiter processors configured in
19+
the gateway pipelines. Please ensure any required memory limiting or batching is
20+
configured on the sending side (e.g. the agent). Please note that the `signalfx` receiver
21+
will eventually be deprecated and removed.

‎cmd/otelcol/config/collector/gateway_config.yaml‎

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ extensions:
1515
endpoint: "${SPLUNK_LISTEN_INTERFACE}:6060"
1616
egress:
1717
endpoint: "https://api.${SPLUNK_REALM}.signalfx.com"
18+
http_forwarder/signalfx:
19+
ingress:
20+
endpoint: "${SPLUNK_LISTEN_INTERFACE}:9943"
21+
# Whether to propagate the client metadata from the incoming requests to the backend.
22+
# Should be enabled to preserve incoming access token
23+
# include_metadata: true
24+
egress:
25+
endpoint: "https://ingest.${SPLUNK_REALM}.signalfx.com"
1826
zpages:
1927
endpoint: "${SPLUNK_LISTEN_INTERFACE}:55679"
2028
expvar:
@@ -57,11 +65,6 @@ receivers:
5765
- source_labels: [ __name__ ]
5866
regex: 'otelcol_processor_batch_.*'
5967
action: drop
60-
signalfx:
61-
endpoint: "${SPLUNK_LISTEN_INTERFACE}:9943"
62-
# Whether to propagate the client metadata from the incoming requests to the downstream consumers
63-
# Should be enabled to preserve incoming access token and use instead of exporter token
64-
#include_metadata: true
6568
zipkin:
6669
endpoint: "${SPLUNK_LISTEN_INTERFACE}:9411"
6770

@@ -116,10 +119,6 @@ exporters:
116119
realm: "${SPLUNK_REALM}"
117120
sending_queue:
118121
num_consumers: 32
119-
## Uncomment below if your agents are sending via signalfx exporter
120-
## to avoid double translations and exclusions.
121-
#translation_rules: []
122-
#exclude_metrics: []
123122
signalfx/internal:
124123
access_token: "${SPLUNK_ACCESS_TOKEN}"
125124
realm: "${SPLUNK_REALM}"
@@ -157,7 +156,7 @@ connectors:
157156
pipelines: [logs/entities]
158157

159158
service:
160-
extensions: [headers_setter, health_check, http_forwarder, zpages]
159+
extensions: [headers_setter, health_check, http_forwarder, http_forwarder/signalfx, zpages]
161160
pipelines:
162161
traces:
163162
receivers: [jaeger, otlp, zipkin]
@@ -167,17 +166,13 @@ service:
167166
#- resource/add_environment
168167
exporters: [otlphttp]
169168
metrics:
170-
receivers: [otlp, signalfx]
169+
receivers: [otlp]
171170
processors: [memory_limiter, batch]
172171
exporters: [signalfx]
173172
metrics/internal:
174173
receivers: [prometheus/internal]
175174
processors: [memory_limiter, batch, resourcedetection/internal, resource/add_mode]
176175
exporters: [signalfx/internal]
177-
logs/signalfx:
178-
receivers: [signalfx]
179-
processors: [memory_limiter, batch]
180-
exporters: [signalfx]
181176
logs:
182177
receivers: [routing/logs]
183178
processors: [memory_limiter, batch]

‎cmd/otelcol/fips/config/gateway_config.yaml‎

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ extensions:
1515
endpoint: "${SPLUNK_LISTEN_INTERFACE}:6060"
1616
egress:
1717
endpoint: "https://api.${SPLUNK_REALM}.signalfx.com"
18+
http_forwarder/signalfx:
19+
ingress:
20+
endpoint: "${SPLUNK_LISTEN_INTERFACE}:9943"
21+
# Whether to propagate the client metadata from the incoming requests to the backend.
22+
# Should be enabled to preserve incoming access token
23+
# include_metadata: true
24+
egress:
25+
endpoint: "https://ingest.${SPLUNK_REALM}.signalfx.com"
1826
zpages:
1927
endpoint: "${SPLUNK_LISTEN_INTERFACE}:55679"
2028
expvar:
@@ -57,11 +65,6 @@ receivers:
5765
- source_labels: [ __name__ ]
5866
regex: 'otelcol_processor_batch_.*'
5967
action: drop
60-
signalfx:
61-
endpoint: "${SPLUNK_LISTEN_INTERFACE}:9943"
62-
# Whether to propagate the client metadata from the incoming requests to the downstream consumers
63-
# Should be enabled to preserve incoming access token and use instead of exporter token
64-
#include_metadata: true
6568
zipkin:
6669
endpoint: "${SPLUNK_LISTEN_INTERFACE}:9411"
6770

@@ -109,10 +112,6 @@ exporters:
109112
realm: "${SPLUNK_REALM}"
110113
sending_queue:
111114
num_consumers: 32
112-
## Uncomment below if your agents are sending via signalfx exporter
113-
## to avoid double translations and exclusions.
114-
#translation_rules: []
115-
#exclude_metrics: []
116115
signalfx/internal:
117116
access_token: "${SPLUNK_ACCESS_TOKEN}"
118117
realm: "${SPLUNK_REALM}"
@@ -134,7 +133,7 @@ exporters:
134133
log_data_enabled: false
135134

136135
service:
137-
extensions: [headers_setter, health_check, http_forwarder, zpages]
136+
extensions: [headers_setter, health_check, http_forwarder, http_forwarder/signalfx, zpages]
138137
pipelines:
139138
traces:
140139
receivers: [jaeger, otlp, zipkin]
@@ -144,17 +143,13 @@ service:
144143
#- resource/add_environment
145144
exporters: [otlphttp]
146145
metrics:
147-
receivers: [otlp, signalfx]
146+
receivers: [otlp]
148147
processors: [memory_limiter, batch]
149148
exporters: [signalfx]
150149
metrics/internal:
151150
receivers: [prometheus/internal]
152151
processors: [memory_limiter, batch, resourcedetection/internal]
153152
exporters: [signalfx/internal]
154-
logs/signalfx:
155-
receivers: [signalfx]
156-
processors: [memory_limiter, batch]
157-
exporters: [signalfx]
158153
logs:
159154
receivers: [otlp]
160155
processors: [memory_limiter, batch]

‎deployments/nomad/otel-gateway.nomad‎

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,12 @@ extensions:
146146
http_forwarder:
147147
egress:
148148
endpoint: https://api.${SPLUNK_REALM}.signalfx.com
149+
http_forwarder/signalfx:
150+
ingress:
151+
endpoint: 0.0.0.0:9943
152+
include_metadata: true
153+
egress:
154+
endpoint: https://ingest.${SPLUNK_REALM}.signalfx.com
149155
zpages: null
150156
receivers:
151157
jaeger:
@@ -160,9 +166,6 @@ receivers:
160166
endpoint: 0.0.0.0:4317
161167
http:
162168
endpoint: 0.0.0.0:4318
163-
signalfx:
164-
include_metadata: true
165-
endpoint: 0.0.0.0:9943
166169
zipkin:
167170
endpoint: 0.0.0.0:9411
168171
prometheus/collector:
@@ -199,17 +202,9 @@ service:
199202
extensions:
200203
- health_check
201204
- http_forwarder
205+
- http_forwarder/signalfx
202206
- zpages
203207
pipelines:
204-
logs/signalfx-events:
205-
exporters:
206-
- signalfx
207-
- debug
208-
processors:
209-
- memory_limiter
210-
- batch
211-
receivers:
212-
- signalfx
213208
metrics:
214209
exporters:
215210
- signalfx
@@ -219,7 +214,6 @@ service:
219214
- batch
220215
receivers:
221216
- otlp
222-
- signalfx
223217
traces:
224218
exporters:
225219
- otlphttp

‎packaging/technical-addon/Splunk_TA_otel/configs/ta-gateway-config.yaml‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ extensions:
1515
endpoint: "${env:SPLUNK_LISTEN_INTERFACE}:6060"
1616
egress:
1717
endpoint: "https://api.${env:SPLUNK_REALM}.signalfx.com"
18+
http_forwarder/signalfx:
19+
ingress:
20+
endpoint: "${env:SPLUNK_LISTEN_INTERFACE}:9943"
21+
# Whether to propagate the client metadata from the incoming requests to the backend.
22+
# Should be enabled to preserve incoming access token
23+
# include_metadata: true
24+
egress:
25+
endpoint: "https://ingest.${env:SPLUNK_REALM}.signalfx.com"
1826
zpages:
1927
endpoint: "${env:SPLUNK_LISTEN_INTERFACE}:55679"
2028
expvar:
@@ -57,11 +65,6 @@ receivers:
5765
- source_labels: [ __name__ ]
5866
regex: 'otelcol_processor_batch_.*'
5967
action: drop
60-
signalfx:
61-
endpoint: "${env:SPLUNK_LISTEN_INTERFACE}:9943"
62-
# Whether to propagate the client metadata from the incoming requests to the downstream consumers
63-
# Should be enabled to preserve incoming access token and use instead of exporter token
64-
#include_metadata: true
6568
zipkin:
6669
endpoint: "${env:SPLUNK_LISTEN_INTERFACE}:9411"
6770

@@ -142,14 +145,10 @@ service:
142145
#- resource/add_environment
143146
exporters: [otlphttp]
144147
metrics:
145-
receivers: [otlp, signalfx]
148+
receivers: [otlp]
146149
processors: [memory_limiter, batch]
147150
exporters: [signalfx]
148151
metrics/internal:
149152
receivers: [prometheus/internal]
150153
processors: [memory_limiter, batch, resourcedetection/internal, resource/telemetry]
151154
exporters: [signalfx/internal]
152-
logs/signalfx:
153-
receivers: [signalfx]
154-
processors: [memory_limiter, batch]
155-
exporters: [signalfx]

‎tests/general/default_config_test.go‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,14 @@ func TestDefaultGatewayConfig(t *testing.T) {
126126
"endpoint": fmt.Sprintf("%s:6060", ip),
127127
},
128128
},
129+
"http_forwarder/signalfx": map[string]any{
130+
"egress": map[string]any{
131+
"endpoint": "https://ingest.not.real.signalfx.com",
132+
},
133+
"ingress": map[string]any{
134+
"endpoint": fmt.Sprintf("%s:9943", ip),
135+
},
136+
},
129137
"zpages": map[string]any{
130138
"endpoint": fmt.Sprintf("%s:55679", ip),
131139
"expvar": map[string]any{
@@ -197,9 +205,6 @@ func TestDefaultGatewayConfig(t *testing.T) {
197205
},
198206
},
199207
},
200-
"signalfx": map[string]any{
201-
"endpoint": fmt.Sprintf("%s:9943", ip),
202-
},
203208
"zipkin": map[string]any{
204209
"endpoint": fmt.Sprintf("%s:9411", ip),
205210
},
@@ -217,18 +222,13 @@ func TestDefaultGatewayConfig(t *testing.T) {
217222
},
218223
},
219224
"service": map[string]any{
220-
"extensions": []any{"headers_setter", "health_check", "http_forwarder", "zpages"},
225+
"extensions": []any{"headers_setter", "health_check", "http_forwarder", "http_forwarder/signalfx", "zpages"},
221226
"pipelines": map[string]any{
222227
"logs": map[string]any{
223228
"exporters": []any{"splunk_hec", "splunk_hec/profiling"},
224229
"processors": []any{"memory_limiter", "batch"},
225230
"receivers": []any{"routing/logs"},
226231
},
227-
"logs/signalfx": map[string]any{
228-
"exporters": []any{"signalfx"},
229-
"processors": []any{"memory_limiter", "batch"},
230-
"receivers": []any{"signalfx"},
231-
},
232232
"logs/entities": map[string]any{
233233
"exporters": []any{"otlphttp/entities"},
234234
"processors": []any{"memory_limiter", "batch"},
@@ -241,7 +241,7 @@ func TestDefaultGatewayConfig(t *testing.T) {
241241
"metrics": map[string]any{
242242
"exporters": []any{"signalfx"},
243243
"processors": []any{"memory_limiter", "batch"},
244-
"receivers": []any{"otlp", "signalfx"},
244+
"receivers": []any{"otlp"},
245245
},
246246
"metrics/internal": map[string]any{
247247
"exporters": []any{"signalfx/internal"},

0 commit comments

Comments
 (0)