package
1.6.0-beta.5
Repository: https://github.com/polarismesh/polaris-go.git
Documentation: pkg.go.dev
# README
Polaris Go API方法使用
配置API
配置初始化
// 使用默认配置对象来初始化配置,连接默认的北极星埋点域名
cfg := api.NewConfiguration()
修改北极星后端集群名
// 先初始化配置
cfg := api.NewConfiguration()
// 修改发现server集群名
cfg.GetGlobal().GetSystem().GetDiscoverCluster().SetService("polaris-server")
// 修改心跳server集群名
cfg.GetGlobal().GetSystem().GetHealthCheckCluster().SetService("healthcheck")
// 修改监控server集群名
cfg.GetGlobal().GetSystem().GetHealthCheckCluster().SetService("polaris.monitor")
修改北极星日志路径
假如需要修改北极星的日志打印目录,可以按照以下方式进行修改
if err := api.SetLoggersDir("/tmp/polaris/log"); err != nil {
// do error handle
}
修改北极星日志级别
假如需要修改北极星的日志打印级别,可以按照以下方式进行修改
if err := api.SetLoggersLevel(api.InfoLog); err != nil {
// do error handle
}
日志级别支持NoneLog, TraceLog, DebugLog, InfoLog, WarnLog, ErrorLog, FatalLog,设置成NoneLog,则不打印任何日志
同时修改北极星日志路径及日志级别
polaris-go启动后,默认会在程序运行的当前目录创建polaris/log目录,用于存放运行过程中的日志。因此用户需要保证当前目录有写权限 假如需要修改北极星的日志打印目录以及日志级别,可以按照以下方式进行修改
if err := api.ConfigLoggers("/tmp/polaris/log", api.InfoLog); err != nil {
// do error handle
}
# Functions
CheckAvailable 判断API是否可用.
ConfigBaseLogger 配置基础日志对象.
ConfigCacheLogger 配置缓存更新日志对象.
ConfigDetectLogger 配置探测日志对象.
ConfigLoggers 全局配置日志对象.
ConfigNetworkLogger 配置网络交互日志对象.
ConfigStatLogger 配置统计日志对象.
ConfigStatReportLogger 配置统计上报日志对象.
GetBaseLogger 获取基础日志对象.
GetCacheLogger 获取缓存日志对象.
GetDetectLogger 获取探测日志对象.
GetStatLogger 获取统计日志对象.
GetStatReportLogger 获取统计上报日志对象.
InitContextByConfig InitContextByStream 通过配置对象新建上下文.
InitContextByFile 通过配置文件新建服务消费者配置.
InitContextByStream 通过YAML流新建服务消费者配置.
NewConfiguration 创建默认配置.
NewQuotaRequest 创建配额查询请求.
SetBaseLogger 设置基础日志对象.
SetCacheLogger 设置缓存日志对象.
SetDetectLogger 设置探测日志对象.
SetLoggersDir 设置日志的目录,会创建新的具有默认打印级别的logger.
SetLoggersLevel 设置所有日志级别.
SetStatLogger 设置统计日志对象.
SetStatReportLogger 设置统计上报日志对象.
# Constants
DebugLog 调试级别.
DefaultBaseLogLevel 默认基本日志级别.
DefaultCacheLogLevel 默认缓存日志级别.
DefaultDetectLogLevel 默认探测日志级别.
DefaultNetworkLogLevel 默认网络交互日志级别.
DefaultStatLogLevel 默认统计日志级别.
DefaultStatReportLogLevel 默认统计上报日志级别.
ErrorLog 错误日志级别.
EventInstance .
FatalLog 致命级别.
InfoLog 一般日志级别.
LBPolicyL5CST L5一致性Hash兼容算法,保证和L5产生相同的结果.
LBPolicyMaglev Maglev算法的一致性hash负载均衡策略.
LBPolicyRingHash 权重一致性hash负载均衡策略.
LBPolicyWeightedRandom 权重随机负载均衡策略.
NoneLog 当要禁止日志的时候,可以设置此级别.
QuotaResultLimited 限流结果.
QuotaResultOk 限流状态值.
RetFail call fails.
RetSuccess the call is successful.
TraceLog 跟踪级别.
WarnLog 警告日志级别.
WatchModeLongPull watch model by long pulling, the invocation would be hang on until revision updated or timeout.
WatchModeNotify watch model by notify to listener.
# Variables
NewConsumerAPI 通过以默认域名为埋点server的默认配置创建 CircuitBreakerAPI.
NewCircuitBreakerByConfig 通过配置对象创建SDK CircuitBreakerAPI 对象.
NewCircuitBreakerByContext 通过上下文创建SDK CircuitBreakerAPI 对象.
NewCircuitBreakerByFile 通过配置文件创建SDK CircuitBreakerAPI 对象.
NewConfigFileAPI 通过 polaris.yaml 创建 ConfigFileAPI.
NewConfigFileAPIByConfig 通过 Configuration 创建 ConfigFileAPI.
NewConfigFileAPIByFile 通过配置文件创建 ConfigFileAPI.
NewConfigFileAPIBySDKContext 通过 SDKContext 创建 ConfigFileAPI.
NewConfigGroupAPI 通过 polaris.yaml 创建 ConfigGroupAPI.
NewConfigGroupAPIByConfig 通过 Configuration 创建 ConfigGroupAPI.
NewConfigGroupAPIByFile 通过配置文件创建 ConfigGroupAPI.
NewConfigGroupAPIBySDKContext 通过 SDKContext 创建 ConfigGroupAPI.
NewConsumerAPI 通过以默认域名为埋点server的默认配置创建ConsumerAPI.
NewConsumerAPIByAddress 通过address创建ConsumerAPI对象.
NewConsumerAPIByConfig 通过配置对象创建SDK ConsumerAPI对象.
NewConsumerAPIByContext 通过上下文创建SDK ConsumerAPI对象.
NewConsumerAPIByDefaultConfigFile 从系统默认配置文件中创建ConsumerAPI.
NewConsumerAPIByFile 通过配置文件创建SDK ConsumerAPI对象.
NewLimitAPI 通过以默认域名为埋点server的默认配置创建LimitAPI.
NewLimitAPIByAddress 通过address创建LimitAPI.
NewLimitAPIByConfig 通过配置对象创建LimitAPI.
NewLimitAPIByContext 通过sdkContext创建LimitAPI.
NewLimitAPIByFile 通过配置文件创建SDK LimitAPI对象.
NewProviderAPI 通过以默认域名为埋点server的默认配置创建ProviderAPI.
NewProviderAPIByAddress 通过address创建ProviderAPI对象.
NewProviderAPIByConfig 通过配置对象创建SDK ProviderAPI对象.
NewProviderAPIByContext 通过上下文创建SDK ProviderAPI对象.
NewProviderAPIByDefaultConfigFile 通过系统默认配置文件创建ProviderAPI.
NewProviderAPIByFile 通过配置文件创建SDK ProviderAPI对象.
NewServiceCallResult 创建上报对象.
# Structs
GetAllInstancesRequest 获取服务下所有实例的请求对象.
No description provided by the author
GetInstancesRequest 获取多个服务的请求对象.
GetOneInstanceRequest 获取单个服务的请求对象.
GetServiceRuleRequest 获取服务规则请求.
GetServicesRequest 获取批量服务请求.
InitCalleeServiceRequest .
InstanceDeRegisterRequest 反注册服务请求.
InstanceHeartbeatRequest 心跳上报请求.
InstanceRegisterRequest 注册服务请求.
InstanceRequest 实例请求.
No description provided by the author
No description provided by the author
ServiceCallResult 服务调用结果.
WatchAllInstancesRequest .
WatchAllServicesRequest .
WatchServiceRequest WatchService req.
# Interfaces
CircuitBreakerAPI .
ConfigFileAPI 配置文件的 API.
No description provided by the author
ConsumerAPI 主调端API方法.
LimitAPI 限流相关的API相关接口.
ProviderAPI CL5服务端API的主接口.
QuotaFuture 实时/延时分配future.
QuotaRequest 配额查询请求.
No description provided by the author
SDKContext .
SDKOwner 获取SDK上下文接口.
# Type aliases
Logger 别名类.