xtremio

README

XtremIO Input Plugin

The xtremio plugin gathers metrics from a Dell EMC XtremIO Storage Array's V3 Rest API. Documentation can be found here.

Configuration

 # Gathers Metrics From a Dell EMC XtremIO Storage Array's V3 API
[[inputs.xtremio]]
  ## XtremIO User Interface Endpoint
  url = "https://xtremio.example.com/" # required

  ## Credentials
  username = "user1"
  password = "pass123"

  ## Metrics to collect from the XtremIO
  # collectors = ["bbus","clusters","ssds","volumes","xms"]

  ## Optional TLS Config
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  ## Use SSL but skip chain & host verification
  # insecure_skip_verify = false

Metrics

• bbus

  • tags:
    • serial_number
    • guid
    • power_feed
    • name
    • model_name
  • fields:
    • bbus_power
    • bbus_average_daily_temp
    • bbus_enabled
    • bbus_ups_need_battery_replacement
    • bbus_ups_low_battery_no_input

• clusters

  • tags:
    • hardware_platform
    • license_id
    • guid
    • name
    • sys_psnt_serial_number
  • fields:
    • clusters_compression_factor
    • clusters_percent_memory_in_use
    • clusters_read_iops
    • clusters_write_iops
    • clusters_number_of_volumes
    • clusters_free_ssd_space_in_percent
    • clusters_ssd_num
    • clusters_data_reduction_ratio

• ssds

  • tags:
    • model_name
    • firmware_version
    • ssd_uid
    • guid
    • sys_name
    • serial_number
  • fields:
    • ssds_ssd_size
    • ssds_ssd_space_in_use
    • ssds_write_iops
    • ssds_read_iops
    • ssds_write_bandwidth
    • ssds_read_bandwidth
    • ssds_num_bad_sectors

• volumes

  • tags:
    • guid
    • sys_name
    • name
  • fields:
    • volumes_read_iops
    • volumes_write_iops
    • volumes_read_latency
    • volumes_write_latency
    • volumes_data_reduction_ratio
    • volumes_provisioned_space
    • volumes_used_space

• xms

  • tags:
    • guid
    • name
    • version
    • xms_ip
  • fields:
    • xms_write_iops
    • xms_read_iops
    • xms_overall_efficiency_ratio
    • xms_ssd_space_in_use
    • xms_ram_in_use
    • xms_ram_total
    • xms_cpu_usage_total
    • xms_write_latency
    • xms_read_latency
    • xms_user_accounts_count

Example Output

xio,guid=abcdefghifklmnopqrstuvwxyz111111,host=HOSTNAME,model_name=Eaton\ 5P\ 1550,name=X2-BBU,power_feed=PWR-B,serial_number=SER1234567890 bbus_average_daily_temp=22i,bbus_enabled=1i,bbus_power=286i,bbus_ups_low_battery_no_input=0i,bbus_ups_need_battery_replacement=0i 1638295340000000000 xio,guid=abcdefghifklmnopqrstuvwxyz222222,host=HOSTNAME,model_name=Eaton\ 5P\ 1550,name=X1-BBU,power_feed=PWR-A,serial_number=SER1234567891 bbus_average_daily_temp=22i,bbus_enabled=1i,bbus_power=246i,bbus_ups_low_battery_no_input=0i,bbus_ups_need_battery_replacement=0i 1638295340000000000 xio,guid=abcdefghifklmnopqrstuvwxyz333333,hardware_platform=X1,host=HOSTNAME,license_id=LIC123456789,name=SERVER01,sys_psnt_serial_number=FNM01234567890 clusters_compression_factor=1.5160012465000001,clusters_data_reduction_ratio=2.1613617899,clusters_free_ssd_space_in_percent=34i,clusters_number_of_volumes=36i,clusters_percent_memory_in_use=29i,clusters_read_iops=331i,clusters_ssd_num=50i,clusters_write_iops=4649i 1638295341000000000

Documentation

Index

• type BBU
• type Clusters
• type CollectorResponse
• type HREF
• type SSD
• type Volumes
• type XMS
• type XtremIO
  • func (xio *XtremIO) Gather(acc telegraf.Accumulator) error
  • func (xio *XtremIO) Init() error
  • func (*XtremIO) SampleConfig() string

Types

type BBU

