From b1e58ebe640fc9cad0e4fcb8a79e391f9563504c Mon Sep 17 00:00:00 2001 From: Ahoo Wang Date: Thu, 11 Aug 2022 23:16:56 +0800 Subject: [PATCH] fix https://github.com/Ahoo-Wang/CosId/issues/135 --- .../docs/.vuepress/config/sidebar/shared.ts | 1 + document/docs/config/machine.md | 62 +++++++++++++++++++ document/docs/config/snowflake.md | 58 ----------------- 3 files changed, 63 insertions(+), 58 deletions(-) create mode 100644 document/docs/config/machine.md diff --git a/document/docs/.vuepress/config/sidebar/shared.ts b/document/docs/.vuepress/config/sidebar/shared.ts index e0ea3a7a84..a66a56a549 100644 --- a/document/docs/.vuepress/config/sidebar/shared.ts +++ b/document/docs/.vuepress/config/sidebar/shared.ts @@ -75,6 +75,7 @@ export function getConfigSidebar(groupA): SidebarConfigArray { collapsable: false, children: [ '', + 'machine', 'snowflake', 'segment', 'zookeeper', diff --git a/document/docs/config/machine.md b/document/docs/config/machine.md new file mode 100644 index 0000000000..e829fe8e1c --- /dev/null +++ b/document/docs/config/machine.md @@ -0,0 +1,62 @@ +# Machine 配置 + +> `me.ahoo.cosid.spring.boot.starter.machine.MachineProperties` + +| 名称 | 数据类型 | 说明 | 默认值 | +|-----------------|------------------|----------------------|-----------| +| stable | `boolean` | 是否为稳定的实例,稳定实例将不回收机器号 | `false` | +| port | `Integer` | 端口号 | 进程ID（PID） | +| instanceId | `String` | 应用实例编号(全局唯一) | 应用IP:PID | +| machineBit | `int` | 机器位数 | `10` | +| stateStorage | `StateStorage` | 机器状态存储 | | +| distributor | `Distributor` | 机器号分发器 | | +| guarder | `Guarder` | 机器号(心跳)守护 | | +| clock-backwards | `ClockBackwards` | 时钟回拨配置 | | + +### StateStorage + +| 名称 | 数据类型 | 说明 | 默认值 | +|---------|----------------------|------------|--------| +| enabled | `boolean` | 是否启用状态存储 | `true` | +| local | `StateStorage.Local` | 本地机器状态存储配置 | | + +#### StateStorage.Local + +| 名称 | 数据类型 | 说明 | 默认值 | +|----------------|----------|--------|--------------------------| +| state-location | `String` | 状态存储位置 | `./cosid-machine-state/` | + +### Distributor + +| 名称 | 数据类型 | 说明 | 默认值 | +|--------|----------------------|-------------------------------------------------------------|----------| +| type | `Distributor.Type` | 机器号分配器类型：`MANUAL`/`STATEFUL_SET`/`JDBC`/`REDIS`/`ZOOKEEPER` | `MANUAL` | +| manual | `Distributor.Manual` | 手动分配器配置 | | + +#### Distributor.Manual + +| 名称 | 数据类型 | 说明 | 默认值 | +|-----------|-----------|-----|--------| +| machineId | `Integer` | 机器号 | `null` | + +## ClockBackwards + +> `me.ahoo.cosid.spring.boot.starter.machine.MachineProperties.ClockBackwards` + +| 名称 | 数据类型 | 说明 | 默认值 | +|------------------|-------|----------------------------------------------|--------| +| spin-threshold | `int` | 自旋同步阈值（ms） | `10` | +| broken-threshold | `int` | 抛出异常（`ClockTooManyBackwardsException`）阈值（ms） | `2000` | + +**YAML 配置样例** + +```yaml +cosid: + namespace: ${spring.application.name} + machine: + enabled: true + distributor: + type: jdbc + guarder: + enabled: true +``` diff --git a/document/docs/config/snowflake.md b/document/docs/config/snowflake.md index d8fe9ec6c6..b50cdbfdf3 100644 --- a/document/docs/config/snowflake.md +++ b/document/docs/config/snowflake.md @@ -7,59 +7,10 @@ | enabled | `boolean` | 是否启用 | `false` | | zone-id | `String` | 时区 | `ZoneId.systemDefault().getId()` | | epoch | `long` | EPOCH | `CosId.COSID_EPOCH`
(UTC 2019-12-24 16:00) | -| clock-backwards | `ClockBackwards` | 时钟回拨配置 | | | machine | `Machine` | 机器号分配器配置 | | | share | `IdDefinition` | 共享ID生成器配置 | 有 | | provider | `Map` | 多ID生成器配置 | `null` | -## ClockBackwards - -> `me.ahoo.cosid.spring.boot.starter.snowflake.SnowflakeIdProperties.ClockBackwards` - -| 名称 | 数据类型 | 说明 | 默认值 | -|------------------|-------|----------------------------------------------|--------| -| spin-threshold | `int` | 自旋同步阈值（ms） | `10` | -| broken-threshold | `int` | 抛出异常（`ClockTooManyBackwardsException`）阈值（ms） | `2000` | - -## Machine - -> `me.ahoo.cosid.spring.boot.starter.snowflake.SnowflakeIdProperties.Machine` - -| 名称 | 数据类型 | 说明 | 默认值 | -|--------------|------------------------|----------------------|-----------| -| stable | `boolean` | 是否为稳定的实例,稳定实例将不回收机器号 | `false` | -| port | `Integer` | 端口号 | 进程ID（PID） | -| instanceId | `String` | 应用实例编号(全局唯一) | 应用IP:PID | -| machineBit | `int` | 机器位数 | `10` | -| stateStorage | `Machine.StateStorage` | 机器状态存储 | | -| distributor | `Machine.Distributor` | 机器号分发器 | | - -### Machine.StateStorage - -| 名称 | 数据类型 | 说明 | 默认值 | -|---------|------------------------------|------------|--------| -| enabled | `boolean` | 是否启用状态存储 | `true` | -| local | `Machine.StateStorage.Local` | 本地机器状态存储配置 | | - -#### Machine.StateStorage.Local - -| 名称 | 数据类型 | 说明 | 默认值 | -|----------------|----------|--------|--------------------------| -| state-location | `String` | 状态存储位置 | `./cosid-machine-state/` | - -### Machine.Distributor - -| 名称 | 数据类型 | 说明 | 默认值 | -|--------|------------------------------|-------------------------------------------------------------|----------| -| type | `Machine.Distributor.Type` | 机器号分配器类型：`MANUAL`/`STATEFUL_SET`/`JDBC`/`REDIS`/`ZOOKEEPER` | `MANUAL` | -| manual | `Machine.Distributor.Manual` | 手动分配器配置 | | - -#### Machine.Distributor.Manual - -| 名称 | 数据类型 | 说明 | 默认值 | -|-----------|-----------|-----|--------| -| machineId | `Integer` | 机器号 | `null` | - ## IdDefinition > `me.ahoo.cosid.spring.boot.starter.snowflake.SnowflakeIdProperties.IdDefinition` @@ -84,15 +35,6 @@ cosid: enabled: true zone-id: Asia/Shanghai epoch: 1577203200000 - clock-backwards: - spin-threshold: 10 - broken-threshold: 2000 - machine: - distributor: - type: redis - state-storage: - local: - state-location: ./cosid-machine-state/ share: clock-sync: true friendly: true