gcp

Documentation

Index

• Variables
• func SetupScrapers(ctx context.Context, b *bus.Bus) []v1.Scraper
• type Client
  • func New(ctx context.Context, account *config.Account, opts ...options) (c *Client, teardown func(), err error)
  • func (c *Client) GetMetricsForInstances(ctx context.Context, project, window string) error
  • func (c *Client) Refresh(ctx context.Context, project string)
• type Scraper
  • func (s *Scraper) Start(ctx context.Context)
  • func (s *Scraper) Stop(ctx context.Context)

Variables

var (
	/*
	* An MQL query that will return data from Google Cloud with the
	* - Instance Name
	* - Region
	* - Zone
	* - Machine Type
	* - Reserved CPUs
	* - Utilization
	* NOTE: Using reserved CPUs as vCPUs, because they are equivalent for visible
	* vCPUs within a guest instance, except for shared-core machines:
	* https://cloud.google.com/monitoring/api/metrics_gcp
	 */
	CPUQuery = `` /* 465-byte string literal not displayed */

	/*
	* An MQL query that will return memory data from Google Cloud with the
	* - Instance Name
	* - Region
	* - Zone
	* - Machine Type
	* - Memory Usage
	* NOTE: According to Google the 'ram_used' metric is only available for
	* e2-xxxx instances, which means that we can get memory usage for other types
	* of VM's
	 */
	MEMQuery = `` /* 309-byte string literal not displayed */

)

Functions

func SetupScrapers

func SetupScrapers(ctx context.Context, b *bus.Bus) []v1.Scraper

SetupScrapers instantiates a slice of instances of the Google Scraper configured for use, one per project configured

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is the structure used as the provider for Google Cloud Platform

func New

func New(
	ctx context.Context,
	account *config.Account,
	opts ...options,
) (c *Client, teardown func(), err error)

New returns a new instance of the GCP provider as well as a function to cleanup connections once done

func (*Client) GetMetricsForInstances

func (c *Client) GetMetricsForInstances(
	ctx context.Context,
	project, window string,
) error

GetMetricsForInstances retrieves all the metrics for a given instance And updates the cached instance with the metrics

func (*Client) Refresh

func (c *Client) Refresh(ctx context.Context, project string)

Refresh fetches all the Instances for a project and stores metadata in order to help with metric collections

type Scraper

type Scraper struct {
	// Google Client
	*Client

	Done chan bool

	// The Project that Client is setup for
	Project *string

	// Event bus for publishing
	Bus *bus.Bus

	// Teradown functionality
	Shutdown func()
	// contains filtered or unexported fields
}

Scraper is used to handle scraping google for various metrics

func (*Scraper) Start

func (s *Scraper) Start(ctx context.Context)

Start runs the scraper at the interval set by the ticker

func (*Scraper) Stop

func (s *Scraper) Stop(ctx context.Context)

Stop is used to gracefully stop the scrapper