gateway: Update RemoveSpanTags documentation
@@ -18,7 +18,7 @@ Information associated with the SignalFx Gateway can be found <a target="_blank"
- [Add Tags to Spans](#add-tags-to-spans)
- [Identify and Replace variables in Span Names](#identify-and-replace-variables-in-span-names)
- [Using AdditionalSpanTags and SpanNameReplacementRules Together](#using-additionalspantags-and-spannamereplacementrules-together)
- - [Removing Span Tag Data](#removing-span-tag-data)
+ - [Removing Span Tag Metadata](#removing-span-tag-metadata)
- [collectd](#collectd-listener)
- [Prometheus](#prometheus-listener)
- [Wavefront](#wavefront-listener)
@@ -302,15 +302,14 @@ For example, with the config below, `documentId` will be replaced with the prope
}
}
-##### Removing Span Tag Data
+##### Removing Span Tag Metadata
-If a tag contains sensitive data that needs to be removed, `RemoveSpanTags` can be used to define tags that should be removed from specific services/operations.
-Services and Operations can be specified using a `*` for a wildcard match. If the Service or Operation field is left blank, `*` will be used as a default value. Tags must be specified using the exact name of the tag.
-For example, in the config below, the gateway will remove the "password" tag from any span that has a service that starts with "auth" and has an operation name "login".
-It will also remove the "zipcode", "number", and "CVV" tags from any span that contains "credit-card" in the operation name, from ANY service.
+`RemoveSpanTags` can be used to remove certain tags from the received trace spans. This can be used if you expect certain tags to contain sensitive information that you want to remove from your trace spans. The tags to remove can be specified by service name and operation name; both support using `*` for wildcard matching.
+For example, in the configuration below, the Gateway will remove the `password` tag from any span that has a service that starts with `auth` and has an operation name `login`. It will also remove the `zipcode`, `number`, and `CVV` tags from any span that contains `credit-card` in the operation name, from ANY service.
Use caution when leveraging this feature: every expression will impact the throughput of the Gateway. Make sure to monitor your Gateway's resource utilization and size your instance accordingly to support your needs.
+```json
{
"Type": "signalfx",
"ListenAddr": "0.0.0.0:18080",
@@ -318,18 +317,15 @@ Use caution when leveraging this feature: every expression will impact the throu
{
"Service": "auth*",
"Operation": "login",
- "Tags": [
- "password"
- ]
+ "Tags": ["password"]
},
{
"Operation": "*credit-card*",
- "Tags": [
- "zipcode", "number", "CVV"
- ]
+ "Tags": ["zipcode", "number", "CVV"]
}
]
}
+```
##### collectd listener
