gokit

README

About go kit

Frequently used by spot max team

Coverage

1. logging
2. formatting
3. tool
4. typically structure

Principle

1. easy to use
2. easy to maintain
3. respect the open source author

Documentation

Index

• Variables
• func NewLogrusBufferHook(levels []logrus.Level, size int) (*LogrusBufferHook, *RingBuffer)
• func Prettify(i interface{}) string
• func PrettifyJson(i interface{}, indent bool) string
• func PrettifyYaml(i interface{}) string
• func Realpath(path string) string
• func String(v string) *string
• func StringValue(v *string) string
• type Consul
  • func NewConsul(address string) *Consul
  • func NewConsulToken(address string, token string) *Consul
  • func (c *Consul) GetKey(key string) ([]byte, error)
  • func (c *Consul) GetList(key string) (api.KVPairs, error)
  • func (c *Consul) GetService(service string) ([]*api.ServiceEntry, error)
  • func (c *Consul) PutKey(key string, value []byte) error
• type ESIndexRotate
• type ElasticHook
  • func NewElasticHook(client *elastic.Client, host string, level logrus.Level, index string, ...) (*ElasticHook, error)
  • func (hook *ElasticHook) Cancel()
  • func (hook *ElasticHook) Fire(entry *logrus.Entry) error
  • func (hook *ElasticHook) Levels() []logrus.Level
• type Iterator
  • func (i *Iterator) Stop()
• type LogrusBufferHook
  • func (hook *LogrusBufferHook) Cancel()
  • func (hook *LogrusBufferHook) Fire(entry *logrus.Entry) error
  • func (hook *LogrusBufferHook) Levels() []logrus.Level
• type RingBuffer
  • func NewRingBuffer(size int) *RingBuffer
  • func (r *RingBuffer) Read() []*RingBufferData
  • func (r *RingBuffer) Write(p *RingBufferData)
• type RingBufferData
• type Set
  • func NewSet(s ...interface{}) Set
  • func NewSetFromSlice(s []interface{}) Set
• type SimpleTimer
  • func NewSimpleTimer(duration time.Duration) *SimpleTimer
  • func (t *SimpleTimer) Checkpoint() bool
  • func (t *SimpleTimer) Reset()
  • func (t *SimpleTimer) Timeout() bool

Variables

var (
	ErrESCreateIndex     = fmt.Errorf("es: create elasticsearch index error")
	ErrConsulKeyNotExist = fmt.Errorf("consul: key not exist")
)

var FileLineFormatter = &logrus.TextFormatter{
	CallerPrettyfier: func(f *runtime.Frame) (string, string) {
		filename := path.Base(f.File)
		return fmt.Sprintf("%s()", f.Function), fmt.Sprintf("%s:%d", filename, f.Line)
	},
}

Functions

func NewLogrusBufferHook

func NewLogrusBufferHook(levels []logrus.Level, size int) (*LogrusBufferHook, *RingBuffer)

return hook: for logrus buffer: for reading data

func Prettify

func Prettify(i interface{}) string

Prettify returns the string representation of a value.

func PrettifyJson

func PrettifyJson(i interface{}, indent bool) string

Only for normal logging purpose, 4 space indent

func PrettifyYaml

func PrettifyYaml(i interface{}) string

Only for normal logging purpose, 4 space indent

func Realpath

func Realpath(path string) string

Get file's real path, for example, go test issue

func String

func String(v string) *string

String returns a pointer to the string value passed in.

func StringValue

func StringValue(v *string) string

StringValue returns the value of the string pointer passed in or "" if the pointer is nil.

Types

type Consul

type Consul struct {
	// contains filtered or unexported fields
}

func NewConsul

func NewConsul(address string) *Consul

func NewConsulToken

func NewConsulToken(address string, token string) *Consul

func (*Consul) GetKey

func (c *Consul) GetKey(key string) ([]byte, error)

func (*Consul) GetList

func (c *Consul) GetList(key string) (api.KVPairs, error)

func (*Consul) GetService

func (c *Consul) GetService(service string) ([]*api.ServiceEntry, error)

func (*Consul) PutKey

func (c *Consul) PutKey(key string, value []byte) error

type ESIndexRotate

type ESIndexRotate int

const (
	RotateNon ESIndexRotate = iota
	RotateDay
	RotateMonth
)

type ElasticHook

type ElasticHook struct {
	// contains filtered or unexported fields
}

