Skip to content

Commit dec03f6

Browse files
Update Smart Agent docs (#199)
1 parent 52d34d2 commit dec03f6

File tree

2 files changed

+38
-6
lines changed

2 files changed

+38
-6
lines changed

docs/signalfx-smart-agent-migration.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ The [SignalFx Smart Agent's](https://github.com/signalfx/signalfx-agent/blob/mas
44
metric monitors allow real-time insights into how your target services and
55
applications are performing. These metric gathering utilities have an
66
equivalent counterpart in the OpenTelemetry Collector, the metric receiver.
7-
The [Smart Agent Receiver](./README.md) is a wrapper utility that allows the
8-
embedding of Smart Agent monitors within your Collector pipelines.
7+
The [Smart Agent Receiver](../internal/receiver/smartagentreceiver/README.md)
8+
is a wrapper utility that allows the embedding of Smart Agent monitors within
9+
your Collector pipelines.
910

1011
Based on the relocation of your desired monitor configurations in your Collector
1112
deployment, the Smart Agent Receiver works in much the same way your Smart Agent
@@ -29,6 +30,8 @@ collectd:
2930
writeQueueLimitLow: 600000
3031

3132
monitors:
33+
- type: signalfx-forwarder
34+
listenAddress: 0.0.0.0:9080
3235
- type: collectd/activemq
3336
discoveryRule: container_image =~ "activemq" && private_port == 1099
3437
extraDimensions:
@@ -41,7 +44,10 @@ monitors:
4144
my_other_dimension: my_other_dimension_value
4245
```
4346
44-
Here is an equivalent, recommended Collector configuration utilizing the
47+
Below is an equivalent, recommended Collector configuration. Notice that the
48+
`signalfx-forwarder` monitor's associated `smartagent/signalfx-forwarder` receiver instance
49+
is part of a `traces` pipeline using the `sapm` exporter. The additional metric
50+
monitors utilize the
4551
[Receiver Creator](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/master/receiver/receivercreator/README.md):
4652

4753
```yaml
@@ -57,20 +63,23 @@ extensions:
5763
writeQueueLimitLow: 600000
5864
5965
receivers:
66+
smartagent/signalfx-forwarder:
67+
type: signalfx-forwarder
68+
listenAddress: 0.0.0.0:9080
6069
receiver_creator:
6170
receivers:
6271
smartagent/activemq:
63-
rule: type.port && pod.name == "activemq" && port == 1099
72+
rule: type == "port" && pod.name matches "activemq" && port == 1099
6473
config:
6574
type: collectd/activemq
6675
extraDimensions:
6776
my_dimension: my_dimension_value
6877
smartagent/apache:
69-
rule: type.port && pod.name == "apache" && port == 80
78+
rule: type == "port" && pod.name matches "apache" && port == 80
7079
config:
7180
type: collectd/apache
7281
smartagent/postgresql:
73-
rule: type.port && pod.name == "postgresql" && port == 7199
82+
rule: type == "port" && pod.name matches "postgresql" && port == 7199
7483
config:
7584
type: postgresql
7685
extraDimensions:
@@ -102,6 +111,9 @@ exporters:
102111
signalfx:
103112
access_token: "${SIGNALFX_ACCESS_TOKEN}"
104113
realm: us1
114+
sapm:
115+
access_token: "${SIGNALFX_ACCESS_TOKEN}"
116+
endpoint: https://ingest.us1.signalfx.com/v2/trace
105117
106118
service:
107119
extensions:
@@ -115,4 +127,11 @@ service:
115127
- resourcedetection
116128
exporters:
117129
- signalfx
130+
traces:
131+
receivers:
132+
- smartagent/signalfx-forwarder
133+
processors:
134+
- resourcedetection
135+
exporters:
136+
- sapm
118137
```

internal/receiver/smartagentreceiver/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ Each `smartagent` receiver configuration acts a drop-in replacement for each sup
1515
[`receivercreator`](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/master/receiver/receivercreator/README.md)
1616
and associated [Observer extensions](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/master/extension/observer/README.md)
1717
should be used.
18+
1. The [`signalfx-forwarder`](https://github.com/signalfx/signalfx-agent/blob/master/docs/monitors/signalfx-forwarder.md)
19+
monitor should be made part of a `traces` pipeline utilizing the [`sapm`
20+
exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/sapmexporter/README.md)
1821
1. All metric content replacement and transformation rules should utilize existing
1922
[Collector processors](https://github.com/open-telemetry/opentelemetry-collector/blob/master/processor/README.md).
2023
1. Monitors with [dimension property and tag update
@@ -41,6 +44,8 @@ Example:
4144

4245
```yaml
4346
receivers:
47+
smartagent/signalfx-forwarder:
48+
type: signalfx-forwarder
4449
smartagent/postgresql:
4550
type: postgresql
4651
host: mypostgresinstance
@@ -63,6 +68,7 @@ processors:
6368

6469
exporters:
6570
signalfx:
71+
sapm:
6672

6773
service:
6874
pipelines:
@@ -81,6 +87,13 @@ service:
8187
- resourcedetection
8288
exporters:
8389
- signalfx
90+
traces:
91+
receivers:
92+
- smartagent/signalfx-forwarder
93+
processors:
94+
- resourcedetection
95+
exporters:
96+
- sapm
8497
```
8598
8699
For a more detailed description of migrating your Smart Agent monitor usage to the Splunk Distribution of

0 commit comments

Comments
 (0)