github_exporter

Documentation

Index

• Variables
• func New(logger log.Logger, c *Config) (integrations.Integration, error)
• type Config
  • func (c *Config) InstanceKey(agentKey string) (string, error)
  • func (c *Config) Name() string
  • func (c *Config) NewIntegration(logger log.Logger) (integrations.Integration, error)
  • func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

Variables

var DefaultConfig = Config{
	APIURL: "https://api.github.com",
}

DefaultConfig holds the default settings for the github_exporter integration

Functions

func New

func New(logger log.Logger, c *Config) (integrations.Integration, error)

New creates a new github_exporter integration.

Types

type Config

type Config struct {
	// URL for the GitHub API
	APIURL string `yaml:"api_url,omitempty"`

	// A list of GitHub repositories for which to collect metrics.
	Repositories []string `yaml:"repositories,omitempty"`

	// A list of GitHub organizations for which to collect metrics.
	Organizations []string `yaml:"organizations,omitempty"`

	// A list of GitHub users for which to collect metrics.
	Users []string `yaml:"users,omitempty"`

	// A GitHub authentication token that allows the API to be queried more often.
	APIToken config_util.Secret `yaml:"api_token,omitempty"`

	// A path to a file containing a GitHub authentication token that allows the API to be queried more often. If supplied, this supersedes `api_token`
	APITokenFile string `yaml:"api_token_file,omitempty"`
}

Config controls github_exporter

func (*Config) InstanceKey

func (c *Config) InstanceKey(agentKey string) (string, error)

InstanceKey returns the hostname:port of the GitHub API server.

func (*Config) Name

func (c *Config) Name() string

Name returns the name of the integration that this config represents.

func (*Config) NewIntegration

func (c *Config) NewIntegration(logger log.Logger) (integrations.Integration, error)

NewIntegration creates a new github_exporter

func (*Config) UnmarshalYAML

func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler for Config