Documentation
¶
Index ¶
- Constants
- func GetAppRunId() string
- func GetDomainSocketNameForClient() string
- func GetExternalAppRunId() string
- func GetMonitorPort() int
- func GetOutrigHomeForClient() string
- func GetTcpAddrForClient() string
- func SetUseDevConfig(dev bool)
- func UseDevConfig() bool
- type Config
- type GoRoutineConfig
- type LogProcessorConfig
- type RuntimeStatsConfig
- type WatchConfig
Constants ¶
View Source
const ( DomainSocketEnvName = "OUTRIG_DOMAINSOCKET" TcpAddrEnvName = "OUTRIG_TCPADDR" DisabledEnvName = "OUTRIG_DISABLED" NoTelemetryEnvName = "OUTRIG_NOTELEMETRY" DevConfigEnvName = "OUTRIG_DEVCONFIG" DisableDockerProbeEnvName = "OUTRIG_DISABLEDOCKERPROBE" ExternalLogCaptureEnvName = "OUTRIG_EXTERNALLOGCAPTURE" AppRunIdEnvName = "OUTRIG_APPRUNID" )
Environment variables
View Source
const ( OutrigHome = "~/.config/outrig" DevOutrigHome = "~/.config/outrig-dev" DefaultDomainSocketName = "/outrig.sock" )
Home directory paths
View Source
const ( ProdWebServerPort = 5005 DevWebServerPort = 6005 )
Default ports for the server (should match serverbase)
View Source
const OutrigSDKVersion = "v0.8.3"
Variables ¶
This section is empty.
Functions ¶
func GetAppRunId ¶ added in v0.8.1
func GetAppRunId() string
func GetDomainSocketNameForClient ¶ added in v0.8.1
func GetDomainSocketNameForClient() string
GetDomainSocketNameForClient returns the full domain socket path for client
func GetExternalAppRunId ¶ added in v0.8.1
func GetExternalAppRunId() string
func GetMonitorPort ¶ added in v0.8.1
func GetMonitorPort() int
func GetOutrigHomeForClient ¶ added in v0.8.1
func GetOutrigHomeForClient() string
GetOutrigHomeForClient returns the appropriate home directory based on client config
func GetTcpAddrForClient ¶ added in v0.8.1
func GetTcpAddrForClient() string
func SetUseDevConfig ¶ added in v0.8.1
func SetUseDevConfig(dev bool)
func UseDevConfig ¶ added in v0.8.1
func UseDevConfig() bool
Types ¶
type Config ¶ added in v0.5.0
type Config struct {
Quiet bool // If true, suppresses init, connect, and disconnect messages
// DomainSocketPath is the path to the Unix domain socket. If "" => use default.
// If "-" => disable domain socket.
DomainSocketPath string
// TcpAddr is the TCP address to connect to the Outrig server. If "" => use default.
// If "-" => disable TCP connection. Domain socket will be tried first (except on Windows where domain sockets are not supported).)
TcpAddr string
// By default the SDK will probe host.docker.internal:5005 to see if the Outrig monitor is running on the host machine
// We do an initial DNS lookup at startup and only try this host/port if the DNS lookup succeeds.
// Setting this to true will disable the initial probe.
DisableDockerProbe bool
// ModuleName is the name of the Go module. If not specified, it will be determined
// from the go.mod file.
ModuleName string
// If true, try to synchronously connect to the server on Init
ConnectOnInit bool
Dev bool
// Collector configurations
LogProcessorConfig LogProcessorConfig
WatchConfig WatchConfig
GoRoutineConfig GoRoutineConfig
RuntimeStatsConfig RuntimeStatsConfig
}
func DefaultConfig ¶
func DefaultConfig() *Config
DefaultConfig returns the default configuration for normal usage
func DefaultConfigForOutrigDevelopment ¶
func DefaultConfigForOutrigDevelopment() *Config
DefaultConfigForOutrigDevelopment returns a configuration specifically for Outrig internal development This is only used for internal Outrig development and not intended for general SDK users
type GoRoutineConfig ¶ added in v0.5.0
type GoRoutineConfig struct {
// Enabled indicates whether the goroutine collector is enabled
Enabled bool
}
type LogProcessorConfig ¶ added in v0.5.0
type LogProcessorConfig struct {
// Enabled indicates whether the log processor is enabled
Enabled bool
WrapStdout bool
WrapStderr bool
// OutrigPath is the full path to the outrig executable (including the executable name)
// If empty, the system will look for "outrig" in the PATH
OutrigPath string
// AdditionalArgs are additional arguments to pass to the outrig command
// These are inserted before the "capturelogs" argument
AdditionalArgs []string
}
type RuntimeStatsConfig ¶ added in v0.5.0
type RuntimeStatsConfig struct {
// Enabled indicates whether the runtime stats collector is enabled
Enabled bool
}
type WatchConfig ¶ added in v0.5.0
type WatchConfig struct {
// Enabled indicates whether the watch collector is enabled
Enabled bool
}
Click to show internal directories.
Click to hide internal directories.