config

Documentation

Index

• Variables
• func DeleteAlias(name string) error
• func GetAlias(name string) (string, error)
• func GetConfigPath() (string, error)
• func ImportAliases(filepath string) error
• func IsOnCallSite(site string) bool
• func LoadAliases() (map[string]string, error)
• func SaveAliases(aliases map[string]string) error
• func SetAlias(name, command string) error
• type AliasConfig
• type Config
  • func Load() (*Config, error)
  • func (c *Config) GetAPIHost() string
  • func (c *Config) GetAPIURL() string
  • func (c *Config) Validate() error

Variables

var ConfigPathFunc = getDefaultConfigPath

ConfigPathFunc is a function variable that returns the config file path This can be overridden in tests

Functions

func DeleteAlias

func DeleteAlias(name string) error

DeleteAlias removes an alias

func GetAlias

func GetAlias(name string) (string, error)

GetAlias retrieves a specific alias by name

func GetConfigPath

func GetConfigPath() (string, error)

GetConfigPath returns the path to the config file

func ImportAliases

func ImportAliases(filepath string) error

ImportAliases imports aliases from a YAML file

func IsOnCallSite

func IsOnCallSite(site string) bool

IsOnCallSite returns true if the site is an on-call domain (contains "oncall"). On-call domains like navy.oncall.datadoghq.com are already fully-qualified and should not have "api." prepended.

func LoadAliases

func LoadAliases() (map[string]string, error)

LoadAliases loads aliases from the config file

func SaveAliases

func SaveAliases(aliases map[string]string) error

SaveAliases saves aliases to the config file

func SetAlias

func SetAlias(name, command string) error

SetAlias sets or updates an alias

Types

type AliasConfig

type AliasConfig struct {
	Aliases map[string]string `yaml:"aliases"`
}

AliasConfig represents the alias configuration structure

type Config

type Config struct {
	APIKey      string
	AppKey      string
	Site        string
	AutoApprove bool
	AgentMode   bool
}

Config holds the application configuration

func Load

func Load() (*Config, error)

Load loads configuration from environment variables

func (*Config) GetAPIHost

func (c *Config) GetAPIHost() string

GetAPIHost returns the host portion of the API URL (without scheme). On-call domains are returned as-is; all other sites get "api.{site}".

func (*Config) GetAPIURL

func (c *Config) GetAPIURL() string

GetAPIURL returns the full API URL for the configured site. On-call domains are used as-is; all other sites get "https://api.{site}".

func (*Config) Validate

func (c *Config) Validate() error

Validate checks if required configuration is present Note: This only validates the site. Authentication can be via OAuth2 or API keys, which is checked in the client package.