esentinel

README

https://sentinelguard.io/zh-cn/docs/golang/basic-api-usage.html

Documentation

Index

• Constants
• func IsResExist(res string) bool
• type Component
• type Config
  • func DefaultConfig() *Config
• type Container
  • func DefaultContainer() *Container
  • func Load(key string) *Container
  • func (c *Container) Build(options ...Option)
• type Option

Constants

const PackageName = "core.sentinel"

PackageName component name

Functions

func IsResExist

func IsResExist(res string) bool

IsResExist check if a resource exists

Types

type Component

type Component struct {
}

Component defines component's configuration schema, name, logger, etc.

type Config

type Config struct {
	AppName       string `json:"appName"`       // 应用名，默认从ego框架内部获取
	LogPath       string `json:"logPath"`       // 日志路径，默认./logs
	FlowRulesFile string `json:"flowRulesFile"` // 限流配置路径
}

Config defines component configuration schema

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig returns default config for sentinel

type Container

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

Container defines a component instance.

func DefaultContainer

func DefaultContainer() *Container

DefaultContainer returns an default container.

func Load

func Load(key string) *Container

Load parses container configuration from configuration provider, such as a toml file, then use the configuration to construct a component container.

func (*Container) Build

func (c *Container) Build(options ...Option)

Build constructs a specific component from container.

type Option

type Option func(c *Container)

Option overrides a Container's default configuration.