--- WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE https://github.com/istio/istio REPO source_repo: https://github.com/istio/istio title: SignalFx description: Adapter that sends metrics to SignalFx. location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/signalfx.html layout: protoc-gen-docs generator: protoc-gen-docs supported_templates: metric,tracespan number_of_entries: 3 ---
The signalfx
adapter collects Istio metrics and trace spans and sends them
to SignalFx.
This adapter supports the metric template and the tracespan template.
If sending trace spans, this adapter can make use of certain conventions in the tracespan format that is configured to send to this adapter. Here is an example tracespan spec that will work well:
apiVersion: config.istio.io/v1alpha2
kind: tracespan
metadata:
name: signalfx
spec:
traceId: request.headers["x-b3-traceid"] | ""
spanId: request.headers["x-b3-spanid"] | ""
parentSpanId: request.headers["x-b3-parentspanid"] | ""
# If the path contains query parameters, they will be split off and put into
# tags such that the span name sent to SignalFx will consist only of the path
# itself.
spanName: request.path | "/"
startTime: request.time
endTime: response.time
# If this is >=500, the span will get an 'error' tag
httpStatusCode: response.code | 0
clientSpan: context.reporter.kind == "outbound"
# Span tags below that do not have comments are useful but optional and will
# be passed to SignalFx unmodified. The tags that have comments are interpreted
# in a special manner, but are still optional.
spanTags:
# This is used to determine whether the span pertains to the client or
# server side of the request.
context.reporter.local: context.reporter.local
# This gets put into the remoteEndpoint.ipv4 field
destination.ip: destination.ip | ip("0.0.0.0")
# This gets flattened out to individual tags of the form
# 'destination.labels.<key>: <value>'.
destination.labels: destination.labels
# This gets put into the remoteEndpoint.name field
destination.name: destination.name | "unknown"
destination.namespace: destination.namespace | "unknown"
request.host: request.host | ""
request.method: request.method | ""
request.path: request.path | ""
request.size: request.size | 0
request.useragent: request.useragent | ""
response.size: response.size | 0
# This gets put into the localEndpoint.name field
source.name: source.name | "unknown"
# This gets put into the localEndpoint.ipv4 field
source.ip: source.ip | ip("0.0.0.0")
source.namespace: source.namespace | "unknown"
# This gets flattened out to individual tags of the form
# 'source.labels.<key>: <value>'.
source.labels: source.labels
source.version: source.labels["version"] | "unknown"
Configuration format for the signalfx
adapter.
Describes what metrics should be sent to SignalFx and in what form.
Describes what kind of metric this is.
Name | Description |
---|---|
NONE |
None is the default and is invalid |
COUNTER |
Values with the same set of dimensions will be added together as a continuously incrementing value. |
HISTOGRAM |
A histogram distribution. This will result in several metrics emitted for each unique set of dimensions. |