signalfx

package
v1.27.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 21, 2023 License: MIT Imports: 12 Imported by: 0

README

SignalFx Output Plugin

The SignalFx output plugin sends metrics to SignalFx.

Global configuration options

In addition to the plugin-specific configuration settings, plugins support additional global and plugin configuration settings. These settings are used to modify metrics, tags, and field or create aliases and configure ordering, etc. See the CONFIGURATION.md for more details.

Secret-store support

This plugin supports secrets from secret-stores for the access_token option. See the secret-store documentation for more details on how to use them.

Configuration

# Send metrics and events to SignalFx
[[outputs.signalfx]]
  ## SignalFx Org Access Token
  access_token = "my-secret-token"

  ## The SignalFx realm that your organization resides in
  signalfx_realm = "us9"  # Required if ingest_url is not set

  ## You can optionally provide a custom ingest url instead of the
  ## signalfx_realm option above if you are using a gateway or proxy
  ## instance.  This option takes precident over signalfx_realm.
  ingest_url = "https://my-custom-ingest/"

  ## Event typed metrics are omitted by default,
  ## If you require an event typed metric you must specify the
  ## metric name in the following list.
  included_event_names = ["plugin.metric_name"]

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetMetricType

func GetMetricType(mtype telegraf.ValueType) (metricType datapoint.MetricType)

GetMetricType returns the equivalent telegraf ValueType for a signalfx metric type

Types

type SignalFx

type SignalFx struct {
	AccessToken        config.Secret `toml:"access_token"`
	SignalFxRealm      string        `toml:"signalfx_realm"`
	IngestURL          string        `toml:"ingest_url"`
	IncludedEventNames []string      `toml:"included_event_names"`

	Log telegraf.Logger `toml:"-"`
	// contains filtered or unexported fields
}

SignalFx plugin context

func NewSignalFx

func NewSignalFx() *SignalFx

NewSignalFx - returns a new context for the SignalFx output plugin

func (*SignalFx) Close

func (s *SignalFx) Close() error

Close closes any connections to SignalFx

func (*SignalFx) Connect

func (s *SignalFx) Connect() error

Connect establishes a connection to SignalFx

func (*SignalFx) ConvertToSignalFx

func (s *SignalFx) ConvertToSignalFx(metrics []telegraf.Metric) ([]*datapoint.Datapoint, []*event.Event)

func (*SignalFx) SampleConfig

func (*SignalFx) SampleConfig() string

func (*SignalFx) Write

func (s *SignalFx) Write(metrics []telegraf.Metric) error

Write call back for writing metrics

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL