Documentation
¶
Index ¶
- Constants
- func ConfigureLogger(prefix string, writer io.Writer, level LoggingLevel) hclog.Logger
- func LogRecoveredPanic(logger hclog.Logger, recovered any, keyvals ...any) error
- func NewRequest(method string, url string, body io.Reader) (*http.Request, error)
- func NewRequestWithContext(ctx context.Context, method string, url string, body io.Reader) (*http.Request, error)
- func Recover(logger hclog.Logger, keyvals ...any)
- func SafeGo(logger hclog.Logger, fn func(), keyvals ...any)
- type FileSystem
- type LoggingLevel
- type ReconnectTimeoutGenerator
Constants ¶
const ( DefaultFileMod os.FileMode = 0o644 DefaultExecutableFileMod os.FileMode = 0o755 DefaultDirMod os.FileMode = 0o755 )
const DefaultMqttConnectTimeout time.Duration = InitialReconnectInterval
DefaultMqttConnectTimeout bounds a single MQTT connect attempt.
paho.mqtt.golang defaults ConnectTimeout to an implicit 30s. We set our own value so reconnect timing is fully owned by this codebase and stays stable across paho upgrades. The value is intentionally <= the shortest reconnect backoff slot (1.5 * InitialReconnectInterval) so a connect attempt can never outlive the next backoff slot. Endpoints with slow TLS handshakes can raise it per-device via the device config (mqtt_connect_timeout_seconds).
const InitialReconnectInterval time.Duration = time.Second
InitialReconnectInterval is the base interval the reconnect backoff seeds from. The first reconnect slot produced by ReconnectTimeoutGenerator is therefore ~2x this value (doubled) with up to ±25% jitter, i.e. it is never shorter than 1.5 * InitialReconnectInterval.
Variables ¶
This section is empty.
Functions ¶
func ConfigureLogger ¶
func LogRecoveredPanic ¶ added in v1.4.3
LogRecoveredPanic logs an already-recovered panic value at Error level along with a stack trace, and returns an error describing it.
Call it from inside a deferred closure that has itself called recover() when the caller needs to react to the panic (for example, to set a named error return so existing error-handling continues). When logging alone is enough, prefer Recover. The keyvals are attached to the log entry to identify the goroutine/context where the panic occurred (e.g. "worker", id).
func NewRequest ¶ added in v0.14.0
func NewRequestWithContext ¶ added in v0.14.0
func Recover ¶ added in v1.4.3
Recover is a deferred panic handler: it recovers any in-flight panic in the current goroutine and logs it at Error level with a stack trace. It is a no-op when no panic is in flight, so deferring it unconditionally is safe and it never changes normal (non-panic) control flow.
It must be invoked directly via defer (defer utils.Recover(logger, ...)) so the recover() runs in the panicking goroutine's deferred call.
Types ¶
type FileSystem ¶ added in v1.0.0
type FileSystem interface {
Executable() (string, error)
ReadFile(name string) ([]byte, error)
WriteFile(name string, data []byte, perm os.FileMode) error
MkdirAll(path string) error
RemoveAll(path string) error
}
func NewFileSystem ¶ added in v1.0.0
func NewFileSystem() FileSystem
type LoggingLevel ¶ added in v0.9.0
type LoggingLevel string
const ( Trace LoggingLevel = "trace" Debug LoggingLevel = "debug" Info LoggingLevel = "info" Warn LoggingLevel = "warn" Error LoggingLevel = "error" Off LoggingLevel = "off" Default LoggingLevel = "" )
type ReconnectTimeoutGenerator ¶
type ReconnectTimeoutGenerator struct {
// contains filtered or unexported fields
}
func (*ReconnectTimeoutGenerator) Clear ¶
func (g *ReconnectTimeoutGenerator) Clear()
func (*ReconnectTimeoutGenerator) Next ¶
func (g *ReconnectTimeoutGenerator) Next()
func (*ReconnectTimeoutGenerator) Timeout ¶ added in v0.2.0
func (g *ReconnectTimeoutGenerator) Timeout() time.Duration
Source Files