commons

package

v0.0.0-...-f990e35 Latest Latest Go to latest Published: May 18, 2023 License: BSD-3-Clause Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cyverse/s3-data-watcher

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ExpandHomeDir(path string) (string, error)
func GetDefaultDataRootDirPath() string
func GetReleaseVersion() string
func GetVersionJSON() (string, error)
func StackTraceFromPanic(logger *log.Entry)
type Config
- func NewConfigFromYAML(yamlBytes []byte) (*Config, error)
- func NewDefaultConfig() *Config
type NatsConfig
type VersionInfo
- func GetVersion() VersionInfo

Constants ¶

View Source

const (
	ConfigFilePathDefault     string = "/etc/s3_data_watcher/config.yml"
	JobFilePathDefault        string = "/etc/s3_data_watcher/jobs.yml"
	NatsUrlDefault            string = "nats://nats:4222"
	NatsSubjectDefault        string = ""
	NatsMaxReconnectsDefault  int    = -1
	NatsReconnectWaitDefault  int    = -1
	NatsRequestTimeoutDefault int    = -1

	ReconnectInterval time.Duration = 1 * time.Minute
)

Variables ¶

This section is empty.

Functions ¶

func ExpandHomeDir ¶

func ExpandHomeDir(path string) (string, error)

func GetDefaultDataRootDirPath ¶

func GetDefaultDataRootDirPath() string

func GetReleaseVersion ¶

func GetReleaseVersion() string

GetReleaseVersion returns release version in string

func GetVersionJSON ¶

func GetVersionJSON() (string, error)

GetVersionJSON returns VersionInfo object in JSON string

func StackTraceFromPanic ¶

func StackTraceFromPanic(logger *log.Entry)

Types ¶

type Config ¶

type Config struct {
	DataRootPath string `yaml:"data_root_path,omitempty"`

	// S3 FS Event Publish
	NatsConfig NatsConfig `yaml:"nats_config,omitempty"`

	JobFilePath string `yaml:"job_file_path,omitempty"`

	// for Logging
	LogPath string `yaml:"log_path,omitempty"`

	Foreground   bool `yaml:"foreground,omitempty"`
	Debug        bool `yaml:"debug,omitempty"`
	ChildProcess bool `yaml:"childprocess,omitempty"`
}

Config is a configuration struct

func NewConfigFromYAML ¶

func NewConfigFromYAML(yamlBytes []byte) (*Config, error)

NewConfigFromYAML creates Config from YAML

func NewDefaultConfig ¶

func NewDefaultConfig() *Config

NewDefaultConfig returns a default config

func (*Config) GetLogFilePath ¶

func (config *Config) GetLogFilePath() string

GetLogFilePath returns log file path

func (*Config) MakeLogDir ¶

func (config *Config) MakeLogDir() error

MakeLogDir makes a log dir required

func (*Config) MakeWorkDirs ¶

func (config *Config) MakeWorkDirs() error

func (*Config) Validate ¶

func (config *Config) Validate() error

Validate validates field values and returns error if occurs

type NatsConfig ¶

type NatsConfig struct {
	URL            string `yaml:"url"`
	Subject        string `yaml:"subject"`
	MaxReconnects  int    `yaml:"max_reconnects,omitempty"`
	ReconnectWait  int    `yaml:"reconnect_wait,omitempty"`
	RequestTimeout int    `yaml:"request_timeout,omitempty"`
}

NatsConfig is a configuration struct for Nats Message bus

type VersionInfo ¶

type VersionInfo struct {
	ReleaseVersion string `json:"releaseVersion"`
	GitCommit      string `json:"gitCommit"`
	BuildDate      string `json:"buildDate"`
	GoVersion      string `json:"goVersion"`
	Compiler       string `json:"compiler"`
	Platform       string `json:"platform"`
}

VersionInfo object contains version related info

func GetVersion ¶

func GetVersion() VersionInfo

GetVersion returns VersionInfo object

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL