commons

Documentation

Index

• Constants
• func GetDefaultDataRootDirPath() string
• func GetDefaultInstanceID() string
• func GetServiceVersion() string
• func GetVersionJSON() (string, error)
• func ParsePoolServiceEndpoint(endpoint string) (string, string, error)
• type Config
  • func NewConfigFromYAML(yamlBytes []byte) (*Config, error)
  • func NewDefaultConfig() *Config
  • func (config *Config) CleanWorkDirs() error
  • func (config *Config) GetDataCacheRootDirPath() string
  • func (config *Config) GetInstanceDataRootDirPath() string
  • func (config *Config) GetLogFilePath() string
  • func (config *Config) GetServiceEndpoint() string
  • func (config *Config) GetTempRootDirPath() string
  • func (config *Config) MakeLogDir() error
  • func (config *Config) MakeWorkDirs() error
  • func (config *Config) Validate() error
• type MetadataCacheTimeoutSetting
• type VersionInfo
  • func GetVersion() VersionInfo

Constants

const (
	DataCacheSizeMaxDefault int64 = 1024 * 1024 * 1024 * 20 // 20GB

	ProfileServicePortDefault     int = 12021
	PrometheusExporterPortDefault int = 12022
)

Functions

func GetDefaultDataRootDirPath

func GetDefaultDataRootDirPath() string

func GetDefaultInstanceID

func GetDefaultInstanceID() string

func GetServiceVersion

func GetServiceVersion() string

GetServiceVersion returns service version in string

func GetVersionJSON

func GetVersionJSON() (string, error)

GetVersionJSON returns VersionInfo object in JSON string

func ParsePoolServiceEndpoint

func ParsePoolServiceEndpoint(endpoint string) (string, string, error)

ParsePoolServiceEndpoint parses endpoint string

Types

type Config

type Config struct {
	ServiceEndpoint      string                        `yaml:"service_endpoint"`
	DataCacheSizeMax     int64                         `yaml:"data_cache_size_max"`
	DataRootPath         string                        `yaml:"data_root_path,omitempty"`
	CacheTimeoutSettings []MetadataCacheTimeoutSetting `yaml:"cache_timeout_settings,omitempty"`

	LogPath string `yaml:"log_path,omitempty"`

	Profile                bool `yaml:"profile,omitempty"`
	ProfileServicePort     int  `yaml:"profile_service_port,omitempty"`
	PrometheusExporterPort int  `yaml:"prometheus_exporter_port,omitempty"`

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

	InstanceID string `yaml:"instanceid,omitempty"`
}

Config holds the parameters list which can be configured

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) CleanWorkDirs

func (config *Config) CleanWorkDirs() error

CleanWorkDirs cleans dirs used

func (*Config) GetDataCacheRootDirPath

func (config *Config) GetDataCacheRootDirPath() string

func (*Config) GetInstanceDataRootDirPath

func (config *Config) GetInstanceDataRootDirPath() string

func (*Config) GetLogFilePath

func (config *Config) GetLogFilePath() string

GetLogFilePath returns log file path

func (*Config) GetServiceEndpoint

func (config *Config) GetServiceEndpoint() string

func (*Config) GetTempRootDirPath

func (config *Config) GetTempRootDirPath() string

func (*Config) MakeLogDir

func (config *Config) MakeLogDir() error

MakeLogDir makes a log dir required

func (*Config) MakeWorkDirs

func (config *Config) MakeWorkDirs() error

MakeWorkDirs makes dirs required

func (*Config) Validate

func (config *Config) Validate() error

Validate validates configuration

type MetadataCacheTimeoutSetting

type MetadataCacheTimeoutSetting struct {
	Path    string                        `yaml:"path" json:"path"`
	Timeout irodsfs_common_utils.Duration `yaml:"timeout" json:"timeout"`
	Inherit bool                          `yaml:"inherit,omitempty" json:"inherit,omitempty"`
}

MetadataCacheTimeoutSetting defines cache timeout for path

type VersionInfo

type VersionInfo struct {
	ServiceVersion string `json:"serviceVersion"`
	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