polaris

Documentation

Index

• func GetPolaris() *polaris.Polaris
• type PlugPolaris
  • func GetPlugin() *PlugPolaris
  • func NewPolarisControlPlane() *PlugPolaris
  • func (p *PlugPolaris) GRPCRateLimit() middleware.Middleware
  • func (p *PlugPolaris) GetConfig(fileName string, group string) (config.Source, error)
  • func (p *PlugPolaris) GetNamespace() string
  • func (p *PlugPolaris) HTTPRateLimit() middleware.Middleware
  • func (p *PlugPolaris) InitializeResources(rt plugins.Runtime) error
  • func (p *PlugPolaris) NewNodeRouter(name string) selector.NodeFilter
  • func (p *PlugPolaris) NewServiceDiscovery() registry.Discovery
  • func (p *PlugPolaris) NewServiceRegistry() registry.Registrar
  • func (p *PlugPolaris) StartupTasks() error

Functions

func GetPolaris

func GetPolaris() *polaris.Polaris

GetPolaris 函数用于从应用的插件管理器中获取 Polaris 实例。 该实例可用于与 Polaris 服务进行交互，如服务发现、配置管理等。 返回值为 *polaris.Polaris 类型的指针，指向获取到的 Polaris 实例。

Types

type PlugPolaris

type PlugPolaris struct {
	*plugins.BasePlugin
	// contains filtered or unexported fields
}

func GetPlugin

func GetPlugin() *PlugPolaris

GetPlugin 函数用于从应用的插件管理器中获取 PlugPolaris 插件实例。 该实例可用于调用插件提供的各种方法。 返回值为 *PlugPolaris 类型的指针，指向获取到的插件实例。

func NewPolarisControlPlane

func NewPolarisControlPlane() *PlugPolaris

NewPolarisControlPlane 创建一个新的 控制平面 Polaris。 该函数初始化插件的基础信息，并返回一个指向 PolarisControlPlane 的指针。

func (*PlugPolaris) GRPCRateLimit

func (p *PlugPolaris) GRPCRateLimit() middleware.Middleware

GRPCRateLimit 方法用于创建一个 gRPC 限流中间件。 该中间件会从 Polaris 获取 gRPC 限流策略，并应用到 gRPC 请求处理流程中。 返回值为一个实现了 middleware.Middleware 接口的中间件实例。

func (*PlugPolaris) GetConfig

func (p *PlugPolaris) GetConfig(fileName string, group string) (config.Source, error)

GetConfig 方法用于从 Polaris 配置中心获取配置。 该方法会根据传入的配置文件名和配置文件组名，从 Polaris 配置中心获取对应的配置源。 参数 fileName 为要获取的配置文件的名称。 参数 group 为配置文件所在的组名。 返回值 config.Source 表示获取到的配置源，可用于后续的配置加载操作。 返回值 error 表示获取配置过程中可能出现的错误，若操作成功则为 nil。

func (*PlugPolaris) GetNamespace

func (p *PlugPolaris) GetNamespace() string

GetNamespace 方法用于获取 PlugPolaris 实例对应的命名空间。 命名空间通常用于在 Polaris 中隔离不同环境或业务的配置和服务。 该方法通过调用 GetPlugin 函数获取 PlugPolaris 插件实例， 然后从该实例的配置中提取命名空间信息。 返回值为字符串类型，表示获取到的命名空间。

func (*PlugPolaris) HTTPRateLimit

func (p *PlugPolaris) HTTPRateLimit() middleware.Middleware

HTTPRateLimit 方法用于创建一个 HTTP 限流中间件。 该中间件会从 Polaris 获取 HTTP 限流策略，并应用到 HTTP 请求处理流程中。 返回值为一个实现了 middleware.Middleware 接口的中间件实例。

func (*PlugPolaris) InitializeResources

func (p *PlugPolaris) InitializeResources(rt plugins.Runtime) error

InitializeResources 实现了 Polaris 插件的自定义初始化逻辑。 该函数会加载并验证 Polaris 配置，如果配置未提供，则使用默认配置。

func (*PlugPolaris) NewNodeRouter

func (p *PlugPolaris) NewNodeRouter(name string) selector.NodeFilter

NewNodeRouter method is used to create a new Polaris node filter for synchronizing the routing policies of remote services

func (*PlugPolaris) NewServiceDiscovery

func (p *PlugPolaris) NewServiceDiscovery() registry.Discovery

NewServiceDiscovery 方法用于创建一个新的 Polaris 服务发现器 The NewServiceDiscovery method is used to create a new Polaris service discoverer. 该方法会记录服务发现的日志信息，并根据配置初始化 Polaris 发现器 This method logs service discovery information and initializes the Polaris discoverer based on the configuration.

func (*PlugPolaris) NewServiceRegistry

func (p *PlugPolaris) NewServiceRegistry() registry.Registrar

NewServiceRegistry 方法用于创建一个新的 Polaris 服务注册器 The NewServiceRegistry method is used to create a new Polaris service registrar. 该方法会记录服务注册的日志信息，并根据配置初始化 Polaris 注册器 This method logs service registration information and initializes the Polaris registrar based on the configuration.

func (*PlugPolaris) StartupTasks

func (p *PlugPolaris) StartupTasks() error

StartupTasks 实现了 HTTP 插件的自定义启动逻辑。 该函数会配置并启动 HTTP 服务器，添加必要的中间件和配置选项。