Skip to content

Commit fa4eb76

Browse files
authored
Explicitly define receivers endpoints (signalfx#301)
For better user experience, we want to have default endpoint values always to be explicitly set in the configs, so user don't have to check receiver docs in order to find out which port data should be sent to.
1 parent 32c6bb6 commit fa4eb76

9 files changed

+78
-4
lines changed

cmd/otelcol/config/collector/agent_config.yaml

+12
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@
1313

1414
extensions:
1515
health_check:
16+
endpoint: 0.0.0.0:13133
1617
http_forwarder:
18+
ingress:
19+
endpoint: 0.0.0.0:6060
1720
egress:
1821
endpoint: "${SPLUNK_API_URL}"
1922
# Use instead when sending to gateway
@@ -47,13 +50,19 @@ receivers:
4750
jaeger:
4851
protocols:
4952
grpc:
53+
endpoint: 0.0.0.0:14250
5054
thrift_binary:
55+
endpoint: 0.0.0.0:6832
5156
thrift_compact:
57+
endpoint: 0.0.0.0:6831
5258
thrift_http:
59+
endpoint: 0.0.0.0:14268
5360
otlp:
5461
protocols:
5562
grpc:
63+
endpoint: 0.0.0.0:4317
5664
http:
65+
endpoint: 0.0.0.0:55681
5766
# This section is used to collect the OpenTelemetry Collector metrics
5867
# Even if just a Splunk APM customer, these metrics are included
5968
prometheus:
@@ -68,11 +77,14 @@ receivers:
6877
regex: '.*grpc_io.*'
6978
action: drop
7079
sapm:
80+
endpoint: 0.0.0.0:7276
7181
smartagent/signalfx-forwarder:
7282
type: signalfx-forwarder
7383
listenAddress: 0.0.0.0:9080
7484
signalfx:
85+
endpoint: 0.0.0.0:9943
7586
zipkin:
87+
endpoint: 0.0.0.0:9411
7688

7789
processors:
7890
batch:

cmd/otelcol/config/collector/full_config_linux.yaml

+12-2
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,9 @@ receivers:
3838
otlp:
3939
protocols:
4040
grpc:
41+
endpoint: 0.0.0.0:4317
4142
http:
43+
endpoint: 0.0.0.0:55681
4244

4345
#############################################################################
4446
# Traces
@@ -53,9 +55,13 @@ receivers:
5355
jaeger:
5456
protocols:
5557
grpc:
58+
endpoint: 0.0.0.0:14250
5659
thrift_binary:
60+
endpoint: 0.0.0.0:6832
5761
thrift_compact:
62+
endpoint: 0.0.0.0:6831
5863
thrift_http:
64+
endpoint: 0.0.0.0:14268
5965

6066
# Enables the kafka receiver with default settings
6167
# - brokers = localhost:9092
@@ -68,6 +74,7 @@ receivers:
6874
# - grpc (default endpoint = 0.0.0.0:7276)
6975
# Full configuration here: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/sapmreceiver
7076
sapm:
77+
endpoint: 0.0.0.0:7276
7178
#access_token_passthrough: true
7279

7380
# Enables the Smart Agent's SignalFx Forwarder with default settings
@@ -80,6 +87,7 @@ receivers:
8087
# - grpc (default endpoint = 0.0.0.0:9411)
8188
# Full configuration here: https://github.com/open-telemetry/opentelemetry-collector/tree/main/receiver/zipkinreceiver
8289
zipkin:
90+
endpoint: 0.0.0.0:9411
8391

8492
#############################################################################
8593
# Metrics
@@ -141,6 +149,7 @@ receivers:
141149
# - grpc (default endpoint = 0.0.0.0:9943)
142150
# Full configuration here: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/signalfxreceiver
143151
signalfx:
152+
endpoint: 0.0.0.0:9943
144153
#access_token_passthrough: true
145154

146155
#############################################################################
@@ -489,13 +498,14 @@ extensions:
489498
# Enables the health check extension
490499
# Full configuration here: https://github.com/open-telemetry/opentelemetry-collector/tree/main/extension/healthcheckextension
491500
health_check:
501+
endpoint: 0.0.0.0:13133
492502

493503
# Enables the http forwarder extension
494504
# Full configuration here: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/httpforwarder
495505
# TODO: Add realm
496506
http_forwarder:
497-
#ingress:
498-
# endpoint: 0.0.0.0:6060
507+
ingress:
508+
endpoint: 0.0.0.0:6060
499509
egress:
500510
endpoint: "https://api.${SPLUNK_REALM}.signalfx.com"
501511

cmd/otelcol/config/collector/gateway_config.yaml

+13-1
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,32 @@
33

44
extensions:
55
health_check:
6+
endpoint: 0.0.0.0:13133
67
http_forwarder:
8+
ingress:
9+
endpoint: 0.0.0.0:6060
710
egress:
811
endpoint: "https://api.${SPLUNK_REALM}.signalfx.com"
912
zpages:
10-
#endpoint: 0.0.0.0:55679
13+
endpoint: 0.0.0.0:55679
1114

1215
receivers:
1316
jaeger:
1417
protocols:
1518
grpc:
19+
endpoint: 0.0.0.0:14250
1620
thrift_binary:
21+
endpoint: 0.0.0.0:6832
1722
thrift_compact:
23+
endpoint: 0.0.0.0:6831
1824
thrift_http:
25+
endpoint: 0.0.0.0:14268
1926
otlp:
2027
protocols:
2128
grpc:
29+
endpoint: 0.0.0.0:4317
2230
http:
31+
endpoint: 0.0.0.0:55681
2332
# This section is used to collect the OpenTelemetry Collector metrics
2433
# Even if just a Splunk APM customer, these metrics are included
2534
prometheus:
@@ -34,8 +43,11 @@ receivers:
3443
regex: '.*grpc_io.*'
3544
action: drop
3645
sapm:
46+
endpoint: 0.0.0.0:7276
3747
signalfx:
48+
endpoint: 0.0.0.0:9943
3849
zipkin:
50+
endpoint: 0.0.0.0:9411
3951

4052
processors:
4153
batch:

cmd/otelcol/config/collector/otlp_config_linux.yaml

+13-1
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,19 @@ receivers:
55
jaeger:
66
protocols:
77
grpc:
8+
endpoint: 0.0.0.0:14250
89
thrift_binary:
10+
endpoint: 0.0.0.0:6832
911
thrift_compact:
12+
endpoint: 0.0.0.0:6831
1013
thrift_http:
14+
endpoint: 0.0.0.0:14268
1115
otlp:
1216
protocols:
1317
grpc:
18+
endpoint: 0.0.0.0:4317
1419
http:
20+
endpoint: 0.0.0.0:55681
1521
# This section is used to collect the OpenTelemetry Collector metrics
1622
# Even if just a Splunk APM customer, these metrics are included
1723
prometheus:
@@ -26,11 +32,14 @@ receivers:
2632
regex: '.*grpc_io.*'
2733
action: drop
2834
sapm:
35+
endpoint: 0.0.0.0:7276
2936
signalfx:
37+
endpoint: 0.0.0.0:9943
3038
smartagent/signalfx-forwarder:
3139
type: signalfx-forwarder
3240
listenAddress: 0.0.0.0:9080
3341
zipkin:
42+
endpoint: 0.0.0.0:9411
3443

3544
processors:
3645
batch:
@@ -73,11 +82,14 @@ exporters:
7382

7483
extensions:
7584
health_check:
85+
endpoint: 0.0.0.0:13133
7686
http_forwarder:
87+
ingress:
88+
endpoint: 0.0.0.0:6060
7789
egress:
7890
endpoint: "https://api.${SPLUNK_REALM}.signalfx.com"
7991
zpages:
80-
#endpoint: 0.0.0.0:55679
92+
endpoint: 0.0.0.0:55679
8193

8294
service:
8395
extensions: [health_check, http_forwarder, zpages]

examples/kubernetes-yaml/splunk-otel-collector-agent.yaml

+12
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ data:
1010
otel-collector-config: |
1111
extensions:
1212
health_check:
13+
endpoint: 0.0.0.0:13133
1314
http_forwarder:
15+
ingress:
16+
endpoint: 0.0.0.0:6060
1417
egress:
1518
# TODO: Ensure this is set properly
1619
endpoint: "https://api.${SPLUNK_REALM}.signalfx.com"
@@ -35,15 +38,23 @@ data:
3538
jaeger:
3639
protocols:
3740
grpc:
41+
endpoint: 0.0.0.0:14250
3842
thrift_binary:
43+
endpoint: 0.0.0.0:6832
3944
thrift_compact:
45+
endpoint: 0.0.0.0:6831
4046
thrift_http:
47+
endpoint: 0.0.0.0:14268
4148
otlp:
4249
protocols:
4350
grpc:
51+
endpoint: 0.0.0.0:4317
4452
http:
53+
endpoint: 0.0.0.0:55681
4554
sapm:
55+
endpoint: 0.0.0.0:7276
4656
signalfx:
57+
endpoint: 0.0.0.0:9943
4758
# This section is used to collect OpenTelemetry metrics
4859
# Even if just a SignalFx µAPM customer, these metrics are included
4960
prometheus:
@@ -64,6 +75,7 @@ data:
6475
# Enable Zipkin to support Istio Mixer Adapter
6576
# https://github.com/signalfx/signalfx-istio-adapter
6677
zipkin:
78+
endpoint: 0.0.0.0:9411
6779
processors:
6880
batch:
6981
# Optional: If you have a different environment tag name

examples/kubernetes-yaml/splunk-otel-collector-gateway.yaml

+12
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ data:
1010
otel-collector-config: |
1111
extensions:
1212
health_check:
13+
endpoint: 0.0.0.0:13133
1314
http_forwarder:
15+
ingress:
16+
endpoint: 0.0.0.0:6060
1417
egress:
1518
# TODO: Ensure this is set properly
1619
endpoint: "https://api.${SPLUNK_REALM}.signalfx.com"
@@ -35,15 +38,23 @@ data:
3538
jaeger:
3639
protocols:
3740
grpc:
41+
endpoint: 0.0.0.0:14250
3842
thrift_binary:
43+
endpoint: 0.0.0.0:6832
3944
thrift_compact:
45+
endpoint: 0.0.0.0:6831
4046
thrift_http:
47+
endpoint: 0.0.0.0:14268
4148
otlp:
4249
protocols:
4350
grpc:
51+
endpoint: 0.0.0.0:4317
4452
http:
53+
endpoint: 0.0.0.0:55681
4554
sapm:
55+
endpoint: 0.0.0.0:7276
4656
signalfx:
57+
endpoint: 0.0.0.0:9943
4758
# This section is used to collect OpenTelemetry metrics
4859
# Even if just a SignalFx µAPM customer, these metrics are included
4960
prometheus:
@@ -64,6 +75,7 @@ data:
6475
# Enable Zipkin to support Istio Mixer Adapter
6576
# https://github.com/signalfx/signalfx-istio-adapter
6677
zipkin:
78+
endpoint: 0.0.0.0:9411
6779
processors:
6880
batch:
6981
# Optional: If you have a different environment tag name

examples/prometheus-federation/otel-collector-config.yml

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ receivers:
1111
otlp:
1212
protocols:
1313
grpc:
14+
endpoint: 0.0.0.0:4317
1415

1516
exporters:
1617
splunk_hec/metrics:
@@ -39,6 +40,7 @@ processors:
3940

4041
extensions:
4142
health_check:
43+
endpoint: 0.0.0.0:13133
4244
pprof:
4345
endpoint: :1888
4446
zpages:

examples/splunk-hec-metrics/otel-collector-config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ processors:
2828

2929
extensions:
3030
health_check:
31+
endpoint: 0.0.0.0:13133
3132
pprof:
3233
endpoint: :1888
3334
zpages:

examples/splunk-hec/otel-collector-config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ processors:
2828

2929
extensions:
3030
health_check:
31+
endpoint: 0.0.0.0:13133
3132
pprof:
3233
endpoint: :1888
3334
zpages:

0 commit comments

Comments
 (0)