| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <title>Pegasus | Config</title> |
| <link rel="stylesheet" href="/zh/assets/css/app.css"> |
| <link rel="shortcut icon" href="/zh/assets/images/favicon.ico"> |
| <link rel="stylesheet" href="/zh/assets/css/utilities.min.css"> |
| <link rel="stylesheet" href="/zh/assets/css/docsearch.v3.css"> |
| <script src="/assets/js/jquery.min.js"></script> |
| <script src="/assets/js/all.min.js"></script> |
| <script src="/assets/js/docsearch.v3.js"></script> |
| <!-- Begin Jekyll SEO tag v2.8.0 --> |
| <title>Config | Pegasus</title> |
| <meta name="generator" content="Jekyll v4.3.3" /> |
| <meta property="og:title" content="Config" /> |
| <meta property="og:locale" content="en_US" /> |
| <meta name="description" content="获取配置" /> |
| <meta property="og:description" content="获取配置" /> |
| <meta property="og:site_name" content="Pegasus" /> |
| <meta property="og:type" content="article" /> |
| <meta property="article:published_time" content="2024-04-22T13:02:52+00:00" /> |
| <meta name="twitter:card" content="summary" /> |
| <meta property="twitter:title" content="Config" /> |
| <script type="application/ld+json"> |
| {"@context":"https://schema.org","@type":"BlogPosting","dateModified":"2024-04-22T13:02:52+00:00","datePublished":"2024-04-22T13:02:52+00:00","description":"获取配置","headline":"Config","mainEntityOfPage":{"@type":"WebPage","@id":"/administration/config"},"url":"/administration/config"}</script> |
| <!-- End Jekyll SEO tag --> |
| </head> |
| |
| |
| <body> |
| <div class="dashboard is-full-height"> |
| <!-- left panel --> |
| <div class="dashboard-panel is-medium is-hidden-mobile pl-0"> |
| <div class="dashboard-panel-header has-text-centered"> |
| <a href="/zh/"> |
| <img src="/assets/images/pegasus-logo-inv.png" style="width: 80%;"> |
| </a> |
| |
| </div> |
| <div class="dashboard-panel-main is-scrollable pl-6"> |
| |
| |
| <aside class="menu"> |
| |
| <p class="menu-label">Pegasus 产品文档</p> |
| <ul class="menu-list"> |
| |
| <li> |
| <a href="/zh/docs/downloads" |
| class=""> |
| 下载 |
| </a> |
| </li> |
| |
| </ul> |
| |
| <p class="menu-label">编译构建</p> |
| <ul class="menu-list"> |
| |
| <li> |
| <a href="/zh/docs/build/compile-by-docker" |
| class=""> |
| 使用 Docker 完成编译（推荐） |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/docs/build/compile-from-source" |
| class=""> |
| 从源码编译 |
| </a> |
| </li> |
| |
| </ul> |
| |
| <p class="menu-label">客户端库</p> |
| <ul class="menu-list"> |
| |
| <li> |
| <a href="/zh/clients/java-client" |
| class=""> |
| Java 客户端 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/clients/cpp-client" |
| class=""> |
| C++ 客户端 |
| </a> |
| </li> |
| |
| <li> |
| <a href="https://github.com/apache/incubator-pegasus/tree/master/go-client" |
| class=""> |
| Golang 客户端 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/clients/python-client" |
| class=""> |
| Python 客户端 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/clients/node-client" |
| class=""> |
| NodeJS 客户端 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/clients/scala-client" |
| class=""> |
| Scala 客户端 |
| </a> |
| </li> |
| |
| </ul> |
| |
| <p class="menu-label">生态工具</p> |
| <ul class="menu-list"> |
| |
| <li> |
| <a href="/zh/docs/tools/shell" |
| class=""> |
| Pegasus Shell 工具 |
| </a> |
| </li> |
| |
| <li> |
| <a href="https://github.com/pegasus-kv/admin-cli" |
| class=""> |
| 集群管理命令行 |
| </a> |
| </li> |
| |
| <li> |
| <a href="https://github.com/pegasus-kv/pegic" |
| class=""> |
| 数据访问命令行 |
| </a> |
| </li> |
| |
| </ul> |
| |
| <p class="menu-label">用户接口</p> |
| <ul class="menu-list"> |
| |
| <li> |
| <a href="/zh/api/ttl" |
| class=""> |
| TTL |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/api/single-atomic" |
| class=""> |
| 单行原子操作 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/api/redis" |
| class=""> |
| Redis 适配 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/api/geo" |
| class=""> |
| GEO 支持 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/api/http" |
| class=""> |
| HTTP 接口 |
| </a> |
| </li> |
| |
| </ul> |
| |
| <p class="menu-label">高效运维</p> |
| <ul class="menu-list"> |
| |
| <li> |
| <a href="/zh/administration/deployment" |
| class=""> |
| 集群部署 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/config" |
| class="is-active"> |
| 配置说明 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/rebalance" |
| class=""> |
| 负载均衡 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/monitoring" |
| class=""> |
| 可视化监控 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/rolling-update" |
| class=""> |
| 集群重启和升级 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/scale-in-out" |
| class=""> |
| 集群扩容缩容 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/resource-management" |
| class=""> |
| 资源管理 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/cold-backup" |
| class=""> |
| 冷备份 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/meta-recovery" |
| class=""> |
| 元数据恢复 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/replica-recovery" |
| class=""> |
| Replica 数据恢复 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/zk-migration" |
| class=""> |
| Zookeeper 迁移 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/table-migration" |
| class=""> |
| Table 迁移 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/table-soft-delete" |
| class=""> |
| Table 软删除 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/table-env" |
| class=""> |
| Table 环境变量 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/remote-commands" |
| class=""> |
| 远程命令 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/partition-split" |
| class=""> |
| Partition-Split |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/duplication" |
| class=""> |
| 跨机房同步 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/compression" |
| class=""> |
| 数据压缩 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/throttling" |
| class=""> |
| 流量控制 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/experiences" |
| class=""> |
| 运维经验 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/manual-compact" |
| class=""> |
| Manual Compact 功能 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/usage-scenario" |
| class=""> |
| Usage Scenario 功能 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/bad-disk" |
| class=""> |
| 坏盘检修 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/whitelist" |
| class=""> |
| Replica Server 白名单 |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/backup-request" |
| class=""> |
| Backup Request |
| </a> |
| </li> |
| |
| <li> |
| <a href="/zh/administration/hotspot-detection" |
| class=""> |
| 热点检测 |
| </a> |
| </li> |
| |
| </ul> |
| |
| </aside> |
| </div> |
| </div> |
| |
| <!-- main section --> |
| <div class="dashboard-main is-scrollable"> |
| <nav class="navbar is-hidden-desktop"> |
| <div class="navbar-brand"> |
| <a href="/zh/" class="navbar-item"> |
| <!-- Pegasus Icon --> |
| <img src="/assets/images/pegasus-square.png"> |
| </a> |
| <div class="navbar-item"> |
| |
| |
| <!--A simple language switch button that only supports zh and en.--> |
| <!--IF its language is zh, then switches to en.--> |
| |
| <!--If you don't want a url to be relativized, you can add a space explicitly into the href to |
| prevents a url from being relativized by polyglot.--> |
| <a class="button is-light is-outlined is-inverted" href=" /administration/config"><strong>En</strong></a> |
| |
| </div> |
| <a role="button" class="navbar-burger burger" aria-label="menu" aria-expanded="false" data-target="navMenu"> |
| <!-- Appears in mobile mode only --> |
| <span aria-hidden="true"></span> |
| <span aria-hidden="true"></span> |
| <span aria-hidden="true"></span> |
| </a> |
| </div> |
| <div class="navbar-menu" id="navMenu"> |
| <div class="navbar-end"> |
| |
| <!--dropdown--> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a href="" |
| class="navbar-link "> |
| <span> |
| Pegasus 产品文档 |
| </span> |
| </a> |
| <div class="navbar-dropdown"> |
| |
| <a href="/zh/docs/downloads" |
| class="navbar-item "> |
| 下载 |
| </a> |
| |
| </div> |
| </div> |
| |
| <!--dropdown--> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a href="" |
| class="navbar-link "> |
| <span> |
| 编译构建 |
| </span> |
| </a> |
| <div class="navbar-dropdown"> |
| |
| <a href="/zh/docs/build/compile-by-docker" |
| class="navbar-item "> |
| 使用 Docker 完成编译（推荐） |
| </a> |
| |
| <a href="/zh/docs/build/compile-from-source" |
| class="navbar-item "> |
| 从源码编译 |
| </a> |
| |
| </div> |
| </div> |
| |
| <!--dropdown--> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a href="" |
| class="navbar-link "> |
| <span> |
| 客户端库 |
| </span> |
| </a> |
| <div class="navbar-dropdown"> |
| |
| <a href="/zh/clients/java-client" |
| class="navbar-item "> |
| Java 客户端 |
| </a> |
| |
| <a href="/zh/clients/cpp-client" |
| class="navbar-item "> |
| C++ 客户端 |
| </a> |
| |
| <a href="https://github.com/apache/incubator-pegasus/tree/master/go-client" |
| class="navbar-item "> |
| Golang 客户端 |
| </a> |
| |
| <a href="/zh/clients/python-client" |
| class="navbar-item "> |
| Python 客户端 |
| </a> |
| |
| <a href="/zh/clients/node-client" |
| class="navbar-item "> |
| NodeJS 客户端 |
| </a> |
| |
| <a href="/zh/clients/scala-client" |
| class="navbar-item "> |
| Scala 客户端 |
| </a> |
| |
| </div> |
| </div> |
| |
| <!--dropdown--> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a href="" |
| class="navbar-link "> |
| <span> |
| 生态工具 |
| </span> |
| </a> |
| <div class="navbar-dropdown"> |
| |
| <a href="/zh/docs/tools/shell" |
| class="navbar-item "> |
| Pegasus Shell 工具 |
| </a> |
| |
| <a href="https://github.com/pegasus-kv/admin-cli" |
| class="navbar-item "> |
| 集群管理命令行 |
| </a> |
| |
| <a href="https://github.com/pegasus-kv/pegic" |
| class="navbar-item "> |
| 数据访问命令行 |
| </a> |
| |
| </div> |
| </div> |
| |
| <!--dropdown--> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a href="" |
| class="navbar-link "> |
| <span> |
| 用户接口 |
| </span> |
| </a> |
| <div class="navbar-dropdown"> |
| |
| <a href="/zh/api/ttl" |
| class="navbar-item "> |
| TTL |
| </a> |
| |
| <a href="/zh/api/single-atomic" |
| class="navbar-item "> |
| 单行原子操作 |
| </a> |
| |
| <a href="/zh/api/redis" |
| class="navbar-item "> |
| Redis 适配 |
| </a> |
| |
| <a href="/zh/api/geo" |
| class="navbar-item "> |
| GEO 支持 |
| </a> |
| |
| <a href="/zh/api/http" |
| class="navbar-item "> |
| HTTP 接口 |
| </a> |
| |
| </div> |
| </div> |
| |
| <!--dropdown--> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a href="" |
| class="navbar-link "> |
| <span> |
| 高效运维 |
| </span> |
| </a> |
| <div class="navbar-dropdown"> |
| |
| <a href="/zh/administration/deployment" |
| class="navbar-item "> |
| 集群部署 |
| </a> |
| |
| <a href="/zh/administration/config" |
| class="navbar-item is-active"> |
| 配置说明 |
| </a> |
| |
| <a href="/zh/administration/rebalance" |
| class="navbar-item "> |
| 负载均衡 |
| </a> |
| |
| <a href="/zh/administration/monitoring" |
| class="navbar-item "> |
| 可视化监控 |
| </a> |
| |
| <a href="/zh/administration/rolling-update" |
| class="navbar-item "> |
| 集群重启和升级 |
| </a> |
| |
| <a href="/zh/administration/scale-in-out" |
| class="navbar-item "> |
| 集群扩容缩容 |
| </a> |
| |
| <a href="/zh/administration/resource-management" |
| class="navbar-item "> |
| 资源管理 |
| </a> |
| |
| <a href="/zh/administration/cold-backup" |
| class="navbar-item "> |
| 冷备份 |
| </a> |
| |
| <a href="/zh/administration/meta-recovery" |
| class="navbar-item "> |
| 元数据恢复 |
| </a> |
| |
| <a href="/zh/administration/replica-recovery" |
| class="navbar-item "> |
| Replica 数据恢复 |
| </a> |
| |
| <a href="/zh/administration/zk-migration" |
| class="navbar-item "> |
| Zookeeper 迁移 |
| </a> |
| |
| <a href="/zh/administration/table-migration" |
| class="navbar-item "> |
| Table 迁移 |
| </a> |
| |
| <a href="/zh/administration/table-soft-delete" |
| class="navbar-item "> |
| Table 软删除 |
| </a> |
| |
| <a href="/zh/administration/table-env" |
| class="navbar-item "> |
| Table 环境变量 |
| </a> |
| |
| <a href="/zh/administration/remote-commands" |
| class="navbar-item "> |
| 远程命令 |
| </a> |
| |
| <a href="/zh/administration/partition-split" |
| class="navbar-item "> |
| Partition-Split |
| </a> |
| |
| <a href="/zh/administration/duplication" |
| class="navbar-item "> |
| 跨机房同步 |
| </a> |
| |
| <a href="/zh/administration/compression" |
| class="navbar-item "> |
| 数据压缩 |
| </a> |
| |
| <a href="/zh/administration/throttling" |
| class="navbar-item "> |
| 流量控制 |
| </a> |
| |
| <a href="/zh/administration/experiences" |
| class="navbar-item "> |
| 运维经验 |
| </a> |
| |
| <a href="/zh/administration/manual-compact" |
| class="navbar-item "> |
| Manual Compact 功能 |
| </a> |
| |
| <a href="/zh/administration/usage-scenario" |
| class="navbar-item "> |
| Usage Scenario 功能 |
| </a> |
| |
| <a href="/zh/administration/bad-disk" |
| class="navbar-item "> |
| 坏盘检修 |
| </a> |
| |
| <a href="/zh/administration/whitelist" |
| class="navbar-item "> |
| Replica Server 白名单 |
| </a> |
| |
| <a href="/zh/administration/backup-request" |
| class="navbar-item "> |
| Backup Request |
| </a> |
| |
| <a href="/zh/administration/hotspot-detection" |
| class="navbar-item "> |
| 热点检测 |
| </a> |
| |
| </div> |
| </div> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <nav class="navbar is-hidden-mobile"> |
| <div class="navbar-start w-full"> |
| <div class="navbar-item pl-0 w-full"> |
| <!--TODO(wutao): Given the limitation of docsearch that couldn't handle multiple input, |
| I make searchbox only shown in desktop. Fix this issue when docsearch.js v3 released. |
| Related issue: https://github.com/algolia/docsearch/issues/230--> |
| <div id="docsearch"></div> |
| </div> |
| </div> |
| <div class="navbar-end"> |
| <div class="navbar-item"> |
| |
| |
| <!--A simple language switch button that only supports zh and en.--> |
| <!--IF its language is zh, then switches to en.--> |
| |
| <!--If you don't want a url to be relativized, you can add a space explicitly into the href to |
| prevents a url from being relativized by polyglot.--> |
| <a class="button is-light is-outlined is-inverted" href=" /administration/config"><strong>En</strong></a> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section class="hero is-info lg:mr-3"> |
| <div class="hero-body"> |
| |
| <p class="title is-size-2 is-centered">配置说明</p> |
| </div> |
| </section> |
| <section class="section" style="padding-top: 2rem;"> |
| <div class="content"> |
| <h1 id="获取配置">获取配置</h1> |
| |
| <h2 id="remote-command">Remote command</h2> |
| |
| <p>可以通过 <a href="remote-commands">Remote commands</a> 的 <code class="language-plaintext highlighter-rouge">config-dump</code> 命令获取 Pegasus server 的 <strong>全部</strong> 配置，输出格式为 ini 文件格式，包括 section，key，当前的配置值，以及简要说明。</p> |
| |
| <p>例如，以下输出片段：</p> |
| <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>>>> remote_command -l 127.0.0.1:34601 config-dump |
| COMMAND: config-dump |
| |
| CALL [user-specified] [127.0.0.1:34601] succeed: |
| [apps..default] |
| ; arguments for the app instances |
| arguments = |
| |
| ; delay seconds for when the apps should be started |
| delay_seconds = 0 |
| |
| ; Thread pools needed to be started for this app |
| pools = |
| |
| ; RPC server listening ports needed for this app |
| ports = |
| |
| ; The app type name, as given when registering by dsn::service_app::register_factory<T>("<type>") |
| type = |
| |
| ; Whether to run the app instances or not |
| run = true |
| |
| ; The count of app instances for this type (ports are automatically calculated accordingly to avoid conflict, i.e., ports, ports+1, ports+2, ...) |
| count = 1 |
| </code></pre></div></div> |
| |
| <h2 id="http-api">HTTP API</h2> |
| |
| <p>可以通过 <a href="/zh/api/http">HTTP接口</a> 的 <code class="language-plaintext highlighter-rouge">/config</code> 或 <code class="language-plaintext highlighter-rouge">/configs</code> 路径获取 Pegasus server 的 <strong>部分</strong> 配置，输出格式为 JSON 格式，包括 section，key，当前的配置值，值类型，tags（例如是否可以动态修改），以及简要说明。</p> |
| |
| <blockquote> |
| <p>只有通过 <code class="language-plaintext highlighter-rouge">DSN_DEFINE_xxx</code> 方式注册的配置，才可以通过 HTTP 接口获取。</p> |
| </blockquote> |
| |
| <p>例如，如下输出片段：</p> |
| <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ curl 127.0.0.1:34601/config?name=update_ranger_policy_interval_sec |
| { |
| "name": "update_ranger_policy_interval_sec", |
| "section": "security", |
| "type": "FV_UINT32", |
| "tags": "", |
| "description": "The interval seconds of meta server to pull the latest access control policy from Ranger service.", |
| "value": "5" |
| } |
| $ curl 127.0.0.1:34601/configs |
| { |
| "abnormal_write_trace_latency_threshold": { |
| "name": "abnormal_write_trace_latency_threshold", |
| "section": "replication", |
| "type": "FV_UINT64", |
| "tags": "flag_tag::FT_MUTABLE", |
| "description": "Latency trace will be logged when exceed the write latency threshold, in nanoseconds", |
| "value": "1000000000" |
| }, |
| "add_secondary_enable_flow_control": { |
| "name": "add_secondary_enable_flow_control", |
| "section": "meta_server", |
| "type": "FV_BOOL", |
| "tags": "", |
| "description": "enable flow control for add secondary proposal", |
| "value": "false" |
| }, |
| "add_secondary_max_count_for_one_node": { |
| "name": "add_secondary_max_count_for_one_node", |
| "section": "meta_server", |
| "type": "FV_INT32", |
| "tags": "", |
| "description": "add secondary max count for one node when flow control enabled", |
| "value": "10" |
| } |
| ... |
| } |
| </code></pre></div></div> |
| |
| <h1 id="修改配置">修改配置</h1> |
| |
| <h2 id="配置文件">配置文件</h2> |
| |
| <p>通过修改 ini 配置文件的方式，需要重启 server 生效。</p> |
| |
| <h2 id="http-api-1">HTTP API</h2> |
| |
| <p>可以通过 <a href="/zh/api/http">HTTP接口</a> 的 <code class="language-plaintext highlighter-rouge">/updateConfig</code> 路径动态修改 Pegasus server 的 <strong>部分</strong> 配置。只有 tag 包含 <code class="language-plaintext highlighter-rouge">flag_tag::FT_MUTABLE</code> 的配置项才可以动态修改。</p> |
| |
| <blockquote> |
| <p>通过 HTTP 接口修改的配置不会被持久化到 ini 文件中，这意味着配置项会被重置为默认值（如果 ini 文件中已指定该配置项，则会重置为该配置值）。</p> |
| </blockquote> |
| |
| <p>例如：</p> |
| <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ curl 127.0.0.1:34601/updateConfig?abnormal_write_trace_latency_threshold=2000000000 |
| {"update_status":"ERR_OK"} |
| </code></pre></div></div> |
| |
| <h1 id="配置组成部分">配置组成部分</h1> |
| |
| <p>Pegasus 的配置为 ini 格式，主要有以下 section：</p> |
| |
| <h2 id="appsdefault">[apps..default]</h2> |
| |
| <p>各个 app 相关配置的默认模板。如果具体的 <code class="language-plaintext highlighter-rouge">apps.XXX</code> section 中未显式指定某个配置型，则使用该 section 中的配置。</p> |
| |
| <h2 id="appsmeta">[apps.meta]</h2> |
| |
| <p><code class="language-plaintext highlighter-rouge">meta</code> app 的相关配置。</p> |
| |
| <h2 id="meta_server">[meta_server]</h2> |
| |
| <p>Pegasus Meta Server 的配置。</p> |
| |
| <h2 id="appsreplica">[apps.replica]</h2> |
| |
| <p><code class="language-plaintext highlighter-rouge">replica</code> app 的相关配置，也即 Pegasus Replica Server 的配置。</p> |
| |
| <h2 id="appscollector">[apps.collector]</h2> |
| |
| <p>Pegasus Collector 的配置（2.6 版本开始已废弃）。</p> |
| |
| <h2 id="core">[core]</h2> |
| |
| <p>Pegasus server 内核引擎相关参数配置。</p> |
| |
| <h2 id="network">[network]</h2> |
| |
| <p>网络相关配置参数。</p> |
| |
| <h2 id="threadpooldefault">[threadpool..default]</h2> |
| |
| <p>线程池相关配置的默认模板。如果具体的 <code class="language-plaintext highlighter-rouge">THREAD_POOL_XXX</code> section 中未显式指定某个配置型，则使用该 section 中的配置。</p> |
| |
| <h2 id="threadpoolthread_pool_xxx">[threadpool.THREAD_POOL_XXX]</h2> |
| |
| <p>线程池 <code class="language-plaintext highlighter-rouge">THREAD_POOL_XXX</code> 的配置。</p> |
| |
| <h2 id="meta_serverapps">[meta_server.apps.<app_unique_string>]</app_unique_string></h2> |
| |
| <p>启动集群时，预先在集群中创建的表。根据 <code class="language-plaintext highlighter-rouge"><app_unique_string></code> 的不同，可以创建多个表。</p> |
| |
| <h2 id="replicationapp">[replication.app]</h2> |
| |
| <p>同上，但只能指定 1 个表。</p> |
| |
| <h2 id="replication">[replication]</h2> |
| |
| <p>一致性协议相关配置，很多概念和 PacificA 相关。</p> |
| |
| <h2 id="pegasusserver">[pegasus.server]</h2> |
| |
| <p>Pegasus Replica Server 相关配置。</p> |
| |
| <h2 id="taskdefault">[task..default]</h2> |
| |
| <p>各个 task 相关配置的默认模板。如果具体的 <code class="language-plaintext highlighter-rouge">task.XXX</code> 配置中未显式指定某个配置型，则使用该 section 中的配置。 |
| <code class="language-plaintext highlighter-rouge">task</code> 是 rDSN 中的一个概念，可以理解成 “异步任务”。比如一个 RPC 异步调用、一个异步文件 IO 操作、一个超时事件等，都是一个 task。 |
| 每种 task 都有定义一个唯一的名字。针对每种 task，都可以配置其相关的行为，例如 <code class="language-plaintext highlighter-rouge">trace</code>、<code class="language-plaintext highlighter-rouge">profiler</code> 等。</p> |
| |
| <h2 id="taskrpc_xxx">[task.RPC_XXX]</h2> |
| |
| <p>Task <code class="language-plaintext highlighter-rouge">RPC_XXX</code> 的配置。</p> |
| |
| <h2 id="zookeeper">[zookeeper]</h2> |
| |
| <p>Zookeeper 相关配置。</p> |
| |
| <h2 id="toolssimple_logger">[tools.simple_logger]</h2> |
| |
| <p>Simple logger 实现类，该 logger 会打印日志到文件。</p> |
| |
| <h1 id="配置建议">配置建议</h1> |
| |
| <ul> |
| <li>配置中所有需要使用服务器地址的地方，都建议使用 IP 地址。</li> |
| <li>大部分配置项，建议使用默认值。</li> |
| <li>在理解配置项的作用和影响的前提下，可以根据需要自行更改配置值。</li> |
| <li>对于配置项的进一步了解，可以查看源代码。</li> |
| </ul> |
| |
| </div> |
| </section> |
| <footer class="footer"> |
| <div class="container"> |
| <div class="content is-small has-text-centered"> |
| <div style="margin-bottom: 20px;"> |
| <a href="http://incubator.apache.org"> |
| <img src="/assets/images/egg-logo.png" |
| width="15%" |
| alt="Apache Incubator"/> |
| </a> |
| </div> |
| Copyright © 2023 <a href="http://www.apache.org">The Apache Software Foundation</a>. |
| Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version |
| 2.0</a>. |
| <br><br> |
| |
| Apache Pegasus is an effort undergoing incubation at The Apache Software Foundation (ASF), |
| sponsored by the Apache Incubator. Incubation is required of all newly accepted projects |
| until a further review indicates that the infrastructure, communications, and decision making process |
| have stabilized in a manner consistent with other successful ASF projects. While incubation status is |
| not necessarily a reflection of the completeness or stability of the code, it does indicate that the |
| project has yet to be fully endorsed by the ASF. |
| |
| <br><br> |
| Apache Pegasus, Pegasus, Apache, the Apache feather logo, and the Apache Pegasus project logo are either |
| registered trademarks or trademarks of The Apache Software Foundation in the United States and other |
| countries. |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <!-- right panel --> |
| <div class="dashboard-panel is-small is-scrollable is-hidden-mobile"> |
| <p class="menu-label"> |
| <span class="icon"> |
| <i class="fa fa-bars" aria-hidden="true"></i> |
| </span> |
| 本页导航 |
| </p> |
| <ul class="menu-list"> |
| <li><a href="#获取配置">获取配置</a> |
| <ul> |
| <li><a href="#remote-command">Remote command</a></li> |
| <li><a href="#http-api">HTTP API</a></li> |
| </ul> |
| </li> |
| <li><a href="#修改配置">修改配置</a> |
| <ul> |
| <li><a href="#配置文件">配置文件</a></li> |
| <li><a href="#http-api-1">HTTP API</a></li> |
| </ul> |
| </li> |
| <li><a href="#配置组成部分">配置组成部分</a> |
| <ul> |
| <li><a href="#appsdefault">[apps..default]</a></li> |
| <li><a href="#appsmeta">[apps.meta]</a></li> |
| <li><a href="#meta_server">[meta_server]</a></li> |
| <li><a href="#appsreplica">[apps.replica]</a></li> |
| <li><a href="#appscollector">[apps.collector]</a></li> |
| <li><a href="#core">[core]</a></li> |
| <li><a href="#network">[network]</a></li> |
| <li><a href="#threadpooldefault">[threadpool..default]</a></li> |
| <li><a href="#threadpoolthread_pool_xxx">[threadpool.THREAD_POOL_XXX]</a></li> |
| <li><a href="#meta_serverapps">[meta_server.apps.]</a></li> |
| <li><a href="#replicationapp">[replication.app]</a></li> |
| <li><a href="#replication">[replication]</a></li> |
| <li><a href="#pegasusserver">[pegasus.server]</a></li> |
| <li><a href="#taskdefault">[task..default]</a></li> |
| <li><a href="#taskrpc_xxx">[task.RPC_XXX]</a></li> |
| <li><a href="#zookeeper">[zookeeper]</a></li> |
| <li><a href="#toolssimple_logger">[tools.simple_logger]</a></li> |
| </ul> |
| </li> |
| <li><a href="#配置建议">配置建议</a></li> |
| </ul> |
| |
| </div> |
| </div> |
| |
| <script src="/assets/js/app.js" type="text/javascript"></script> |
| <script> |
| docsearch({ |
| container: '#docsearch', |
| appId: 'QRN30RBW0S', |
| indexName: 'pegasus-apache', |
| apiKey: 'd3a3252fa344359766707a106c4ed88f', |
| debug: true |
| }); |
| </script> |
| |
| </body> |
| |
| </html> |
