Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var DefaultConfig = Config{ Period: 30 * time.Second, JobTimeout: 10 * time.Second, StartNow: true, Forks: PageableListConfig{false, false, -1}, Contributors: PageableListConfig{true, true, -1}, Branches: PageableListConfig{true, false, -1}, Languages: ListConfig{true, true}, Participation: ExtendedConfig{true}, Downloads: PageableListConfig{true, false, -1}, Issues: IssuesConfig{true, true, -1, "open", []string{}, "created", "desc"}, }
DefaultConfig has the application default configurations. These attempt to be sane defaults, balanced between API call count and useful information provided.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
Period time.Duration `config:"period"`
JobTimeout time.Duration `config:"period"`
Repos []string `config:"repos"`
Orgs []string `config:"orgs"`
AccessToken string `config:"access_token"`
StartNow bool `config:"start_immediately"`
Forks PageableListConfig `config:"forks"`
Contributors PageableListConfig `config:"contributors"`
Branches PageableListConfig `config:"branches"`
Languages ListConfig `config:"languages"`
Participation ExtendedConfig `config:"participation"`
Downloads PageableListConfig `config:"downloads"`
Issues IssuesConfig `config:"issues"`
Enterprise EnterpriseConfig `config:"enterprise"`
}
Config contains the user-settable configuration options for the beat.
type EnterpriseConfig ¶
type EnterpriseConfig struct {
BaseUrl string `config:"base_url"`
UploadUrl string `config:"upload_url"`
}
EnterpriseConfig holds settings for GitHub Enterprise.
func (*EnterpriseConfig) GetBaseUrl ¶
func (e *EnterpriseConfig) GetBaseUrl() (*url.URL, error)
GetBaseUrl parses the base URL and returns it or an error Returns nils if the URL is blank
func (*EnterpriseConfig) GetUploadUrl ¶
func (e *EnterpriseConfig) GetUploadUrl() (*url.URL, error)
GetBaseUrl parses the base URL and returns it or an error Returns nils if the URL is blank
type ExtendedConfig ¶
type ExtendedConfig struct {
Enabled bool `config:"enabled"`
}
ExtendedConfig contains configuration options for metrics that require API calls beyond what comes in as part of the call to get repository information.
type IssuesConfig ¶
type IssuesConfig struct {
Enabled bool `config:"enabled"`
List bool `config:"list"`
Max int `config:"max_elements"`
State string `config:"state"`
Labels []string `config:"labels"`
Sort string `config:"sort"`
Direction string `config:"direction"`
}
IssuesConfig contains specific listing options for issues belonging to a repository.
type ListConfig ¶
ListConfig has configuration for metrics that have list outputs such as languages.
type PageableListConfig ¶
type PageableListConfig struct {
Enabled bool `config:"enabled"`
List bool `config:"list"`
Max int `config:"max_elements"`
}
PageableListConfig has configuration for metrics that have list outputs that require paging to fetch all of them such as contributors.
Source Files