Documentation
¶
Index ¶
- Constants
- func InitConfig(override, defaultConfig string)
- type Configuration
- type CredentialRule
- type DataSourceFilters
- type DataSourceSettings
- type FilterOverrides
- type GrafanaConfig
- func (s *GrafanaConfig) GetAlertNotificationOutput() string
- func (s *GrafanaConfig) GetCredentials(dataSourceName models.AddDataSourceCommand) (*GrafanaDataSource, error)
- func (s *GrafanaConfig) GetDashboardOutput() string
- func (s *GrafanaConfig) GetDataSourceOutput() string
- func (s *GrafanaConfig) GetDataSourceSettings() *DataSourceSettings
- func (s *GrafanaConfig) GetFilterOverrides() *FilterOverrides
- func (s *GrafanaConfig) GetFolderOutput() string
- func (s *GrafanaConfig) GetMonitoredFolders() []string
- func (s *GrafanaConfig) GetPath(r ResourceType) string
- func (s *GrafanaConfig) GetTeamOutput() string
- func (s *GrafanaConfig) GetUserOutput() string
- type GrafanaDataSource
- type MatchingRule
- type RegexMatchesList
- type ResourceType
Constants ¶
View Source
const ( UserResource = "users" TeamResource = "teams" DashboardResource = "dashboards" DataSourceResource = "datasources" FolderResource = "folders" AlertNotificationResource = "alertnotifications" LibraryElementResource = "libraryelements" )
Variables ¶
This section is empty.
Functions ¶
func InitConfig ¶
func InitConfig(override, defaultConfig string)
Types ¶
type Configuration ¶
type Configuration struct {
// contains filtered or unexported fields
}
func Config ¶
func Config() *Configuration
func (*Configuration) Contexts ¶
func (s *Configuration) Contexts() map[string]*GrafanaConfig
Contexts returns map of all contexts
func (*Configuration) IgnoreSSL ¶
func (s *Configuration) IgnoreSSL() bool
IgnoreSSL returns true if SSL errors should be ignored
func (*Configuration) IsDebug ¶
func (s *Configuration) IsDebug() bool
IsDebug returns true if debug mode is enabled
func (*Configuration) ViperConfig ¶
func (s *Configuration) ViperConfig() *viper.Viper
ViperConfig returns the loaded configuration via a viper reference
type CredentialRule ¶
type CredentialRule struct {
RegexMatchesList
Auth *GrafanaDataSource `yaml:"auth,omitempty"`
}
type DataSourceFilters ¶
type DataSourceSettings ¶
type DataSourceSettings struct {
Filters *DataSourceFilters `yaml:"filters,omitempty"`
FilterRules []MatchingRule `yaml:"exclude_filters,omitempty"`
Credentials map[string]*GrafanaDataSource `yaml:"credentials,omitempty"`
MatchingRules []RegexMatchesList `yaml:"credential_rules,omitempty"`
}
func (*DataSourceSettings) FiltersEnabled ¶
func (ds *DataSourceSettings) FiltersEnabled() bool
func (*DataSourceSettings) GetCredentials ¶
func (ds *DataSourceSettings) GetCredentials(dataSourceName models.AddDataSourceCommand) (*GrafanaDataSource, error)
func (*DataSourceSettings) IsExcluded ¶
func (ds *DataSourceSettings) IsExcluded(item interface{}) bool
type FilterOverrides ¶
type FilterOverrides struct {
IgnoreDashboardFilters bool `yaml:"ignore_dashboard_filters"`
}
type GrafanaConfig ¶
type GrafanaConfig struct {
Storage string `yaml:"storage"`
AdminEnabled bool
URL string `yaml:"url"`
APIToken string `yaml:"token"`
UserName string `yaml:"user_name"`
Password string `yaml:"password"`
Organization string `yaml:"organization"`
MonitoredFolders []string `yaml:"watched"`
DefaultDataSource *GrafanaDataSource `yaml:"-"`
DataSourceSettings *DataSourceSettings `yaml:"datasources"`
FilterOverrides *FilterOverrides `yaml:"filter_override"`
OutputPath string `yaml:"output_path"`
}
GrafanaConfig model wraps auth and watched list for grafana
func (*GrafanaConfig) GetAlertNotificationOutput ¶
func (s *GrafanaConfig) GetAlertNotificationOutput() string
func (*GrafanaConfig) GetCredentials ¶
func (s *GrafanaConfig) GetCredentials(dataSourceName models.AddDataSourceCommand) (*GrafanaDataSource, error)
GetCredentials return credentials for a given datasource or falls back on default value
func (*GrafanaConfig) GetDashboardOutput ¶
func (s *GrafanaConfig) GetDashboardOutput() string
func (*GrafanaConfig) GetDataSourceOutput ¶
func (s *GrafanaConfig) GetDataSourceOutput() string
func (*GrafanaConfig) GetDataSourceSettings ¶
func (s *GrafanaConfig) GetDataSourceSettings() *DataSourceSettings
func (*GrafanaConfig) GetFilterOverrides ¶
func (s *GrafanaConfig) GetFilterOverrides() *FilterOverrides
func (*GrafanaConfig) GetFolderOutput ¶
func (s *GrafanaConfig) GetFolderOutput() string
func (*GrafanaConfig) GetMonitoredFolders ¶
func (s *GrafanaConfig) GetMonitoredFolders() []string
GetMonitoredFolders return a list of the monitored folders alternatively returns the "General" folder.
func (*GrafanaConfig) GetPath ¶
func (s *GrafanaConfig) GetPath(r ResourceType) string
func (*GrafanaConfig) GetTeamOutput ¶
func (s *GrafanaConfig) GetTeamOutput() string
func (*GrafanaConfig) GetUserOutput ¶
func (s *GrafanaConfig) GetUserOutput() string
type GrafanaDataSource ¶
type GrafanaDataSource struct {
User string `yaml:"user"`
Password string `yaml:"password"`
UrlRegex string `yaml:"url_regex"`
}
Default datasource credentials
type MatchingRule ¶
type RegexMatchesList ¶
type RegexMatchesList struct {
Rules []MatchingRule `yaml:"rules,omitempty"`
Auth *GrafanaDataSource `yaml:"auth,omitempty"`
}
type ResourceType ¶
type ResourceType string
func (*ResourceType) GetPath ¶
func (s *ResourceType) GetPath(basePath string) string
func (*ResourceType) String ¶
func (s *ResourceType) String() string
Click to show internal directories.
Click to hide internal directories.