type BBU struct {
	Content struct {
		Serial       string `json:"serial-number"`
		GUID         string `json:"guid"`
		PowerFeed    string `json:"power-feed"`
		Name         string `json:"Name"`
		ModelName    string `json:"model-name"`
		BBUPower     int    `json:"power"`
		BBUDailyTemp int    `json:"avg-daily-temp"`
		BBUEnabled   string `json:"enabled-state"`
		BBUNeedBat   bool   `json:"ups-need-battery-replacement,string"`
		BBULowBat    bool   `json:"is-low-battery-no-input,string"`
	}
}

type Clusters

type Clusters struct {
	Content struct {
		HardwarePlatform   string  `json:"hardware-platform"`
		LicenseID          string  `json:"license-id"`
		GUID               string  `json:"guid"`
		Name               string  `json:"name"`
		SerialNumber       string  `json:"sys-psnt-serial-number"`
		CompressionFactor  float64 `json:"compression-factor"`
		MemoryUsed         int     `json:"total-memory-in-use-in-percent"`
		ReadIops           int     `json:"rd-iops,string"`
		WriteIops          int     `json:"wr-iops,string"`
		NumVolumes         int     `json:"num-of-vols"`
		FreeSSDSpace       int     `json:"free-ud-ssd-space-in-percent"`
		NumSSDs            int     `json:"num-of-ssds"`
		DataReductionRatio float64 `json:"data-reduction-ratio"`
	}
}

type CollectorResponse

type CollectorResponse struct {
	BBUs     []HREF `json:"bbus"`
	Clusters []HREF `json:"clusters"`
	SSDs     []HREF `json:"ssds"`
	Volumes  []HREF `json:"volumes"`
	XMS      []HREF `json:"xmss"`
}

type HREF

type HREF struct {
	Href string `json:"href"`
}

type SSD

type SSD struct {
	Content struct {
		ModelName       string `json:"model-name"`
		FirmwareVersion string `json:"fw-version"`
		SSDuid          string `json:"ssd-uid"`
		GUID            string `json:"guid"`
		SysName         string `json:"sys-name"`
		SerialNumber    string `json:"serial-number"`
		Size            int    `json:"ssd-size,string"`
		SpaceUsed       int    `json:"ssd-space-in-use,string"`
		WriteIops       int    `json:"wr-iops,string"`
		ReadIops        int    `json:"rd-iops,string"`
		WriteBandwidth  int    `json:"wr-bw,string"`
		ReadBandwidth   int    `json:"rd-bw,string"`
		NumBadSectors   int    `json:"num-bad-sectors"`
	}
}

type Volumes

type Volumes struct {
	Content struct {
		GUID               string  `json:"guid"`
		SysName            string  `json:"sys-name"`
		Name               string  `json:"name"`
		ReadIops           int     `json:"rd-iops,string"`
		WriteIops          int     `json:"wr-iops,string"`
		ReadLatency        int     `json:"rd-latency,string"`
		WriteLatency       int     `json:"wr-latency,string"`
		DataReductionRatio float64 `json:"data-reduction-ratio,string"`
		ProvisionedSpace   int     `json:"vol-size,string"`
		UsedSpace          int     `json:"logical-space-in-use,string"`
	}
}

type XMS

type XMS struct {
	Content struct {
		GUID            string  `json:"guid"`
		Name            string  `json:"name"`
		Version         string  `json:"version"`
		IP              string  `json:"xms-ip"`
		WriteIops       int     `json:"wr-iops,string"`
		ReadIops        int     `json:"rd-iops,string"`
		EfficiencyRatio float64 `json:"overall-efficiency-ratio,string"`
		SpaceUsed       int     `json:"ssd-space-in-use,string"`
		RAMUsage        int     `json:"ram-usage,string"`
		RAMTotal        int     `json:"ram-total,string"`
		CPUUsage        float64 `json:"cpu"`
		WriteLatency    int     `json:"wr-latency,string"`
		ReadLatency     int     `json:"rd-latency,string"`
		NumAccounts     int     `json:"num-of-user-accounts"`
	}
}

type XtremIO

type XtremIO struct {
	Username   string          `toml:"username"`
	Password   string          `toml:"password"`
	URL        string          `toml:"url"`
	Collectors []string        `toml:"collectors"`
	Log        telegraf.Logger `toml:"-"`
	tls.ClientConfig
	// contains filtered or unexported fields
}

func (*XtremIO) Gather

func (xio *XtremIO) Gather(acc telegraf.Accumulator) error

func (*XtremIO) Init

func (xio *XtremIO) Init() error

func (*XtremIO) SampleConfig

func (*XtremIO) SampleConfig() string