apputil

README

apputil

Application utility functions for enterprise software development

• Logger using uber-go/zap + gopkg.in/natefinch/lumberjack.v2

• Unique ID using muyo/sno

• General utility functions

  • IsEmptyJson: check if given data is an empty JSON object

Version 1.2.0

• Add Time Sorted ID features from github.com/vishal-bihani/go-tsid

Documentation

Index

• Constants
• Variables
• func ChangeLogLevel(level string)
• func GenerateExtendedTsidNumber(options ...bool) string
• func GenerateRequestID() sno.ID
• func GenerateRequestIDByte() []byte
• func GenerateRequestIDString() string
• func GenerateTsidBytes(options ...bool) []byte
• func GenerateTsidNumber() int64
• func GenerateTsidString(options ...bool) string
• func GetEpoch() int64
• func GetIDMeta() byte
• func GetNodeBits() int32
• func GetNodeId() int32
• func GetPrefix() string
• func GetSuffix() string
• func InitWithConfig(config *UidConfig)
• func InitializeLogger(maxSize int, maxBackups int, maxAge int, compress bool, logBaseDir string)
• func IsEmptyJson(data interface{}) bool
• func SetEpoch(b int64)
• func SetIDMeta(b byte)
• func SetNodeBits(b int32)
• func SetNodeId(b int32)
• func SetPrefix(s string)
• func SetSuffix(s string)
• type UidConfig

Constants

const (
	MSG_CREATE_FACTORY_ERROR = "Error fetching customized TsidFactory, fallback to default"
	MSG_TSID_GENERATE_ERROR  = "Error generating tsid, fallback to default generator"
)

Variables

var AppZapConfig zapcore.EncoderConfig

var AppZapConsoleEncoder zapcore.Encoder

var AppZapCore zapcore.Core

var AppZapFileEncoder zapcore.Encoder

var AppZapWriter zapcore.WriteSyncer

var Logger *zap.Logger

var SLogger *zap.SugaredLogger

var ZapLevel zapcore.Level

Functions

func ChangeLogLevel

func ChangeLogLevel(level string)

func GenerateExtendedTsidNumber

func GenerateExtendedTsidNumber(options ...bool) string

func GenerateRequestID

func GenerateRequestID() sno.ID

func GenerateRequestIDByte

func GenerateRequestIDByte() []byte

func GenerateRequestIDString

func GenerateRequestIDString() string

func GenerateTsidBytes

func GenerateTsidBytes(options ...bool) []byte

func GenerateTsidNumber

func GenerateTsidNumber() int64

func GenerateTsidString

func GenerateTsidString(options ...bool) string

*

• GenerateTsidString
• @params options - [usePrefix, useSuffix]

func GetEpoch

func GetEpoch() int64

func GetIDMeta

func GetIDMeta() byte

func GetNodeBits

func GetNodeBits() int32

func GetNodeId

func GetNodeId() int32

func GetPrefix

func GetPrefix() string

func GetSuffix

func GetSuffix() string

func InitWithConfig

func InitWithConfig(config *UidConfig)

func InitializeLogger

func InitializeLogger(maxSize int, maxBackups int, maxAge int, compress bool, logBaseDir string)

func IsEmptyJson

func IsEmptyJson(data interface{}) bool

func SetEpoch

func SetEpoch(b int64)

func SetIDMeta

func SetIDMeta(b byte)

func SetNodeBits

func SetNodeBits(b int32)

func SetNodeId

func SetNodeId(b int32)

func SetPrefix

func SetPrefix(s string)

func SetSuffix

func SetSuffix(s string)

Types

type UidConfig

type UidConfig struct {
	Meta     byte
	NodeId   int32
	NodeBits int32
	Epoch    int64
	Prefix   string
	Suffix   string
}