Skip to content

Commit

Permalink
Add SignalFx forwarder to default configs (open-telemetry#218)
Browse files Browse the repository at this point in the history
* Add SignalFx forwarder to default configs

* Use layer caching on fpm builds

* Document signalfx-forwarder as metric and trace receiver
  • Loading branch information
rmfitzpatrick authored Apr 1, 2021
1 parent 6467337 commit 1495da5
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 12 deletions.
1 change: 1 addition & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,7 @@ jobs:
build-package:
machine:
image: ubuntu-1604:202007-01
docker_layer_caching: true
parameters:
package_type:
type: enum
Expand Down
7 changes: 5 additions & 2 deletions cmd/otelcol/config/collector/agent_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ receivers:
regex: '.*grpc_io.*'
action: drop
sapm:
smartagent/signalfx-forwarder:
type: signalfx-forwarder
listenAddress: 0.0.0.0:9080
signalfx:
zipkin:

Expand Down Expand Up @@ -120,15 +123,15 @@ service:
extensions: [health_check, http_forwarder, zpages]
pipelines:
traces:
receivers: [jaeger, otlp, sapm, zipkin]
receivers: [jaeger, otlp, sapm, smartagent/signalfx-forwarder, zipkin]
processors:
- memory_limiter
- batch
- resourcedetection
#- resource/add_environment
exporters: [sapm, signalfx]
metrics:
receivers: [otlp, signalfx, prometheus, hostmetrics]
receivers: [hostmetrics, otlp, prometheus, signalfx, smartagent/signalfx-forwarder]
processors: [memory_limiter, batch, resourcedetection]
exporters: [signalfx]
logs/signalfx:
Expand Down
10 changes: 8 additions & 2 deletions cmd/otelcol/config/collector/full_config_linux.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,12 @@ receivers:
sapm:
#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/tree/main/receiver/zipkinreceiver
Expand Down Expand Up @@ -533,14 +539,14 @@ service:
# NOTE: Receivers expose ports so ensure no other application uses the same ports
pipelines:
traces:
receivers: [jaeger, otlp, sapm, zipkin]
receivers: [jaeger, otlp, sapm, smartagent/signalfx-forwarder, zipkin]
processors:
- memory_limiter
- batch
#- resource/add_environment
exporters: [sapm, signalfx]
metrics:
receivers: [otlp, signalfx, prometheus]
receivers: [otlp, prometheus, signalfx, smartagent/signalfx-forwarder]
processors: [memory_limiter, batch]
exporters: [signalfx]
logs:
Expand Down
7 changes: 5 additions & 2 deletions cmd/otelcol/config/collector/otlp_config_linux.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ receivers:
action: drop
sapm:
signalfx:
smartagent/signalfx-forwarder:
type: signalfx-forwarder
listenAddress: 0.0.0.0:9080
zipkin:

processors:
Expand Down Expand Up @@ -80,14 +83,14 @@ service:
extensions: [health_check, http_forwarder, zpages]
pipelines:
traces:
receivers: [jaeger, otlp, sapm, zipkin]
receivers: [jaeger, otlp, sapm, smartagent/signalfx-forwarder, zipkin]
processors:
- memory_limiter
- batch
#- resource/add_environment
exporters: [otlphttp, signalfx]
metrics:
receivers: [otlp, signalfx, prometheus]
receivers: [otlp, prometheus, signalfx, smartagent/signalfx-forwarder]
processors: [memory_limiter, batch]
exporters: [signalfx]
logs:
Expand Down
9 changes: 5 additions & 4 deletions docs/signalfx-smart-agent-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -134,6 +134,7 @@ service:
metrics:
receivers:
- receivor_creator
- smartagent/signalfx-forwarder
processors:
- resourcedetection
exporters:
Expand Down
6 changes: 4 additions & 2 deletions internal/receiver/smartagentreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -76,6 +77,7 @@ service:
receivers:
- smartagent/postgresql
- smartagent/kafka
- smartagent/signalfx-forwarder
processors:
- resourcedetection
exporters:
Expand Down

0 comments on commit 1495da5

Please sign in to comment.