SignalFx

Publish TenXSummary instance values as metric counters to an SignalFx Micrometer registry.

Availability

This implementation is only available by default in the 10x Engine Cloud flavor to reduce the footprint of the edge/JIT-edge flavors.

Configuration

To configure the SignalFx metrics output module, Edit these settings.

Below is the default configuration from: signalFx/config.yaml (* Required Fields).

Edit Online Edit Locally

Edit config.yaml Locally

Download and save to:

• Linux / Docker / macOS
• Custom directory
  $TENX_CONFIG/run/output/metric/signalFx/config.yaml
• Within cloned repo
  ./pipelines/run/output/metric/signalFx/config.yaml

Download

# 🔟❎ 'run' SignalFx metric output configuration

# Configures SignalFx remote write metric counter outputs.
# To learn more see https://doc.log10x.com/run/output/metric/signalFx/

# Set the 10x pipeline to 'run'
tenx: run

# =============================== Dependencies ================================

include: run/modules/output/metric/signalFx

# ============================ SignalFx Options ===============================

# Define multiple SignalFx metric outputs below
signalfx:

    # --------------------------- Connection Options --------------------------

    # 'accessToken' sets the SignalFx access token.
    #  To learn more see https://dev.splunk.com/observability/reference/api/org_tokens/latest
  - accessToken: $=TenXEnv.get("SIGNALFX_ACCESS_TOKEN")  # (❗ EnvVar REQUIRED)

    # 'source' sets the value to map to "host" when shipping metrics to SignalFx.
    #  Defaults to local hostname
    source: null

    # 'sourceUri' sets the URI of an internal proxy en route to signalFx.
    sourceUri: https://ingest.signalfx.com

    # ---------------------------- Counter Options ----------------------------

    # 'nameField' sets the TenXSummary field whose value identifies the micrometer counter to increment. 
    #  The 'inputName' field returns the name of the aggregator that produced the target TenXSummary instance.
    #  To learn more see https://doc.log10x.com/run/aggregate
    nameField: inputName

    # 'counterFields' specifies the TenXSummary fields whose values are used to increment the counter.
    #  To learn more see https://doc.log10x.com/run/aggregate/#summary-fields
    counterFields:
      - summaryVolume
      - summaryBytes
      - summaryTotals

    # 'tagFields' sets the TenXSummary fields used as the counter tag dimension values.
    #  Defaults to https://doc.log10x.com/run/initialize/#enrichmentFields
    tagFields:
      - $=yield TenXEnv.get("enrichmentFields")

    # 'tagFieldNames' allows setting custom names to aggregated fields for metrics reporting.
    #  Defaults to https://doc.log10x.com/run/initialize/#metricFieldNames
    tagFieldNames:
      - $=yield TenXEnv.get("metricFieldNames")

    # 'filter' sets a JavaScript expression that TenXSummaries must evaluate as truthy to write to the output.
    #  To learn more see https://doc.log10x.com/run/output/regulate/#filter-expressions
    filter: isSummary

    # ---------------------------- Publish Options ----------------------------

    # 'step' sets the interval to send metrics to SignalFx (e.g., '1m').
    #  To learn more see https://micrometer.io/docs/concepts#rate-aggregation

    # 'publishCumulativeHistogram' sets whether the SignalFx registry should emit cumulative histogram
    publishCumulativeHistogram: false

Options

Specify the options below to configure multiple SignalFx metrics output:

Name	Description	Category
signalfxEnabled	Enable this output	General
signalfxAccessToken	SignalFx access token	Authentication
signalfxSource	Value to map to "host" when shipping metrics to SignalFx	Authentication
signalfxSourceUri	URI of an internal proxy en route to SignalFx	Authentication
signalfxNameField	Name of the TenXSummary field identifying the metric	Counter
signalfxCounterFields	Names of the TenXSummary fields used to increment the metric counter value	Counter
signalfxTagFields	List of TenXSummary fields to use as metric tag values	Counter
signalfxTagFieldNames	List of custom names to use for TenXSummary fields.	Counter
signalfxFilter	A JavaScript expression an TenXSummary must evaluate as 'truthy' against to be written to this output	Counter
signalfxMaxCardinality	Maximum number of unique metric combinations allowed	Counter
signalfxPublishCumulativeHistogram	Set whether to emit cumulative histogram	Counter
signalfxStep	The interval at which to publish metrics to output	Counter

General

signalfxEnabled

Enable this output.

Type	Default	Category
Boolean	true	General

Enable or disable this output.

Authentication

signalfxAccessToken

SignalFx access token.

Type	Default	Category
String	""	Authentication

Sets the SignalFx access token. To learn more see: Splunk tokens.

signalfxSource

Value to map to "host" when shipping metrics to SignalFx.

Type	Default	Category
String	local hostname	Authentication

Sets the value to map to "host" when shipping metrics to signalFx.

signalfxSourceUri

URI of an internal proxy en route to SignalFx.

Type	Default	Category
String	https://ingest.signalfx.com	Authentication

Sets the URI of an internal proxy en route to SignalFx.

Counter

signalfxNameField

Name of the TenXSummary field identifying the metric.

Type	Default	Category
String	summaryValues	Counter

Defines the name of the TenXSummary field whose value identifies a metric counter. Defaults to the summaryValues field which holds the value(s) by which TenXObjects are grouped into the current TenXSummary instance. To learn more see micrometer counters.

signalfxCounterFields

Names of the TenXSummary fields used to increment the metric counter value.

Type	Default	Category
List	summaryVolume	Counter

Defines the name of the TenXSummary field by whose value to increment the counter.

signalfxTagFields

List of TenXSummary fields to use as metric tag values.

Type	Default	Category
List	[]	Counter

Defines the TenXSummary field names to use as tag values. Tags are dimensions that enable slicing a particular named metric to drill down to reason about its value. To learn more see micrometer tags.

signalfxTagFieldNames

List of custom names to use for TenXSummary fields.

Type	Default	Category
List	[]	Counter

Defines the a list of custom names to give fields when reporting them. Format as a list of name1, custom1, name2, custom2.

For example, to set a custom name of 'My-Custom-Field' to an existing 'intrinsic-field':

signalfx:
  tagFieldNames:
    - intrinsic-field
    - My-Custom-Field.

signalfxFilter

A JavaScript expression an TenXSummary must evaluate as 'truthy' against to be written to this output.

Type	Default	Category
String	""	Counter

Specifies a JavaScript expression that an TenXSummary must evaluate as truthy to write its instance/template field values to the target counter.

For example, to only emit TenXSummaries produced by the 'myMetric' aggregator, specify:

signalfx:
  filter: this.inputName == "myMetric"

To learn more see inputName.

signalfxMaxCardinality

Maximum number of unique metric combinations allowed.

Type	Default	Category
Number	500	Counter

Sets the maximum number of unique metric combinations (cardinality) allowed for this output. When exceeded, metrics will be dropped to prevent excessive cardinality.

signalfxPublishCumulativeHistogram

Set whether to emit cumulative histogram.

Type	Default	Category
Boolean	false	Counter

Set whether the SignalFx registry should emit a cumulative histogram.

signalfxStep

The interval at which to publish metrics to output.

Type	Default	Category
String	1min	Counter

Sets the interval at which to publish metrics to the time-series destination (e.g., '1m'). To learn more see rate-aggregation.

This module is defined in signalFx/module.yaml.