> For the complete documentation index, see [llms.txt](https://docs.edgegap.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.edgegap.com/zh/learn/bian-pai/deployments.md).

# 部署

了解 Edgegap 的部署生命周期：游戏服务器实例如何启动、运行、扩展和停止，以及管理它们的最佳实践。

了解部署及其生命周期——更深入理解的概念和最佳实践。

## 🗺️ 编排

使用我们的云原生边缘计算方法，在几秒内启动新服务器以满足容量需求。我们将服务器视为 [牲畜，而不是宠物](https://cloudscaling.com/blog/cloud-computing/the-history-of-pets-vs-cattle/) - 直接替换故障实例，而不是逐个手动照料。

{% hint style="info" %}
你的编排选择将 **影响你的 DevOps 成本、服务器成本和可扩展性**.
{% endhint %}

{% hint style="success" %}
[在 Discord 上联系我们](https://discord.gg/MmJf8fWjnt) ，了解混合编排选项并优化你的托管成本。
{% endhint %}

为了全面了解所有优缺点，让我们比较各种编排方法。根据游戏循环设计，有些游戏会使用多种编排方式。

### 按对局绑定

短生命周期（限时）服务器会在对局结束时缩减，提供 **最佳性价比**.

会话通常通过以下方式自动化： [匹配系统](https://docs.edgegap.com/zh/unity/matchmaking.md) 服务，它会按需使用严格规则部署服务器，并可选地让正在进行中的服务器接纳 [提升匹配填充率](https://edgegap.com/blog/how-session-fill-rate-affects-your-multiplayer-hosting-costs).

👍 **优点**

* 最佳成本效率——实时扩缩以按分钟满足玩家需求。
* 由于无区域托管，DevOps 成本最低，Edgegap 自动化处理 99% 的任务。
* 由于 Edgegap 公有云基础设施拥有 615+ 个站点，延迟最低。
* 在突发流量激增时，扩容最快（爆发能力最强）。
* 最高标准的安全性和玩家作弊防护（服务器权威）。
* 服务器意外崩溃对玩家影响最小，只影响单场对局。

👎 **缺点**

* 采用新的编排思维模型，起初需要一些上手投入。
* 运行超过 24 小时的服务器将被自动终止。

🧩 **最适合**

* 对延迟敏感的游戏—— **当网络代码优化无法克服高延迟时：**
  * 第一人称射击、格斗游戏、VR 与 XR（虚拟现实和扩展现实），……
* 具有 **设计上对局时长上限**,
  * 大逃杀、 PvPvE[^1]、合作射击、MOBA、体育游戏、ARPG 和地牢爬行类，……

{% hint style="info" %}
Edgegap 会根据各区域玩家活动自动对全部 615+ 个服务器位置进行扩/缩容。做好成功准备——无缝 [在 60 分钟内扩展到 1400 万并发用户](https://edgegap.com/resources/performance-benchmark).
{% endhint %}

### 区域待命

持久世界和社交 MMO 游戏 **服务器寿命通常超过单个玩家会话**.

会话通常通过以下方式分配： [服务器浏览器](https://docs.edgegap.com/zh/learn/fu-wu-qi-liu-lan-qi.md) 基于玩家偏好（按区域自动或自定义搜索），并根据区域容量进行横向部署预扩容。

👍 **优点**

* 对于久经沙场的老玩家来说，这是熟悉且易于理解的老派方法。
* 最高标准的安全性和玩家作弊防护（服务器权威）。
* 基于月度承诺，成本容易预测。

👎 **缺点**

* 托管成本更高——每个区域都需要一个或多个空闲待命服务器（突发容量）。
* DevOps 成本更高——每个区域都要复制扩容、运维和维护。
* 玩家基数较小的区域由于连接到远处服务器而延迟较高。

🧩 **最适合**

* 持久世界，即使玩家离线，用户生成内容也会存储在服务器上。
  * MMO、带基地建设或物体放置的沙盒、撤离射击游戏，……
* 对延迟容忍的游戏—— **当不需要服务器权威的实时物理时**:
  * 手机游戏、合作游戏、TCG/CCG、回合制策略，……
* 异步多人游戏， **服务器崩溃对玩家体验影响最小：**
  * 与幽灵竞速、突袭敌方基地、基于计时器的建造/农场游戏，……
* 启动流程繁重的应用程序——准备服务器需要几分钟。

### 点对点

将开发重点从 ~~专用服务器~~ 转向 **用于非竞技游戏的中继网络代码**.

相关主题：监听服务器、玩家主机权威、NAT 穿透。

👍 **优点**

* 最低托管成本，只需中继服务器来解决 NAT 穿透。
* 最低 DevOps 成本——只需维护客户端构建和分发渠道。
* 服务器意外崩溃对玩家影响最小，只影响单场对局。
* 易于实现，原型制作速度快，无需任何后端开发。

👎 **缺点**

* 需要并发编程技能，点对点网络代码开发工作量增加。
* 延迟最差，并且对不利网络条件（如移动互联网）最为敏感。
* 安全性最弱，易受中间人攻击和会话劫持。
* 如果你不实现自定义主机迁移，主机离开时有丢失会话的风险。

🧩 **最适合**

* 合作与休闲游戏—— **当作弊不会破坏乐趣或毁掉游戏时**,
  * 儿童游戏、探索游戏、冒险，……

{% hint style="success" %}
查看我们的 [分布式中继](https://docs.edgegap.com/docs/distributed-relay-manager) 用于让点对点具备一流延迟和安全性的服务。
{% endhint %}

## 📍 服务器放置

无论你选择哪种编排方式，为一组玩家选择合适的服务器位置都对确保尽可能低的延迟和最佳玩家体验至关重要。了解不同的服务器放置策略，以及它们如何影响你的玩家。

{% hint style="info" %}
你的服务器放置策略将 **影响玩家体验、留存以及你的游戏评价**.
{% endhint %}

{% hint style="success" %}
**Edgegap 部署在** [**最佳可能位置**](#server-score) **，在有可用容量的情况下**，用于快速且低延迟的对局。
{% endhint %}

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2FjiPRa6gGEku2oGm3qW5s%2Fimage.png?alt=media&amp;token=306897d4-8ab1-4766-bc90-5d02882b573c" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
查看 [#deployment-balance-points](#deployment-balance-points "mention") 转向 **实时分析服务器放置**，在大规模下。
{% endhint %}

### 服务器评分

服务器评分策略使用 Edgegap 申请专利的方法，该方法 **为每场对局单独优化服务器放置**。执行非侵入式遥测，以估算每位玩家与我们服务器位置的网络距离，并选择能提供最佳以下效果的服务器：

* **响应性** - 为所有玩家平均提供最低延迟，
* **公平性** - 为所有玩家提供平衡且公平的延迟。

{% hint style="success" %}
我们的 [匹配器](https://docs.edgegap.com/zh/learn/pi-pei-xi-tong.md) 使用 **服务器评分策略，以确保尽可能好的体验**。要在以下场景中使用此策略： [部署 API](https://docs.edgegap.com/api/#tag/Deployments)，请在部署请求中输入玩家的公网 IP 或地理坐标。
{% endhint %}

**响应性差的放置** - 服务器距离太远，所有玩家延迟都很高：

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2FNszxk3uRY78L7V6nLPlp%2Fimage.png?alt=media&amp;token=904b9b3d-7499-45d3-81c6-cc2b5cb6dd32" alt=""><figcaption></figcaption></figure>

**不公平的放置** - 延迟不均衡，一名玩家因更高延迟而处于劣势：

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2FxjsD6ijYWHljBAVuV57w%2Fimage.png?alt=media&amp;token=ab477e89-4afe-4203-9b7f-b85b035dc9eb" alt=""><figcaption></figcaption></figure>

**良好的放置示例** - 所有玩家都具有响应迅速且公平的延迟：

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2FQfSd4uo9twyxEWCkPLqu%2Fimage.png?alt=media&amp;token=8d3cd64b-9527-48fe-886b-96393c15449d" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
这种策略 **尤其适合托管彼此相距较远的一组玩家** （北美对南美，或西海岸对东海岸），这是玩家基数较小时的常见情况。
{% endhint %}

### 地理位置

或者， **提供所需服务器位置的纬度和经度坐标：**

⭐ **推荐：** 找到最快的延迟信标并发送其坐标，或在用户字段中发送 IP。

⚙️ **自定义**：在你的游戏后端中定义区域（含坐标），通过自定义 API 获取。

👉 **最适合测试：** 在游戏客户端开发版中硬编码定义区域（含坐标）。

{% hint style="warning" %}
不建议将此策略用于 [#match-bound](#match-bound "mention") 编排，除非应用程序对区域间数据传输有严格的监管要求，或者玩家 IP 不可用。
{% endhint %}

{% hint style="success" %}
或者，让玩家 **从列表中选择一个持久的（始终在线）服务器** 带有 [服务器浏览器](https://docs.edgegap.com/zh/learn/fu-wu-qi-liu-lan-qi.md).
{% endhint %}

### 区域锁定

一些工作室更喜欢锁定稳定且可预测的位置（例如带有 [持久化](https://docs.edgegap.com/zh/learn/bian-pai/chi-jiu-hua.md)）。考虑 [服务器浏览器](https://docs.edgegap.com/zh/learn/fu-wu-qi-liu-lan-qi.md) 与 [区域扩缩策略](https://docs.edgegap.com/zh/learn/fu-wu-qi-liu-lan-qi.md#automated-scaling) 和 [自动分配预留](https://docs.edgegap.com/zh/learn/fu-wu-qi-liu-lan-qi.md#auto-assigned-reservation).

{% hint style="warning" %}
不建议将此策略用于 [#match-bound](#match-bound "mention") 编排，除非应用程序对区域间数据传输有严格的监管要求，或者玩家 IP 不可用。
{% endhint %}

## 🟢 连接质量

有些游戏（以及玩家）对延迟或卡顿比其他游戏更敏感。虽然玩家报告在大规模下是判断事件或回归 bug 的绝佳指标， **玩家可能并不深入理解网络概念** 并且很快就会将责任归咎于工作室、网络代码或服务器。

某些问题的根因可能对玩家隐藏，因此工作室与托管提供商的合作可能至关重要。 **Edgegap 的首要任务始终是提供尽可能好的服务。**

如果你收到大量玩家报告、遇到广泛性中断，或反复出现问题，请立即通过我们平台中的支持工单联系我们。

{% hint style="info" %}
如果你需要帮助， [请通过 Discord 联系我们](https://discord.gg/MmJf8fWjnt)。关于实时游戏支持，请查看我们的 [工单系统](https://edgegap.atlassian.net/servicedesk/customer/portal/3).
{% endhint %}

#### 低延迟

玩家延迟是传输数据时以下各项之间延迟的总和：

* **物理设备——** 跨越的物理信号 [互联网网络拓扑](https://en.wikipedia.org/wiki/Internet#Routing).
* **主机到主机** - 由协议、传输和安全措施导致。
* **进程到进程** - 由客户端/服务器中的（解）封装和数据处理导致。

Edgegap 通过将服务器放置得更靠近你的玩家来减少物理延迟，从而获得更短的响应和更少的网络跳数。凭借覆盖 17 家云和裸金属提供商的位置，你可以获得 **世界各地玩家的一流延迟**.

服务器和全球互联网覆盖（不仅限于 Edgegap）受以下因素限制：

* **基础设施可用性** - 某个地区的互联网连接质量可能不足。
* **自然因素** - 服务器包含敏感组件，需要稳定性（无地震）。

#### 高可用性

全球各地服务器可用性会随时间变化，一天之中会多次变动。Edgegap 会自动 **扩/缩容** 位置 **按需**，考虑：

* **突发流量** - 在 15 分钟内完成的部署会影响扩容趋势。
* **资源需求** - 每个位置的总 vCPU 需求会影响扩容节奏。
* **提供商替代方案** - 某些偏远地区可用的提供商选项较少。
* **提供商容量** - 某些位置可能只提供 4 vCPU 或 8 vCPU 的机器。
* **服务质量** - 某些提供商在同一区域的不同 ISP 上提供更好的网络质量。
* **工作室日程** - 用于测试和 QA、封闭测试或锦标赛的特殊请求。

所有应用程序的部署请求会合并，以评估每个位置的需求。默认情况下，所有组织享有相同的分配优先级。 **工作室可以选择添加自定义** [私有舰队](https://docs.edgegap.com/zh/learn/bian-pai/si-you-jian-dui.md).

{% hint style="success" %}
请 **联系我们以规划发布**，或如果你对位置可用性有任何要求。
{% endhint %}

#### 玩家问题解决

玩家问题有时可能由服务器或托管 bug 引起，但它们往往无关——也要考虑网线/Wi‑Fi 连接、互联网服务提供商、后端服务，或客户端/服务器底层库中的 bug。

排查玩家报告或事件时，请考虑以下因素：

* **匹配质量** - 尽可能优化为同区域对局：
  * [匹配系统](https://docs.edgegap.com/zh/learn/pi-pei-xi-tong.md) 和 [Ping 信标](https://docs.edgegap.com/zh/learn/bian-pai/ping-beacons.md) 对于我们的建议，
  * [深入了解](https://docs.edgegap.com/zh/learn/pi-pei-xi-tong/matchmaker-in-depth.md#player-tracing) 以查找与玩家报告相关的服务器日志。
* **区域网络和 ISP 问题：**
  * 本地互联网服务提供商（ISP）可能正在暂时处理某个事件，
  * 某些地区（如中国、俄罗斯）可能因本地制裁而受到限制。
* **缓存级别** - 如果没有缓存，你的会话可能会因部署较慢而超时：
  * [启用缓存，以便在几秒内部署你的服务器](https://docs.edgegap.com/zh/learn/bian-pai/application-and-versions.md#other-parameters-optional).
* **最大部署耗时** - 由于初始化过程缓慢且繁重，部署可能会失败：
  * 查看 [应用与版本](https://docs.edgegap.com/zh/learn/bian-pai/application-and-versions.md#safety-guardrails) 以延长超时周期。
* **服务器镜像或集成问题** 在自定义构建流水线的早期迭代中。

{% hint style="success" %}
**在客户端对局历史 UI 中显示部署 ID** 以便在排查时追踪玩家报告。
{% endhint %}

{% hint style="info" %}
通知用户广泛性 bug、临时问题和服务中断，以减轻负面情绪。
{% endhint %}

## 🔄 部署生命周期

Edgegap 部署会经历若干生命周期阶段，以部署状态表示。

#### 1. 启动部署

用于 **测试目的** 的部署可通过以下方式启动：

* [Unreal Engine](https://docs.edgegap.com/zh/unreal-engine.md) - 用于 Unreal Engine 项目的 Docker 扩展或 EGIK 插件。
* [Unity](https://docs.edgegap.com/zh/unity.md) - 用于 Unity 项目的托管快速入门插件。
* [Godot](https://docs.edgegap.com/zh/godot.md) - 用于 Godot 项目的托管快速入门插件。
* [Dashboard Web UI](https://app.edgegap.com/deployment-management/deployments/list) - 适用于快速服务器测试和迭代的简易网页界面。

在与开发人员或 QA 团队测试新构建时，通常会跳过会话步骤，玩家直接连接到部署，同时对与会话相关的功能进行硬编码或禁用。这使开发迭代更快，并将会话副作用与服务器功能隔离开来。

{% hint style="warning" %}
**手动启动你的部署并粘贴 URL 和端口，无法满足实时游戏的需求。**
{% endhint %}

自动化以下热门游戏流程： [玩家会话](https://docs.edgegap.com/zh/learn/bian-pai/wan-jia-hui-hua.md) 以及服务器扩缩容，可通过以下任一方式：

{% columns %}
{% column width="33.33333333333333%" %}
[匹配系统](https://docs.edgegap.com/zh/learn/pi-pei-xi-tong.md):

* 竞技游戏
* 按需对局
* 技能评级和/或\
  自定义规则
  {% endcolumn %}

{% column width="33.33333333333333%" %}
[服务器浏览器](https://docs.edgegap.com/zh/learn/fu-wu-qi-liu-lan-qi.md):

* 持久型或社交型
* 长时会话
* 自动分配和/或\
  自定义搜索
  {% endcolumn %}

{% column width="33.33333333333333%" %}
自定义后端：

* 迁移线上游戏
* [使用 v2 API 部署](https://docs.edgegap.com/zh/docs/api/zhuan-yong-fu-wu-qi.md)
* [监控 Webhooks](https://docs.edgegap.com/zh/learn/bian-pai/deployments.md#webhooks)
  {% endcolumn %}
  {% endcolumns %}

{% hint style="success" %}
**保存** `request_id`  **（部署 ID）并为部署添加标签** 以便日后识别和排查问题。
{% endhint %}

#### 2. 正在部署

一旦部署启动，我们的系统会迅速连续执行多项步骤：

* 遥测——我们正在衡量从可用数据中心到每位玩家的网络响应性，
* 部署——我们正在预留容量并准备启动你的服务器容器，
* 容器启动——我们正在启动容器、安装依赖并进行初始化，
* 后处理——我们正在添加日志存储、监控，并完成部署。

{% hint style="success" %}
启用 [在您的应用版本中启用缓存](https://docs.edgegap.com/zh/learn/bian-pai/application-and-versions.md#active-caching) 在几秒内部署服务器。
{% endhint %}

{% hint style="warning" %}
**请求过多 429** - 为了确保稳定性并防止意外账单，我们对你的组织实施速率限制， **40 请求/秒**. [联系我们](mailto:info@edgegap.com) 以规划发布、估算上线流量并为成功做好准备。
{% endhint %}

#### 3. 部署就绪

一旦部署就绪，你的引擎仍有工作要做。引擎会引导子系统和框架启动，然后将包括地图在内的资源加载到内存中。这发生在部署变为就绪之后，通常根据你的优化程度最多需要 1 分钟。

{% hint style="success" %}
**尝试多次重新连接玩家**，直到预定义的超时时间结束，然后再退出并启动新的会话。服务器通常要等完全初始化后才会接受新的玩家连接。
{% endhint %}

{% hint style="danger" %}
**服务器崩溃处理取决于您的** [**进程重启策略**](https://docs.edgegap.com/zh/learn/bian-pai/application-and-versions.md#safety-guardrails)**.** [服务器状态可能会丢失](https://docs.edgegap.com/zh/learn/bian-pai/chi-jiu-hua.md#state-management).
{% endhint %}

根据该版本的 [应用与版本](https://docs.edgegap.com/zh/learn/bian-pai/application-and-versions.md#active-caching) 状态，你可能会收到：

🟢 **缓存命中**

已启用缓存。由于复用了此机器上预加载的镜像，部署更快。

🟡 **热启动**

缓存已禁用。由于复用了此前在同一台机器上为先前部署下载的镜像，部署更快。启用缓存，以便在全球范围内始终保持快速部署。

🔴 **缓存未命中**

已启用缓存。由于在缓存传播完成前突然出现流量激增，部署变慢。在你的部署请求中启用“要求已缓存的位置”将可避免这种情况，但在意外流量激增时可能会导致更多不可处理的部署。

🔴 **冷启动**

缓存已禁用。由于在部署时下载了镜像，部署变慢。启用缓存以加快部署。

#### 4. 部署错误

你的部署可能会因意外原因在任何时间点进入不可处理状态。这更可能发生在测试你的集成或测试新的服务器构建时。

**错误状态的部署不收费，这些部署会在 24 小时后自动停止。**

故障排查步骤：

* 通过 [我们的正常运行监控页面](https://status.edgegap.com/).
* 尝试使用 Docker Desktop 在本地测试你的服务器容器，以排除 Edgegap 相关问题。

{% hint style="info" %}
如果你需要帮助， [请通过 Discord 联系我们](https://discord.gg/MmJf8fWjnt)。关于实时游戏支持，请查看我们的 [工单系统](https://edgegap.atlassian.net/servicedesk/customer/portal/3).
{% endhint %}

{% hint style="success" %}
**在寻求帮助时，** **请包含你的部署 ID 和任何有用的细节** 以便我们及时调查！
{% endhint %}

#### 5. 部署已停止

**云部署将在运行 24 小时后终止** ，这是为了遵循我们的服务器清理政策，以便进行基础设施维护，并防止在因意外 bug 导致部署未正确关闭时产生意外费用。

对于运行超过 24 小时的长期服务器，请考虑使用 [私有舰队](https://docs.edgegap.com/zh/learn/bian-pai/si-you-jian-dui.md) 与 [持久化](https://docs.edgegap.com/zh/learn/bian-pai/chi-jiu-hua.md).

使用以下方法优化你的成本并提前停止空闲部署：

* **应用版本** [**重启策略**](https://docs.edgegap.com/zh/learn/bian-pai/application-and-versions.md#safety-guardrails) - 防止在关机或崩溃时自动重启。
* **游戏最大时长** - 你在 [应用与版本](https://docs.edgegap.com/zh/learn/bian-pai/application-and-versions.md#safety-guardrails) 中的分配时间
* **通过以下方式自动停止** [**DELETE\_URL**](https://docs.edgegap.com/zh/learn/bian-pai/deployments.md#injected-environment-variables) - 在玩家离开且对局结束后，部署自行停止。
  * 查看 [Unreal Engine](https://docs.edgegap.com/zh/unreal-engine.md#stop-deployments) 和 [Unity](https://docs.edgegap.com/zh/unity.md#stop-deployments) 用于 SDK 工具和轻松集成的指南，或使用 API。
* **从自定义后端停止** - 你的自定义会话编排可能会使用 [部署 API](https://docs.edgegap.com/api/#tag/Deployments/operation/deployment-delete).
* [私有舰队](https://docs.edgegap.com/zh/learn/bian-pai/si-you-jian-dui.md) 正在运行你的部署的主机通过计划操作被删除。

{% hint style="info" %}
一旦部署停止， **我们会触发优雅终止** 通过发送 `SIGTERM` 信号到你的主进程，允许一个短暂的终止期。一旦到期， `SIGKILL` 信号将被发送以停止部署。
{% endhint %}

## 👀 可观测性

让游戏服务器能够与第三方互操作并获得运营洞察。

{% hint style="info" %}
**担心意外的云成本？** [配置云告警](https://app.edgegap.com/notifications?notification-table-limit=10\&notification-table-page=1#alarms) 在达到自定义计费阈值时接收通知，或者 [联系我们](https://discord.com/invite/NgCnkHbsGp) 了解自动化安全措施。
{% endhint %}

### 可发现性

一旦就绪，部署会被分配一个 URL（[fqdn](https://en.wikipedia.org/wiki/Fully_qualified_domain_name)）以及每个内部端口对应的外部端口。

{% hint style="success" %}
使用 **部署标签（最多 40 个字符）来轻松标记你的部署** ，以便日后查找。
{% endhint %}

{% hint style="info" %}
**来自你的游戏服务器的出站流量（到客户端或后端）从不被阻止** 或过滤。
{% endhint %}

#### **WebSocket（WS）和安全 WebSocket（WSS）**

要在 Edgegap 上使用基于 websocket 的网络代码，你有两个选项：

* **托管证书**，无需编写任何代码即可在 1 分钟内完成设置：
  * 配置你的 [应用与版本](https://docs.edgegap.com/zh/learn/bian-pai/application-and-versions.md) 转向 **使用 WebSocket（WS）并启用 TLS 升级，**
  * 使用 Edgegap URL 连接客户端（例如 `https://5fa53fa00a57.pr.edgegap.net/`)
* **自主管理证书**，如果你想使用自己的自定义域名：
  * 配置你的 [应用与版本](https://docs.edgegap.com/zh/learn/bian-pai/application-and-versions.md) 转向 **使用安全 WebSocket（WSS）**,
  * 使用自定义 DNS 记录配置你自己的 TLS 证书流程（例如在 [Cloudflare](https://www.cloudflare.com/application-services/products/ssl/)).

{% hint style="danger" %}
未捕获的服务器异常将导致部署的容器重启并使 TLS 安全性失效。在这种情况下， [停止你的服务器](#id-5.-deployment-stopped) 和 [将玩家重新匹配到新的部署](https://docs.edgegap.com/zh/learn/pi-pei-xi-tong.md#custom-lobby). [服务器状态可能会丢失](https://docs.edgegap.com/zh/learn/bian-pai/chi-jiu-hua.md#state-management).
{% endhint %}

### 注入变量 <a href="#injected-environment-variables" id="injected-environment-variables"></a>

游戏服务器通常需要额外信息，例如服务器 IP、内部端口值等。注入只读环境变量是一种可靠、与云平台无关的参数传递方式。

{% hint style="success" %}
使用以下方式获取变量值： [Unity SDK](https://docs.edgegap.com/zh/unity/developer-tools.md#software-development-kit), [Unreal EGIK](https://docs.edgegap.com/zh/unreal-engine/developer-tools.md#integration-kit)，或者使用运行时的环境变量方法。
{% endhint %}

{% hint style="info" %}
查看 [应用版本变量](https://docs.edgegap.com/zh/learn/bian-pai/application-and-versions.md#injected-variables) 和 [匹配器变量](https://docs.edgegap.com/zh/learn/pi-pei-xi-tong/matchmaker-in-depth.md#injected-variables) 以及下面的部署变量。
{% endhint %}

#### **自定义变量**

为每个部署定义最多 20 个自定义变量，每个变量最多包含 4KB 的字符串数据。

{% hint style="warning" %}
**请避免使用下面保留的名称，否则你的自定义变量会被覆盖！**
{% endhint %}

通过读取 Edgegap 注入到你的服务器中的变量来访问重要信息：

#### **标识符**

* **`ARBITRIUM_REQUEST_ID`**  例如 `f68e011bfb01` .
  * 唯一的部署 ID，也称为请求 ID。用于检索更多信息。
  * 部署 URL 始终采用以下格式 `{ARBITRIUM_REQUEST_ID}.pr.edgegap.net`.
* **`ARBITRIUM_PUBLIC_IP`**  例如 `162.254.141.66` .
  * 此主机的公网 IP 地址，可用于代替 URL 进行连接。
* **`ARBITRIUM_HOST_ID`**  例如 `alpha-north-america-70364ef8` .
  * 托管你的部署的机器的唯一标识符，与其他部署共享。
* **`ARBITRIUM_DEPLOYMENT_TAGS`**  例如 `tag1,tag2` .
  * 以逗号分隔的用户自定义部署标签， [便于搜索和筛选](#filter-deployments).
* **`ARBITRIUM_PRIVATE_FLEET_ID`** 例如 `PUBLIC_CLOUD` ，如果托管在 [私有舰队](https://docs.edgegap.com/zh/learn/bian-pai/si-you-jian-dui.md).

#### 资源规格

* **`ARBITRIUM_HOST_IN_PRIVATE_FLEET`** 例如 `false` ，表示是否托管在 [私有舰队](https://docs.edgegap.com/zh/learn/bian-pai/si-you-jian-dui.md).
* **`ARBITRIUM_HOST_BASE_CLOCK_FREQUENCY`**  例如 `2300` ，处理器频率，单位 MHz。
* **`ARBITRIUM_DEPLOYMENT_VCPU_UNITS`**  例如 `256`，分配的 vCPU 单元（1024 = 1 vCPU）。
* **`ARBITRIUM_DEPLOYMENT_MEMORY_MB`**  例如 `512`，分配的 RAM，单位 MB（1024 = 1 GB）。

#### **生命周期管理**

* **`ARBITRIUM_DELETE_URL`**  例如 `https://api.edgegap.com/v1/self/stop/9f511e17/660`.
  * 可从部署内部调用， [部署将被优雅停止](#id-5.-deployment-stopped).
  * 需要唯一的一次性 `ARBITRIUM_DELETE_TOKEN` 在 `Authorization` 头中。
* **`ARBITRIUM_DELETE_TOKEN`**  例如 `7df4cd933df87084b34ae80d8abde293`.
* **`ARBITRIUM_CONTEXT_URL`**  例如 `https://api.edgegap.com/v1/context/9170f5211e17/17`.
  * 只能从部署内部调用，会返回更多部署详情。
  * 需要唯一的 `ARBITRIUM_CONTEXT_TOKEN` 在 `Authorization` 头中。
* **`ARBITRIUM_CONTEXT_TOKEN`**  例如 `dfaf50b9333b9ee07b22ed247e4a17e6`.

#### **可发现性**

* **`ARBITRIUM_PORT_GAMEPORT_INTERNAL`**  例如 `7777` ，用于服务器监听的内部端口。
* **`ARBITRIUM_PORT_GAMEPORT_EXTERNAL`**  例如 `31504` ，用于客户端连接的外部端口。
  * 出于安全考虑，每个部署的外部端口值都会随机生成。
* **`ARBITRIUM_PORT_GAMEPORT_PROTOCOL`**  例如 `UDP` ，你的网络代码传输协议。

{% hint style="success" %}
示例假设你已将端口命名为 `gameport` （默认）。 **每个端口都会额外添加一组已清理的** [应用与版本](https://docs.edgegap.com/zh/learn/bian-pai/application-and-versions.md#port-mapping) **变量：** `@超级端口！` ⇒ `ARBITRIUM_PORT_SUPER_PORT_INTERNAL` .
{% endhint %}

* **`ARBITRIUM_BEACON_ENABLED`**  例如 `true`，如果部署在 [私有舰队](https://docs.edgegap.com/zh/learn/bian-pai/si-you-jian-dui.md) 与 [Ping 信标](https://docs.edgegap.com/zh/learn/bian-pai/ping-beacons.md).
* **`ARBITRIUM_HOST_BEACON_PUBLIC_IP`**  例如 `139.177.198.69` ，则为最近信标的公网 IP。
* **`ARBITRIUM_HOST_BEACON_PORT_UDP_EXTERNAL`**  例如 `30199`，用于通过 UDP 测量延迟。
* **`ARBITRIUM_HOST_BEACON_PORT_TCP_EXTERNAL`**  例如 `30456`，用于通过 TCP 测量延迟。

#### **结构化信息（JSON 字符串）**

{% hint style="info" %}
环境变量是 **以字符串化 JSON 的形式存储的**，可使用 SDK 或自定义方法进行解析。
{% endhint %}

<details>

<summary><strong><code>ARBITRIUM_DEPLOYMENT_LOCATION</code></strong></summary>

```json
ARBITRIUM_DEPLOYMENT_LOCATION="{
  "city": "蒙特利尔",
  "country": "加拿大",
  "continent": "北美洲",
  "administrative_division": "魁北克",
  "timezone": "东部时间",
  "latitude": 45.513707,
  "longitude": -73.619073
}"
```

</details>

<details>

<summary><strong><code>ARBITRIUM_PORTS_MAPPING</code></strong></summary>

```json
ARBITRIUM_PORTS_MAPPING="{
  "ports": {
    "gameport": {
      "name": "游戏端口",
      "internal": 7777,
      "external": 31504,
      "protocol": "UDP"
    },
    "webport": {
      "name": "Web 端口",
      "internal": 8888,
      "external": 31553,
      "protocol": "TCP"
    }
  }
}"
```

</details>

### 仪表板监控

我们的 [仪表板](https://app.edgegap.com/) 提供用于监控服务器可扩展性并辅助运维的工具。

#### 分析

{% hint style="success" %}
查找 [侧边栏菜单中的分析仪表板](https://app.edgegap.com/analytics/dashboards/list) 位于“服务器托管与编排”分类下。
{% endhint %}

:star2: [**升级到按需付费套餐**](https://app.edgegap.com/user-settings?tab=memberships) **以解锁详细的服务器性能指标和洞察：**

* **总体洞察：** 监控发布版本的实时服务器数量以及资源使用概览，
* **CPU 洞察**：排查因处理器密集型操作导致的卡顿服务器，
* **内存洞察**：缓解因超过分配内存而导致的服务器重启，
* **网络洞察：** 检测低效的网络模式并优化网络代码。

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2FLxDp1yFvkj5kB6AC4xVb%2Fimage.png?alt=media&amp;token=c0eff5f1-a374-41e0-a49a-9b3ecf0bfd1b" alt=""><figcaption></figcaption></figure>

#### 部署地图

{% hint style="success" %}
在以下位置查找部署地图： [仪表板中的部署详情页面](https://app.edgegap.com/deployment-management/deployments/list).
{% endhint %}

在地图上预览部署位置、可用位置和预估玩家位置：

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2FM4h0itPU5ntPaV5N5ZlW%2Fimage.png?alt=media&amp;token=98028901-9a40-4a2d-969e-db5f990e334f" alt=""><figcaption></figcaption></figure>

#### 部署平衡点

{% hint style="success" %}
在以下位置查找部署平衡点热力图： [仪表板中的应用详情页面](https://app.edgegap.com/application-management/applications/list).
{% endhint %}

预览部署平衡点热力图并按以下条件筛选 [应用与版本](https://docs.edgegap.com/zh/learn/bian-pai/application-and-versions.md)。平衡点是与给定部署中的每位玩家网络距离大致相等的位置：

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2FfDpIQxoFUJZNE77LJIwZ%2Fimage.png?alt=media&amp;token=94e730ad-3907-486b-8a06-0f469acd19ea" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
位于奇怪地点（例如格陵兰）的平衡点热点表明玩家之间相距很远。了解 [#connection-quality](#connection-quality "mention") 和 [Ping 信标](https://docs.edgegap.com/zh/learn/bian-pai/ping-beacons.md) 以优化你的匹配。
{% endhint %}

#### 部署日志

{% hint style="success" %}
在以下位置查找部署日志： [仪表板中的部署详情页面](https://app.edgegap.com/deployment-management/deployments/list).
{% endhint %}

部署日志显示有关以下内容的信息： [#deployment-lifecycle](#deployment-lifecycle "mention"):

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2FfkyAYtylnOFmSp3yyiId%2Fimage.png?alt=media&amp;token=6a4f6ac4-5780-46a7-bcdd-1d8829c4abd7" alt=""><figcaption></figcaption></figure>

#### 容器日志

{% hint style="success" %}
在以下位置查找容器日志： [仪表板中的部署详情页面](https://app.edgegap.com/deployment-management/deployments/list).
{% endhint %}

在出现问题或调试时检查你的游戏服务器日志：

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2Fpzg50T3fCNQ4Q8brGsQ4%2Fimage.png?alt=media&amp;token=f248fe9a-4f34-4f97-b549-cf271332ea3c" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
**部署停止后，容器日志将被删除。** 设置 [第三方 S3 日志存储](https://docs.edgegap.com/zh/docs/endpoint-storage.md) 以保存日志。
{% endhint %}

#### 容器指标

{% hint style="success" %}
在以下位置查找容器指标： [仪表板中的部署详情页面](https://app.edgegap.com/deployment-management/deployments/list).
{% endhint %}

查看容器指标（处理器、内存、网络）以：

* 识别常见连接问题，当 [#troubleshooting](#troubleshooting "mention"),
* 检测导致资源使用激增的低效实现模式，
* 在特定场景下定位低效的资源使用，
* 验证优化过程中服务器资源使用的变化，
* 对服务器初始化的资源消耗和耗时进行基准测试。

历史指标以 1 分钟时间周期显示平均值，可在免费套餐中使用。

:star2: [**升级到按需付费套餐**](https://app.edgegap.com/user-settings?tab=memberships) **以解锁 1 秒时间间隔的精确指标。**

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2FoIpCR3x9ibiXMEIWFgKG%2Fimage.png?alt=media&amp;token=86dcd914-db9f-4e81-8444-6c83805be9b6" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
[联系我们](mailto:info@edgegap.com) 在发布之前请求大规模发布的实时托管支持。
{% endhint %}

### 上下文与状态

可通过 JSON 格式检索额外的部署信息：

* 从部署内部（游戏服务器）使用 [部署上下文 API](https://docs.edgegap.com/api/#tag/Context/operation/context-get),
* 从部署外部（后端 / 第三方）使用 [部署状态 API](https://docs.edgegap.com/api/#tag/Deployments/operation/deployment-status-get).

{% hint style="info" %}
上下文 API（来自部署）需要 Context API 令牌，而状态 API 使用你的 Edgegap 令牌。
{% endhint %}

{% hint style="danger" %}
**请求过多 429 - 上下文和状态 API 的速率限制为每个组织 20 请求/秒。** 这些 API 旨在用于特殊操作期间，而不是用于自动化会话编排。
{% endhint %}

{% hint style="success" %}
**使用** [#webhooks](#webhooks "mention") **用于自定义会话编排，以避免速率限制并确保可扩展性。**
{% endhint %}

### 筛选部署

要在所有部署中快速搜索，你可以 [使用我们的仪表板](https://app.edgegap.com/deployment-management/deployments/list):

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2F42IaKG0pFQXSkvPCRH1T%2Fimage.png?alt=media&amp;token=6aba8781-13c9-4c0f-87e9-2d9612a57342" alt=""><figcaption></figcaption></figure>

{% hint style="success" %}
或者，让玩家 **从列表中选择一个持久的（始终在线）服务器** 带有 [服务器浏览器](https://docs.edgegap.com/zh/learn/fu-wu-qi-liu-lan-qi.md).
{% endhint %}

[使用 API 列出部署](https://docs.edgegap.com/api/#tag/Deployments/operation/deployments-get) 并通过后端集成应用筛选条件：

<table><thead><tr><th width="237">部署属性</th><th width="193">运算符</th><th>示例值</th></tr></thead><tbody><tr><td><a href="https://docs.edgegap.com/zh/learn/bian-pai/deployments.md#deployment-lifecycle"><code>状态</code></a></td><td><a data-footnote-ref href="#user-content-fn-2"><code>eq</code></a>  或 <a data-footnote-ref href="#user-content-fn-3"><code>neq</code></a></td><td><code>"ready"</code> 或 <code>"error"</code></td></tr><tr><td><a href="#observability"><code>request_id</code></a></td><td><a data-footnote-ref href="#user-content-fn-2"><code>eq</code></a> </td><td><a data-footnote-ref href="#user-content-fn-4"><code>"7e709a0d8efd"</code></a></td></tr><tr><td></td><td><a data-footnote-ref href="#user-content-fn-5"><code>在</code></a>  或 <a data-footnote-ref href="#user-content-fn-6"><code>nin</code></a></td><td><a data-footnote-ref href="#user-content-fn-4"><code>[ "7e709a0d8efd", "4ba353100b4b" ]</code></a></td></tr><tr><td><a href="#discoverability"><code>标签</code></a></td><td><a data-footnote-ref href="#user-content-fn-2"><code>eq</code></a>  或 <a data-footnote-ref href="#user-content-fn-3"><code>neq</code></a></td><td><code>"tagA"</code></td></tr><tr><td></td><td><a data-footnote-ref href="#user-content-fn-5"><code>在</code></a>  或 <a data-footnote-ref href="#user-content-fn-6"><code>nin</code></a></td><td><code>[ "tagA", "tagB" ]</code></td></tr><tr><td><a href="#id-1.-start-a-deployment"><code>created_at</code></a></td><td><a data-footnote-ref href="#user-content-fn-2"><code>eq</code></a>  或 <a data-footnote-ref href="#user-content-fn-7"><code>lte</code></a>  或 <a data-footnote-ref href="#user-content-fn-8"><code>gte</code></a></td><td><a href="https://en.wikipedia.org/wiki/ISO_8601"><code>2025-05-12T20:03:20Z</code></a></td></tr><tr><td><a href="https://docs.edgegap.com/zh/learn/bian-pai/application-and-versions.md"><code>application</code></a></td><td><a data-footnote-ref href="#user-content-fn-2"><code>eq</code></a>  或 <a data-footnote-ref href="#user-content-fn-3"><code>neq</code></a></td><td><code>"my-app"</code></td></tr><tr><td></td><td><a data-footnote-ref href="#user-content-fn-5"><code>在</code></a>  或 <a data-footnote-ref href="#user-content-fn-6"><code>nin</code></a></td><td><code>[ "my-app", "my-other-app" ]</code></td></tr><tr><td><a href="https://docs.edgegap.com/zh/learn/bian-pai/application-and-versions.md"><code>version</code></a></td><td><a data-footnote-ref href="#user-content-fn-2"><code>eq</code></a>  或 <a data-footnote-ref href="#user-content-fn-3"><code>neq</code></a></td><td><code>"1.0.0"</code></td></tr><tr><td></td><td><a data-footnote-ref href="#user-content-fn-9"><code>在</code></a>  或 <a data-footnote-ref href="#user-content-fn-6"><code>nin</code></a></td><td><code>[ "1.0.0", "prod" ]</code></td></tr><tr><td><a href="https://docs.edgegap.com/zh/learn/bian-pai/si-you-jian-dui.md"><code>fleet_name</code></a></td><td><a data-footnote-ref href="#user-content-fn-2"><code>eq</code></a>  或 <a data-footnote-ref href="#user-content-fn-3"><code>neq</code></a></td><td><code>"my-app-fleet-europe"</code></td></tr><tr><td></td><td><a data-footnote-ref href="#user-content-fn-5"><code>在</code></a>  或 <a data-footnote-ref href="#user-content-fn-6"><code>nin</code></a></td><td><code>[ "fleet-eu", "fleet-us" ]</code></td></tr><tr><td></td><td><a data-footnote-ref href="#user-content-fn-10"><code>ilike</code></a></td><td><code>"%-eu%"</code></td></tr><tr><td><a href="https://docs.edgegap.com/zh/learn/bian-pai/si-you-jian-dui.md"><code>host_name</code></a></td><td><a data-footnote-ref href="#user-content-fn-2"><code>eq</code></a>  或 <a data-footnote-ref href="#user-content-fn-3"><code>neq</code></a></td><td><code>"alpha-north-america-95fab093"</code></td></tr><tr><td></td><td><a data-footnote-ref href="#user-content-fn-5"><code>在</code></a>  或 <a data-footnote-ref href="#user-content-fn-6"><code>nin</code></a></td><td><code>[ "alpha-north-america-95fab093" ]</code></td></tr><tr><td></td><td><a data-footnote-ref href="#user-content-fn-10"><code>ilike</code></a></td><td><code>"%north-america%"</code></td></tr></tbody></table>

{% hint style="info" %}
每个属性在单个请求中最多只能有 1 个筛选运算符。参见 [API 参考](https://docs.edgegap.com/zh/docs/api.md) 了解更多。
{% endhint %}

按请求中字段出现的顺序对结果进行多字段排序：

| 部署属性                                                                                   | 顺序                                                                     |
| -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| [`created_at`](#id-1.-start-a-deployment)                                              | [`asc`](#user-content-fn-11)[^11] 或 [`desc`](#user-content-fn-12)[^12] |
| [`available_session_sockets`](broken://pages/11ccd578e752c64b01112507ccb14f0f02f0bedf) | [`asc`](#user-content-fn-13)[^13] 或 [`desc`](#user-content-fn-14)[^14] |

示例筛选查询：

<details>

<summary>列出 <a href="#id-4.-deployment-error">出错的部署</a> 以进行排查和移除。</summary>

编码后的 URL：

```
https://api.edgegap.com/v1/deployments?query={"filters":[{"field":"status","operator":"eq","value":"error"},{"field":"application","operator":"eq","value":"my-app"},{"field":"version","operator":"eq","value":"green"}],"order_by":[{"field":"created_at","order":"desc"}]}
```

格式化后的 JSON 查询：

```json
{
  "filters": [
    {
      "field": "status",
      "operator": "eq",
      "value": "error"
    },
    {
      "field": "application",
      "operator": "eq",
      "value": "my-app"
    },
    {
      "field": "version",
      "operator": "eq",
      "value": "green"
    }
  ],
  "order_by": [
    {
      "field": "created_at",
      "order": "desc"
    }
  ]
}
```

</details>

<details>

<summary>列出 <a href="https://docs.edgegap.com/zh/learn/pi-pei-xi-tong/matchmaker-in-depth.md#rolling-updates-and-ab-tests">部署的 App 版本过旧</a> 以确认发布是否完成。</summary>

编码后的 URL：

```
https://api.edgegap.com/v1/deployments?query={"filters":[{"field":"status","operator":"eq","value":"ready"},{"field":"application","operator":"eq","value":"my-app"},{"field":"version","operator":"eq","value":"blue"}],"order_by":[{"field":"created_at","order":"desc"}]}
```

格式化后的 JSON 查询：

```json
{
  "filters": [
    {
      "field": "status",
      "operator": "eq",
      "value": "ready"
    },
    {
      "field": "application",
      "operator": "eq",
      "value": "my-app"
    },
    {
      "field": "version",
      "operator": "eq",
      "value": "blue"
    }
  ],
  "order_by": [
    {
      "field": "created_at",
      "order": "desc"
    }
  ]
}
```

</details>

{% hint style="success" %}
别忘了添加 `Authorization` 请求中的 header，并携带你的 Edgegap API 令牌。
{% endhint %}

### Webhook

在你的游戏后端接收关于以下变更的简单 HTTP 通知： [#deployment-lifecycle](#deployment-lifecycle "mention") 通过在你的 [部署 API 请求中指定 webhook URL](https://docs.edgegap.com/zh/docs/api/zhuan-yong-fu-wu-qi.md#post-deployments)。适用于：

* 就绪时：部署容器 [成功启动](#id-1.-start-a-deployment) （服务器随后开始初始化）。
* 出错时：部署无法启动，并且发生了 [#id-4.-deployment-error](#id-4.-deployment-error "mention") 错误。
* 终止时： [#id-5.-deployment-stopped](#id-5.-deployment-stopped "mention") 且游戏服务器将不再可访问。

同一部署不会同时触发 Ready 和 Error webhook。

<details>

<summary>Webhook 示例负载</summary>

```json
{
  "request_id": "f68e011bfb01",
  "application": "my-game-server",
  "version": "2024.01.30-16.23.00-UTC",
  "fqdn": "f68e011bfb01.pr.edgegap.net",
  "public_ip": "162.254.141.66",
  "deployed_at": "2026-02-10T20:35:48Z",
  "termination_scheduled_at": "2026-02-10T21:35:48Z",
  "ports": {
    "gameport": {
      "external": 31504,
      "internal": 7777,
      "protocol": "UDP",
      "name": "gameport",
      "tls_upgrade": false,
      "link": "f68e011bfb01.pr.edgegap.net:31504",
      "proxy": null
    }
  },
  "location": {
    "city": "蒙特利尔",
    "country": "加拿大",
    "continent": "北美洲",
    "administrative_division": "魁北克",
    "timezone": "东部时间",
    "latitude": 45.513707,
    "longitude": -73.619073
  },
  "tags": [
    "tag1",
    "tag2"
  ],
  "host_id": "alpha-north-america-70364ef8",
  "host_in_private_fleet": false,
  "private_fleet_id": "PUBLIC_CLOUD",
  "vcpu_units": 256,
  "memory_mib": 512
}
```

</details>

{% hint style="success" %}
**Webhook 是自定义后端部署集成的首选推荐方式。**
{% endhint %}

{% hint style="warning" %}
**Webhook 不会重试**，如果由于速率限制或错误导致后端未处理该请求，则可能会丢失。如果在预期时间内未收到 webhook，请改用 Status API。
{% endhint %}

{% hint style="info" %}
Webhook 会监视部署生命周期，但不会感知你的场景/关卡初始化状态。要观察场景/关卡的加载进度，请在游戏服务器中实现自定义 webhook。
{% endhint %}

## 🚨 故障排查

排查部署问题时：

1. 请确认你的 [#deployment-logs](#deployment-logs "mention") 和 [#container-logs](#container-logs "mention"),
2. 在本地运行你的服务器，以排除集成错误，
3. 查看本页上的故障排查步骤，
4. 通过……联系我们 [社区 Discord](https://discord.gg/MmJf8fWjnt) 并附上你的部署 ID。

{% hint style="info" %}
查看 [#player-issue-resolution](#player-issue-resolution "mention") 了解我们关于如何应对玩家社区反馈的建议。
{% endhint %}

<details>

<summary>无法将客户端连接到服务器 - <code>请求超时。</code>, <code>请求超时</code> , <code>连接失败</code> ，或 <code>端口验证失败</code>.</summary>

* 首先，确保部署状态为 Ready，并且你的部署日志中没有运行时异常或错误。如果你的部署已停止，请查看我们中的日志 [仪表板](https://app.edgegap.com/deployment-management/deployments/list).
* 如果你使用的是 Mirror netcode，你需要在你的 [“Auto Start Server”](https://mirror-networking.gitbook.io/docs/hosting/edgegap-hosting-plugin-guide#build-and-push) 中选择 `NetworkManager` ，重新构建、推送并重新部署你的服务器。
* 如果你使用的是 FishNet netcode，你需要启用 [“Start on Headless”](https://fish-networking.gitbook.io/docs/manual/components/managers/server-manager#settings-are-general-settings-related-to-the-servermanager) 在你的 `ServerManager`，重新构建、推送并重新部署你的服务器。
* 如果你使用的是 Photon Fusion 2 netcode，请确保你的服务器传递了部署的公网 IP、外部端口以及 `roomCode` 在服务器上，以及客户端中的相同房间代码，在 [“NeworkRunner.StartGame”](https://doc.photonengine.com/fusion/current/manual/network-runner#creating-or-joining-a-room) 参数 `StartGameArgs`。部署 ID（例如 `b63e6003b19f`）是个很好的选择，因为它具有全局唯一性，并且客户端可以轻松通过 [匹配器](https://docs.edgegap.com/zh/learn/pi-pei-xi-tong/matchmaker-in-depth.md) 分配以及到 [深入了解](https://docs.edgegap.com/zh/learn/pi-pei-xi-tong/matchmaker-in-depth.md#injected-environment-variables).
* 接下来，请确认你服务器构建中的 netcode 设置里的端口设置与你的 [App 版本](https://app.edgegap.com/application-management/applications/list)。你可以通过编辑 [App 版本](https://app.edgegap.com/application-management/applications/list) 而无需重新构建。在你的 netcode 集成中找到你的协议。
* 请确保你的游戏客户端连接到 **外部端口** 部署详情页面上显示的端口；出于安全原因，此值始终会随机化。
* 如果你在 netcode 集成中使用 Secure Websocket（WSS）协议，请确保你的 [App 版本](https://app.edgegap.com/application-management/applications/list) WSS 端口的端口配置已启用 TLS Upgrade。
* 你是否位于中国并正在使用 [Smart Fleets](https://docs.edgegap.com/docs/deployment/session/fleet-manager/fleet)？你的连接可能被防火长城阻止。可以考虑在你的舰队中添加一台位于中国的服务器，或者使用 VPN 连接。

</details>

<details>

<summary>我的部署已停止/重启，我再也无法访问它的日志了。</summary>

* 如果服务器进程因异常崩溃，我们的系统会尝试自动重启服务器。建议在本地测试你的服务器，以找出根本原因。
* 我们只会在部署期间保留日志；如果你希望在部署停止后查看日志，请 [集成第三方日志存储](https://docs.edgegap.com/docs/deployment/endpoint-storage).
* 查看 [#id-5.-deployment-stopped](#id-5.-deployment-stopped "mention") 以找出导致你的部署停止的所有原因。

</details>

<details>

<summary>我的部署在 X 分钟后自动停止了。</summary>

* 免费套餐部署有 60 分钟的时限，请考虑升级你的账户。
* 根据我们的服务器清理策略，为了基础设施维护，并防止在部署未正确关闭时产生意外费用，云端部署在运行 24 小时后将被终止。对于运行超过 24 小时的长时间运行服务器，请考虑使用 [私有舰队](https://docs.edgegap.com/zh/learn/bian-pai/si-you-jian-dui.md) 与 [持久化](https://docs.edgegap.com/zh/learn/bian-pai/chi-jiu-hua.md).
* 查看 [#id-5.-deployment-stopped](#id-5.-deployment-stopped "mention") 以找出导致你的部署停止的所有原因。

</details>

<details>

<summary>我的部署已就绪，但随后几分钟内我仍无法连接。</summary>

* 一旦部署处于 Ready 状态，你的游戏引擎初始化就会开始。此过程可能从几秒到几分钟不等，在此期间服务器不会接受玩家连接。
* 考虑优化你的服务器初始化以缩短这段时间。
* 游戏客户端应以 1 秒间隔在有限时间内重试连接（取决于你的初始化时长），之后它们会返回匹配。
* 考虑添加加载场景，以便服务器可以与客户端同时进行初始化（在 Unreal Engine 中还可进行关卡切换），同时同步双方状态。

</details>

<details>

<summary>我的 Meta Quest 设备报出 <code>HTTP 0：无法解析目标主机</code> .</summary>

* 在为 Android 目标构建 Unity 应用时，你的 Internet Access 权限可能会从输出的 APK 客户端构建产物中自动移除。
* 请在以下位置重新添加权限（之后需要重新构建客户端）：
  * 项目设置 / OpenXR / :gear: Meta Quest Support / 强制移除 Internet 权限（取消勾选）。
  * 玩家设置 / Internet Access（设为 require）。

</details>

<details>

<summary>如果玩家离开我的部署，会发生什么？</summary>

* 默认情况下，服务器不会拒绝玩家连接。玩家认证由你的开发者决定，因为可以使用许多不同的方法和玩家认证提供商。
* 游戏客户端可能会在本地存储连接信息，以便在客户端意外崩溃时尝试重新连接。
* 为了让玩家加入进行中的游戏，考虑使用 [深入了解](https://docs.edgegap.com/zh/learn/pi-pei-xi-tong/matchmaker-in-depth.md#backfill) 或 [会话](https://docs.edgegap.com/docs/deployment/session).

</details>

<details>

<summary>我的服务器在就绪后显示 100% 的 CPU 使用率。</summary>

* 这可能不是问题，因为游戏引擎在服务器初始化期间往往会执行大量 CPU 密集型操作。如果在部署开始 2-3 分钟后 CPU 使用率仍未下降，你可能需要优化服务器或增加 App 版本资源。
* 降低 tick 速率会影响 CPU 使用率，因为服务器执行的消息操作会减少。
* 如果你使用的是 Mirror netcode，你需要在你的 [“Auto Start Server”](https://mirror-networking.gitbook.io/docs/hosting/edgegap-hosting-plugin-guide#build-and-push) 中选择 `NetworkManager` ，重新构建、推送并重新部署你的服务器。
* 如果你使用的是 FishNet netcode，你需要启用 [“Start on Headless”](https://fish-networking.gitbook.io/docs/manual/components/managers/server-manager#settings-are-general-settings-related-to-the-servermanager) 在你的 `ServerManager`，重新构建、推送并重新部署你的服务器。
* 在免费套餐中，你的资源限制为 1.5 vCPU 和 3GB 内存（RAM）。
* 在创建新的 App 版本时，你可以增加分配的资源。你可以在我们的 Dashboard 中复制你的 App 版本并按需调整这些值，而无需重新构建服务器或镜像。

</details>

<details>

<summary>我的部署反复重启，并显示错误 `OOM kill`。</summary>

* 这种行为是由于超出了分配的内存量。考虑通过对象池、压缩或移除场景中不需要的对象来优化内存使用。
* 确保你的项目正在加载包含你的……的默认场景 `NetworkManager` 并且该场景已包含在 Unity 的构建设置中。
* 在免费套餐中，你的资源限制为 1.5 vCPU 和 3GB 内存（RAM）。
* 在创建新的 App 版本时，你可以增加分配的资源。你可以在我们的 Dashboard 中复制你的 App 版本并按需调整这些值，而无需重新构建服务器或镜像。

</details>

<details>

<summary>有时，我服务器的内存（RAM）使用率会飙升到很高，这有问题吗？</summary>

* 只要你保持在分配的 App 版本内存量之内，这就不是问题。&#x20;
* 超出分配的 App 版本内存量会导致 \`OOM kill\`（见上文）。

</details>

<details>

<summary>同一台机器上运行的其他服务器会影响我的服务器性能吗？</summary>

* 不会，我们的平台可确保分配的资源不会被其他工作室或共享基础设施上的其他服务器使用。使用 Edgegap，没有“吵闹的邻居”。

</details>

[^1]: 会话最长可持续 24 小时

[^2]: 等于

[^3]: 不等于

[^4]: request\_id（部署 ID）

[^5]: 在数组中

[^6]: 不在数组中

[^7]: 小于或等于

[^8]: 大于或等于

[^9]: &#x20;在数组中

[^10]: 不区分大小写的模式匹配：

    * 使用 `%`  表示任意字符序列
    * 使用 `_`  表示任意单个字符

[^11]: 升序，最旧的在前

[^12]: 降序，最新的在前

[^13]: 升序，已满的在前

[^14]: 降序，空闲的在前
