purefbreceiver

README

Pure Storage FlashBlade Receiver

Status
Stability	alpha: metrics
Distributions	contrib
Issues
Code Owners	@jpkrohling, @dgoscn, @chrroberts-pure

The Pure Storage FlashBlade receiver, receives metrics from Pure Storage FlashBlade via the Pure Storage FlashBlade OpenMetrics Exporter

Configuration

The following settings are required:

• endpoint (default: http://172.31.60.207:9491/metrics/array): The URL of the scraper selected endpoint

Important

• Only endpoints explicitly added on will be scraped. e.g: clients

Example:

extensions:
  bearertokenauth/fb01:
    token: "..."

receivers:
  purefb:
    endpoint: http://172.31.60.207:9491/metrics
    arrays:
      - address: fb01
        auth:
          authenticator: bearertokenauth/fb01
    clients:
      - address: fb01
        auth:
          authenticator: bearertokenauth/fb01
    env: dev
    settings:
      reload_intervals:
        array: 5m
        clients: 6m
        usage: 6m

The full list of settings exposed for this receiver are documented in config.go with detailed sample configurations in testdata/config.yaml.

Documentation

Index

• func NewFactory() receiver.Factory
• type Config
  • func (c *Config) Validate() error
• type ReloadIntervals
• type Settings

Functions

func NewFactory

func NewFactory() receiver.Factory

NewFactory creates a factory for Pure Storage FlashBlade receiver.

Types

type Config

type Config struct {
	confighttp.ClientConfig `mapstructure:",squash"`

	// Settings contains settings for the individual scrapers
	Settings *Settings `mapstructure:"settings"`

	// Arrays represents the list of arrays to query
	Arrays []internal.ScraperConfig `mapstructure:"arrays"`

	// Clients represents the list of clients metrics
	Clients []internal.ScraperConfig `mapstructure:"clients"`

	// Usage represents the list of usage to query
	Usage []internal.ScraperConfig `mapstructure:"usage"`

	// Env represents the respective environment value valid to scrape
	Env string `mapstructure:"env"`
}

Config relating to Array Metric Scraper.

func (*Config) Validate

func (c *Config) Validate() error

type ReloadIntervals

type ReloadIntervals struct {
	Array   time.Duration `mapstructure:"array"`
	Clients time.Duration `mapstructure:"clients"`
	Usage   time.Duration `mapstructure:"usage"`
}

type Settings

type Settings struct {
	ReloadIntervals *ReloadIntervals `mapstructure:"reload_intervals"`
}