signalfx.config.pb.html

---
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: 4
---
<p>The <code>signalfx</code> adapter collects Istio metrics and trace spans and sends them
to <a href="https://signalfx.com">SignalFx</a>.</p>

<p>This adapter supports the <a href="https://istio.io/docs/reference/config/policy-and-telemetry/templates/metric/">metric template</a>
and the <a href="https://istio.io/docs/reference/config/policy-and-telemetry/templates/tracespan/">tracespan template</a>.</p>

<p>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:</p>

<pre><code class="language-yaml">apiVersion: config.istio.io/v1alpha2
kind: tracespan
metadata:
  name: signalfx
spec:
  traceId: request.headers[&quot;x-b3-traceid&quot;] | &quot;&quot;
  spanId: request.headers[&quot;x-b3-spanid&quot;] | &quot;&quot;
  parentSpanId: request.headers[&quot;x-b3-parentspanid&quot;] | &quot;&quot;
  # 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 | &quot;/&quot;
  startTime: request.time
  endTime: response.time
  # If this is &gt;=500, the span will get an 'error' tag
  httpStatusCode: response.code | 0
  clientSpan: context.reporter.kind == &quot;outbound&quot;
  # 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 gets put into the remoteEndpoint.ipv4 field
    destination.ip: destination.ip | ip(&quot;0.0.0.0&quot;)
    # This gets put into the remoteEndpoint.name field
    destination.name: destination.name | &quot;unknown&quot;
    destination.namespace: destination.namespace | &quot;unknown&quot;
    request.host: request.host | &quot;&quot;
    request.method: request.method | &quot;&quot;
    request.path: request.path | &quot;&quot;
    request.size: request.size | 0
    request.useragent: request.useragent | &quot;&quot;
    response.size: response.size | 0
    # This gets put into the localEndpoint.name field
    source.name: source.name | &quot;unknown&quot;
    # This gets put into the localEndpoint.ipv4 field
    source.ip: source.ip | ip(&quot;0.0.0.0&quot;)
    source.namespace: source.namespace | &quot;unknown&quot;
    source.version: source.labels[&quot;version&quot;] | &quot;unknown&quot;
</code></pre>

<h2 id="Params">Params</h2>
<section>
<p>Configuration format for the <code>signalfx</code> adapter.</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="Params-metrics">
<td><code>metrics</code></td>
<td><code><a href="#Params-MetricConfig">Params.MetricConfig[]</a></code></td>
<td>
<p>Required. The set of metrics to send to SignalFx. If an Istio metric is
configured to be sent to this adapter, it must have a corresponding
description here.</p>

</td>
</tr>
<tr id="Params-ingest_url">
<td><code>ingestUrl</code></td>
<td><code>string</code></td>
<td>
<p>Optional. The URL of the SignalFx ingest server to use.  Will default to
the global ingest server if not specified.</p>

</td>
</tr>
<tr id="Params-access_token">
<td><code>accessToken</code></td>
<td><code>string</code></td>
<td>
<p>Required. The access token for the SignalFx organization that should
receive the metrics.  This can also be configured via an environment
variable <code>SIGNALFX_ACCESS_TOKEN</code> set on the adapter process which makes
it possible to use Kubernetes secrets to provide the token.  This field,
if specified, will take priority over the environment variable.</p>

</td>
</tr>
<tr id="Params-datapoint_interval">
<td><code>datapointInterval</code></td>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">google.protobuf.Duration</a></code></td>
<td>
<p>Optional. Specifies how frequently to send metrics to SignalFx.  Metrics
reported to this adapter are collected and reported as a timeseries.
This will be rounded to the nearest second and rounded values less than
one second are not valid. Defaults to 10 seconds if not specified.</p>

</td>
</tr>
<tr id="Params-enable_metrics">
<td><code>enableMetrics</code></td>
<td><code>bool</code></td>
<td>
<p>Optional.  If set to false, metrics won&rsquo;t be sent (but trace spans will
be sent, unless otherwise disabled).</p>

</td>
</tr>
<tr id="Params-enable_tracing">
<td><code>enableTracing</code></td>
<td><code>bool</code></td>
<td>
<p>Optional.  If set to false, trace spans won&rsquo;t be sent (but metrics will
be sent, unless otherwise disabled).</p>

</td>
</tr>
<tr id="Params-tracing">
<td><code>tracing</code></td>
<td><code><a href="#Params-TracingConfig">Params.TracingConfig</a></code></td>
<td>
<p>Configuration for the Trace Span handler</p>

