README
¶
agollo is a golang client for apollo 🚀 
Simple chinese
Feature
- Multiple namespace support
- Fail tolerant
- Zero dependency
- Realtime change notification
Required
go 1.9 or later
Installation
Since we hacked something in upstream repo, just install the agollo via the following command:
go get -u github.com/Colstuwjx/agollo
Usage
Start use default app.properties config file
agollo.Start()
Start use given config file path
agollo.StartWithConfFile(name)
Subscribe to updates
events := agollo.WatchUpdate()
changeEvent := <-events
bytes, _ := json.Marshal(changeEvent)
fmt.Println("event:", string(bytes))
Get apollo values
agollo.GetStringValue(Key, defaultValue)
agollo.GetStringValueWithNameSpace(namespace, key, defaultValue)
Get namespace file contents
agollo.GetNameSpaceContent(namespace, defaultValue)
Get all keys
agollo.GetAllKeys(namespace)
Subscribe to new namespaces
agollo.SubscribeToNamespaces("newNamespace1", "newNamespace2")
License
agollo is released under MIT license
Documentation
¶
Index ¶
- func GetAllKeys(namespace string) []string
- func GetNameSpaceContent(namespace, defaultValue string) string
- func GetStringValue(key, defaultValue string) string
- func GetStringValueWithNameSpace(namespace, key, defaultValue string) string
- func Start() error
- func StartWithConf(conf *Conf) error
- func StartWithConfFile(name string) error
- func Stop() error
- func SubscribeToNamespaces(namespaces ...string) error
- func WatchUpdate() <-chan *ChangeEvent
- type Change
- type ChangeEvent
- type ChangeType
- type Client
- func (c *Client) Download(namespace, filepath string) error
- func (c *Client) GetAllKeys(namespace string) []string
- func (c *Client) GetNameSpaceContent(namespace, defaultValue string) string
- func (c *Client) GetStringValue(key, defaultValue string) string
- func (c *Client) GetStringValueWithNameSpace(namespace, key, defaultValue string) string
- func (c *Client) Start() error
- func (c *Client) Stop() error
- func (c *Client) SubscribeToNamespaces(namespaces ...string) error
- func (c *Client) WatchUpdate() <-chan *ChangeEvent
- type Conf
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetAllKeys ¶
GetAllKeys return all config keys in given namespace
func GetNameSpaceContent ¶
GetNameSpaceContent get contents of namespace
func GetStringValue ¶
GetStringValue from default namespace
func GetStringValueWithNameSpace ¶
GetStringValueWithNameSpace get value from given namespace
func StartWithConfFile ¶
StartWithConfFile run agollo with conf file
func SubscribeToNamespaces ¶
SubscribeToNamespaces fetch namespace config to local and subscribe to updates
Types ¶
type Change ¶
type Change struct {
OldValue string
NewValue string
ChangeType ChangeType
}
Change represent a single key change
type ChangeEvent ¶
ChangeEvent change event
type ChangeType ¶
type ChangeType int
ChangeType for a key
const ( // ADD a new value ADD ChangeType = iota // MODIFY a old value MODIFY // DELETE ... DELETE )
func (ChangeType) String ¶
func (c ChangeType) String() string
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for apollo
func (*Client) GetAllKeys ¶
GetAllKeys return all config keys in given namespace
func (*Client) GetNameSpaceContent ¶
GetNameSpaceContent get contents of namespace
func (*Client) GetStringValue ¶
GetStringValue from default namespace
func (*Client) GetStringValueWithNameSpace ¶
GetStringValueWithNameSpace get value from given namespace
func (*Client) SubscribeToNamespaces ¶
SubscribeToNamespaces fetch namespace config to local and subscribe to updates
func (*Client) WatchUpdate ¶
func (c *Client) WatchUpdate() <-chan *ChangeEvent
WatchUpdate get all updates
Source Files
Directories