Skip to content

完整客户端配置

Haotian Zhang edited this page Dec 16, 2024 · 1 revision
server:
  port: 48082 # 端口号
spring:
  application:
    name: QuickstartCallerService # 服务名
  config:
    import: optional:polaris # 开启北极星的配置中心
  cloud:
    polaris:
      address: grpc://119.91.66.223:8091 # 北极星的治理中心地址
      namespace: default # 服务的命名空间,默认default
      enabled: true # 开启北极星服务治理功能
      discovery:
        enabled: true # 开启北极星服务发现,默认true
        register: true  # 开启北极星服务注册,默认true
        heartbeat:
          enabled: true # 开启北极星心跳,默认true
        heartbeat-interval: 5 # 心跳间隔,默认5(秒)
        health-check-url: /quickstart/caller/healthCheck # 心跳前接口检测,默认为空
        zero-protection:
          enabled: true # 开启北极星服务发现零实例保护,默认为false
          is-need-test-connectivity: true # 开启北极星服务发现零实例保护连通性测试,默认为false
        instance-id: QuickstartCallerService-0 # 指定服务注册的实例ID,默认为注册后服务端返回值
        token: NO_TOKEN # 指定连接北极星的TOKEN,默认为空
        weight: 100 # 指定该服务被调用时的权重,默认为100
        version: 2.0.0.0 # 指定该服务注册时的版本号,默认为1.0.0
        protocol: HTTP # 指定该服务的对外提供服务协议,默认为HTTP
        service-list-refresh-interval: 60000 # 指定服务列表刷新间隔,默认为60000(毫秒)
        eager-load:
          enabled: true # 服务发现预热功能总开关,默认为false
          feign:
            enabled: true # Feign 服务发现预热开关,默认为true
      config:
        address: grpc://119.91.66.223:8093 # 北极星的配置中心地址
        port: 8093 # 北极星的配置中心端口,默认为8093
        auto-refresh: true # 开启北极星配置自动刷新,默认为true
        refresh-type: reflect # 指定北极星配置刷新机制,默认为refresh_context,可选reflect、refresh_context
        data-source: polaris # 指定配置来源,默认为polaris
        groups:
          - name: ${spring.application.name} # 指定北极星配置分组名
            files: [ "config/caller.properties" ] # 指定北极星配置文件名列表
        enabled: true # 开启北极星配置中心功能
        token: NO_TOKEN # 指定连接北极星的TOKEN,默认为空
        shutdown-if-connect-to-config-server-failed: true # 开启配置中心连接快速失败,默认为true
        local-file-root-path: ./polaris/backup/config # 指定本地配置
        internal-enabled: true # 开启内部配置文件拉取,默认为true
        connect-remote-server: true # 是否连接远端配置中心,默认为true
        crypto:
          enabled: true # 开启配置加密,默认为true
      loadbalancer:
        strategy: roundRobin # 负载均衡策略,默认为polarisWeightedRoundRobin,可选roundRobin、random、polarisWeightedRandom、polarisRingHash、polarisWeightedRoundRobin
      contract:
        enabled: true # 开启服务契约,默认为true
        exposure: true # 开启服务契约接口,默认为true
        report:
          enabled: true # 开启服务契约上报,默认为true
        base-package: com.tencent.cloud # 指定服务契约扫描的基础路径
        exclude-path: /echo # 排除以下路径的服务契约扫描,逗号分隔
        group: polaris # 指定服务契约分组,默认为polaris
        base-path: /** # 扫描以下路径的服务契约,逗号分隔,默认为/**
        name: Polaris # 服务契约名称,默认为服务名
      circuitbreaker:
        enabled: true # 开启服务熔断功能,默认为true
      ratelimit:
        enabled: true # 开启服务限流功能,默认为true
        reject-http-code: 429 # 服务限流时的返回码,默认为429
        reject-request-tips: ratelimited # 服务限流时的返回字段
        rejectRequestTipsFilePath: reject-tips.html # 服务限流时的返回HTML
        maxQueuingTime: 1000 # 匀速排队限流的最大排队时间,默认为1000(毫秒)
      router:
        enabled: true # 开启服务路由功能,默认为true
        metadata-router:
          enabled: true # 开启元数据路由,默认为true
        namespace-router:
          enabled: true # 开启命名空间路由,默认为false
          fail-over: all # 命名空间路由降级配置,默认为all,可选none
        nearby-router:
          enabled: true # 开启就近访问,默认为false
          match-level: ZONE # 指定最低就近级别,默认为ZONE,可选CAMPUS、ZONE、REGION
        rule-router:
          enabled: true # 开启规则路由,默认为true
          fail-over: all # 规则路由降级配置,默认为all,可选none
      admin:
        port: 28083 # 管理端口,默认为28080
      stat:
        enabled: true # 开启监控,默认为true
        path: /metrics # Prometheus的path,默认为/metrics
        pushgateway:
          enabled: true # 开启pushgateway模式,默认为false
          address: 119.91.66.223:9091 # 指定pushgateway地址
          push-interval: 30000 # 指定pushgateway间隔,默认为30000(毫秒)
      lossless:
        enabled: false # 开启优雅上下线,默认为false
        health-check-path: /health # 健康检查路径
        delay-register-interval: 30000 # 延迟上线时间,默认为30000(毫秒)
        health-check-interval: 1000 # 健康检查间隔,默认为1000(毫秒)
      local-ip-address: 127.0.0.1 # 指定注册ip
      local-port: 48082 # 指定注册端口号
      logging:
        path: ./polaris/logs # 指定北极星日志路径
    tencent:
      metadata:
        content:
          transk: transv # 指定服务实例元数据
          dispk: dispv
          region: huanan
          zone: shenzhen
          campus: shenzhen-1
        transitive:
          - tranv # 指定传递元数据的key列表
        disposable:
          - dispk # 指定单跳元数据的key列表
        headers:
          - headerk # 指定原始头部传递的key列表
      rpc-enhancement:
        enabled: true # 开启调用增强组件,默认为true
        reporter:
          enabled: true # 开启服务调用上报
          ignore-internal-server-error: true # 是否忽略500,默认为true
          series: server_error # 指定服务错误的HTTP系列码,默认为server_error(5xx)
          statuses: gateway_timeout, bad_gateway, service_unavailable # 指定服务错误的HTTP错误码
management:
  endpoints:
    web:
      exposure:
        include:
          - polarisdiscovery # 开启服务注册发现端点
          - polariscircuitbreaker # 开启服务熔断端点
          - polarisconfig # 开启动态配置端点
          - polarisroute # 开启服务路由端点
          - polarisratelimit # 开启服务限流端点
          - polarismetadata # 开启服务元数据端点
Clone this wiki locally