</td>
</tr>
<tr id="Params-trace_endpoint_url">
<td><code>traceEndpointUrl</code></td>
<td><code>string</code></td>
<td>
<p>Optional. The full URL (including path) to the trace ingest server.
If this is not set, all trace spans will be sent to the same place
as ingestUrl above.</p>

</td>
</tr>
</tbody>
</table>
</section>
<h2 id="Params-MetricConfig">Params.MetricConfig</h2>
<section>
<p>Describes what metrics should be sent to SignalFx and in what form.</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="Params-MetricConfig-name">
<td><code>name</code></td>
<td><code>string</code></td>
<td>
<p>Required.  The name of the metric as it is sent to the adapter.  In
Kubernetes this is of the form &ldquo;<name>.metric.<namespace>&rdquo; where
&ldquo;<name>&rdquo; is the name field of the metric resource, and &ldquo;<namespace>&rdquo;
is the namespace of the metric resource.</p>

</td>
</tr>
<tr id="Params-MetricConfig-type">
<td><code>type</code></td>
<td><code><a href="#Params-MetricConfig-Type">Params.MetricConfig.Type</a></code></td>
<td>
<p>The metric type of the metric</p>

</td>
</tr>
</tbody>
</table>
</section>
<h2 id="Params-MetricConfig-Type">Params.MetricConfig.Type</h2>
<section>
<p>Describes what kind of metric this is.</p>

<table class="enum-values">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="Params-MetricConfig-Type-NONE">
<td><code>NONE</code></td>
<td>
<p>None is the default and is invalid</p>

</td>
</tr>
<tr id="Params-MetricConfig-Type-COUNTER">
<td><code>COUNTER</code></td>
<td>
<p>Values with the same set of dimensions will be added together
as a continuously incrementing value.</p>

</td>
</tr>
<tr id="Params-MetricConfig-Type-HISTOGRAM">
<td><code>HISTOGRAM</code></td>
<td>
<p>A histogram distribution.  This will result in several metrics
emitted for each unique set of dimensions.</p>

</td>
</tr>
</tbody>
</table>
</section>
<h2 id="Params-TracingConfig">Params.TracingConfig</h2>
<section>
<p>Holds all of the tracing-specific configuration</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="Params-TracingConfig-buffer_size">
<td><code>bufferSize</code></td>
<td><code>uint32</code></td>
<td>
<p>Optional.  The number of trace spans that the adapter will buffer before
dropping them.  This defaults to 1000 spans but can be configured higher
if needed.  An error message will be logged if spans are dropped.</p>

</td>
</tr>
<tr id="Params-TracingConfig-local_endpoint_name_tag_key">
<td><code>localEndpointNameTagKey</code></td>
<td><code>string</code></td>
<td>
<p>The span tag that is used as the value of the localEndpoint.serviceName
field of the span sent to SignalFx</p>

</td>
</tr>
<tr id="Params-TracingConfig-local_endpoint_ip_tag_key">
<td><code>localEndpointIpTagKey</code></td>
<td><code>string</code></td>
<td>
<p>The span tag that is used as the value of the localEndpoint.ipv4
field of the span sent to SignalFx</p>

</td>
</tr>
<tr id="Params-TracingConfig-remote_endpoint_name_tag_key">
<td><code>remoteEndpointNameTagKey</code></td>
<td><code>string</code></td>
<td>
<p>The span tag that is used as the value of the remoteEndpoint.serviceName
field of the span sent to SignalFx</p>

</td>
</tr>
<tr id="Params-TracingConfig-remote_endpoint_ip_tag_key">
<td><code>remoteEndpointIpTagKey</code></td>
<td><code>string</code></td>
<td>
<p>The span tag that is used as the value of the remoteEndpoint.ipv4
field of the span sent to SignalFx</p>

</td>
</tr>
<tr id="Params-TracingConfig-swap_local_remote_endpoints">
<td><code>swapLocalRemoteEndpoints</code></td>
<td><code>bool</code></td>
<td>
<p>If true, the local and remote endpoints will be swapped for
non-client spans.  This means that the above config options for
[local/remote]<em>endpoint</em>[name/ip]<em>tag</em>key with have a reversed
meaning for server spans.  The <code>clientSpan</code> field in the <code>tracespan</code>
instance that is used with this adapter determines what is a
&ldquo;client&rdquo; vs a &ldquo;server&rdquo; span.</p>

</td>
</tr>
</tbody>
</table>
</section>