stats

package

v1.7.4 Latest Latest Go to latest Published: Apr 23, 2024 License: MIT Imports: 8 Imported by: 58

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/influxdata/kapacitor

Links

Open Source Insights

Documentation ¶

Overview ¶

The stats service collects the exported stats and submits them to the Kapacitor stream under the configured database and retetion policy.

If you want to persist the data to InfluxDB just add a task like so:

Example:

stream
    .from()
    .influxDBOut()

Assuming using default database and retetion policy run: `kapacitor define -name _stats -type stream -tick path/to/above/script.tick -dbrp _kapacitor.default`

If you do create a task to send the data to InfluxDB make sure not to subscribe to that data in InfluxDB.

Example:

[influxdb]

...
[influxdb.excluded-subscriptions]
    _kapacitor = [ "default" ]

Index ¶

Constants
type Config
- func NewConfig() Config
type Diagnostic
type Service
- func NewService(c Config, d Diagnostic) *Service

Constants ¶

View Source

const (
	DefaultDatabse                 = "_kapacitor"
	DefaultRetentionPolicy         = "autogen"
	DefaultStatsInterval           = toml.Duration(10 * time.Second)
	DefaultTimingSampleRate        = 0.10
	DefaultTimingMovingAverageSize = 1000
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	Enabled                 bool          `toml:"enabled"`
	StatsInterval           toml.Duration `toml:"stats-interval"`
	Database                string        `toml:"database"`
	RetentionPolicy         string        `toml:"retention-policy"`
	TimingSampleRate        float64       `toml:"timing-sample-rate"`
	TimingMovingAverageSize int           `toml:"timing-movavg-size"`
}

func NewConfig ¶

func NewConfig() Config

type Diagnostic ¶ added in v1.4.0

type Diagnostic interface {
	Error(msg string, err error)
}

type Service ¶

type Service struct {
	TaskMaster interface {
		Stream(name string) (kapacitor.StreamCollector, error)
	}
	// contains filtered or unexported fields
}

Sends internal stats back into the Kapacitor stream. Internal stats come from running tasks and other services running within Kapacitor.

func NewService ¶

func NewService(c Config, d Diagnostic) *Service

func (*Service) Close ¶

func (s *Service) Close() error

func (*Service) NewTimer ¶ added in v0.11.0

func (s *Service) NewTimer(avgVar timer.Setter) timer.Timer

func (*Service) Open ¶

func (s *Service) Open() (err error)

Source Files ¶

View all Source files

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