Documentation
¶
Index ¶
- Constants
- func BaseLogFallbackFilePath(filePath string) string
- func CacheKey(key string) string
- func DefaultJSON(key string) (string, error)
- func IsSupportedKey(key string) bool
- func Keys() []string
- func LoadJSON(store cache.Cache, key string, target proto.Message) error
- func MergeSensitiveJSON(key, current, incoming string) (string, error)
- func RedactJSON(key, value string) (string, error)
- func Register(definition Definition) error
- func ResolveBaseLogFallbackIntegrityKey() (string, error)
- func SaveJSON(store cache.Cache, key, value string) error
- func SensitiveFields(key string) []string
- func ValidateJSON(key, value string) error
- type BaseLogFallbackConfig
- type Definition
- type Registry
- func (r *Registry) CanonicalJSON(key, value string) (string, error)
- func (r *Registry) DefaultJSON(key string) (string, error)
- func (r *Registry) Definition(key string) (Definition, error)
- func (r *Registry) Definitions() []Definition
- func (r *Registry) IsSupportedKey(key string) bool
- func (r *Registry) Keys() []string
- func (r *Registry) LoadJSON(store cache.Cache, key string, target proto.Message) error
- func (r *Registry) MergeSensitiveJSON(key, current, incoming string) (string, error)
- func (r *Registry) RedactJSON(key, value string) (string, error)
- func (r *Registry) Register(definition Definition) error
- func (r *Registry) SaveJSON(store cache.Cache, key, value string) error
- func (r *Registry) SensitiveFields(key string) ([]string, error)
- func (r *Registry) ValidateJSON(key, value string) error
Constants ¶
View Source
const ( // BaseLogFallbackKey 表示日志入库回退配置键。 BaseLogFallbackKey = "baseLogFallback" // CacheExpire 表示运行配置缓存有效期。 CacheExpire = 100 * 365 * 24 * time.Hour // BaseLogFallbackFileName 表示日志入库回退文件的固定文件名。 BaseLogFallbackFileName = "admin-log.jsonl" // BaseLogFallbackIntegrityKeyName 表示日志入库回退完整性密钥的固定名称。 BaseLogFallbackIntegrityKeyName = "kratos-admin:base-log-fallback/integrity" // RedactedValue 表示管理端返回的敏感配置占位值。 RedactedValue = "[REDACTED]" )
Variables ¶
This section is empty.
Functions ¶
func BaseLogFallbackFilePath ¶
BaseLogFallbackFilePath 根据配置目录返回日志入库回退文件路径。
func DefaultJSON ¶
DefaultJSON 使用进程内默认注册表生成默认 ProtoJSON。
func MergeSensitiveJSON ¶
MergeSensitiveJSON 使用进程内默认注册表恢复敏感配置占位值。
func RedactJSON ¶
RedactJSON 使用进程内默认注册表脱敏运行配置 JSON。
func ResolveBaseLogFallbackIntegrityKey ¶
ResolveBaseLogFallbackIntegrityKey 从运行时密钥服务派生日志回退完整性密钥。
func ValidateJSON ¶
ValidateJSON 使用进程内默认注册表校验配置 ProtoJSON。
Types ¶
type BaseLogFallbackConfig ¶
type BaseLogFallbackConfig = configv1.BaseLogFallbackConfig
BaseLogFallbackConfig 表示日志入库回退配置。
func DefaultBaseLogFallbackConfig ¶
func DefaultBaseLogFallbackConfig() BaseLogFallbackConfig
DefaultBaseLogFallbackConfig 返回日志入库回退配置默认值。
type Definition ¶
type Definition struct {
// Key 是配置在数据库和缓存中的稳定键。
Key string
// New 创建一个不带默认值的 Proto 配置消息。
New func() proto.Message
// Default 创建一个带业务默认值的 Proto 配置消息。
Default func() proto.Message
// Owner 标识贡献该配置的模块。
Owner string
// NameKey 是配置名称的国际化消息键。
NameKey string
// DescriptionKey 是配置说明的国际化消息键。
DescriptionKey string
// SensitiveFields 是需要在管理端和缓存诊断中脱敏的 Proto 字段路径。
SensitiveFields []string
}
Definition 描述一个可被 Admin 管理的运行配置。
type Registry ¶
type Registry struct {
// contains filtered or unexported fields
}
Registry 管理运行配置定义，并为配置读写提供稳定的 Proto 接缝。
func NewRegistry ¶
func NewRegistry(values ...Definition) (*Registry, error)
NewRegistry 创建包含 Admin 内置配置的运行配置注册表。
func (*Registry) CanonicalJSON ¶
CanonicalJSON 将配置 JSON 规范化为带默认字段的 ProtoJSON。
func (*Registry) DefaultJSON ¶
DefaultJSON 返回配置键对应的默认 ProtoJSON。
func (*Registry) Definition ¶
func (r *Registry) Definition(key string) (Definition, error)
Definition 返回指定配置键的定义。
func (*Registry) Definitions ¶
func (r *Registry) Definitions() []Definition
Definitions 返回按配置键排序的运行配置定义快照。
func (*Registry) IsSupportedKey ¶
IsSupportedKey 判断配置键是否已注册。
func (*Registry) MergeSensitiveJSON ¶
MergeSensitiveJSON 将管理端提交的敏感字段占位值替换为当前已保存值。
func (*Registry) RedactJSON ¶
RedactJSON 将运行配置中的敏感字段替换为管理端占位值。
func (*Registry) Register ¶
func (r *Registry) Register(definition Definition) error
Register 向注册表追加一个运行配置定义。
func (*Registry) SensitiveFields ¶
SensitiveFields 返回指定配置需要脱敏的字段路径。
func (*Registry) ValidateJSON ¶
ValidateJSON 解析并校验指定配置的 ProtoJSON。
Source Files
Click to show internal directories.
Click to hide internal directories.