func NewElasticHook

func NewElasticHook(client *elastic.Client, host string, level logrus.Level, index string, rotate ESIndexRotate) (*ElasticHook, error)

func (*ElasticHook) Cancel

func (hook *ElasticHook) Cancel()

func (*ElasticHook) Fire

func (hook *ElasticHook) Fire(entry *logrus.Entry) error

func (*ElasticHook) Levels

func (hook *ElasticHook) Levels() []logrus.Level

type Iterator

type Iterator struct {
	C <-chan interface{}
	// contains filtered or unexported fields
}

Iterator defines an iterator over a Set, its C channel can be used to range over the Set's elements.

func (*Iterator) Stop

func (i *Iterator) Stop()

Stop stops the Iterator, no further elements will be received on C, C will be closed.

type LogrusBufferHook

type LogrusBufferHook struct {
	// contains filtered or unexported fields
}

func (*LogrusBufferHook) Cancel

func (hook *LogrusBufferHook) Cancel()

func (*LogrusBufferHook) Fire

func (hook *LogrusBufferHook) Fire(entry *logrus.Entry) error

func (*LogrusBufferHook) Levels

func (hook *LogrusBufferHook) Levels() []logrus.Level

type RingBuffer

type RingBuffer struct {
	// contains filtered or unexported fields
}

func NewRingBuffer

func NewRingBuffer(size int) *RingBuffer

func (*RingBuffer) Read

func (r *RingBuffer) Read() []*RingBufferData

func (*RingBuffer) Write

func (r *RingBuffer) Write(p *RingBufferData)

type RingBufferData

type RingBufferData struct {
	Timestamp string `json:"timestamp"`
	Message   string `json:"message"`
	Level     string `json:"level"`
}

type Set

type Set interface {
	// Adds an element to the set. Returns whether
	// the item was added.
	Add(i interface{}) bool

	// Returns the number of elements in the set.
	Cardinality() int

	// Removes all elements from the set, leaving
	// the empty set.
	Clear()

	// Returns a clone of the set using the same
	// implementation, duplicating all keys.
	Clone() Set

	// Returns whether the given items
	// are all in the set.
	Contains(i ...interface{}) bool

	// Returns the difference between this set
	// and other. The returned set will contain
	// all elements of this set that are not also
	// elements of other.
	//
	// Note that the argument to Difference
	// must be of the same type as the receiver
	// of the method. Otherwise, Difference will
	// panic.
	Difference(other Set) Set

	// Determines if two sets are equal to each
	// other. If they have the same cardinality
	// and contain the same elements, they are
	// considered equal. The order in which
	// the elements were added is irrelevant.
	//
	// Note that the argument to Equal must be
	// of the same type as the receiver of the
	// method. Otherwise, Equal will panic.
	Equal(other Set) bool

	// Returns a new set containing only the elements
	// that exist only in both sets.
	//
	// Note that the argument to Intersect
	// must be of the same type as the receiver
	// of the method. Otherwise, Intersect will
	// panic.
	Intersect(other Set) Set

	// Iterates over elements and executes the passed func against each element.
	// If passed func returns true, stop iteration at the time.
	Each(func(interface{}) bool)

	// Returns a channel of elements that you can
	// range over.
	Iter() <-chan interface{}

	// Returns an Iterator object that you can
	// use to range over the set.
	Iterator() *Iterator

	// Remove a single element from the set.
	Remove(i interface{})

	// Provides a convenient string representation
	// of the current state of the set.
	String() string

	// same type as the receiver of the method.
	// Otherwise, IsSuperset will panic.
	Union(other Set) Set

	// Pop removes and returns an arbitrary item from the set.
	Pop() interface{}

	// Returns the members of the set as a slice.
	ToSlice() []interface{}
}

func NewSet

func NewSet(s ...interface{}) Set

func NewSetFromSlice

func NewSetFromSlice(s []interface{}) Set

type SimpleTimer

type SimpleTimer struct {
	// contains filtered or unexported fields
}

func NewSimpleTimer

func NewSimpleTimer(duration time.Duration) *SimpleTimer

func (*SimpleTimer) Checkpoint

func (t *SimpleTimer) Checkpoint() bool

if timeout, reset it automatically

func (*SimpleTimer) Reset

func (t *SimpleTimer) Reset()

reset timer to now

func (*SimpleTimer) Timeout

func (t *SimpleTimer) Timeout() bool

if time duration past