开发者门户网站故障诊断 指南

使用本指南可帮助您诊断和解决 IBM® API Connect中的 Developer Portal 问题。

关于

以下部分提供了有关如何诊断和解决一些常见问题的建议。 此信息可帮助您确定特定 IBM API Connect Version 10 组件是否发生故障,是否是环境问题以及是否应提出支持请求。 一些建议包括查看特定日志文件,以便缩小查找问题根源的范围。
注意:API 管理器API 设计器用户界面的 "帮助" 图标。帮助页面中,单击产品信息磁贴可查找有关产品和 Git 软件包版本的信息。 API Designer 产品信息基于其关联的管理服务器,但 Git 信息则基于其下载位置。

为什么我的 Developer Portal 用户界面存在问题?

如果您遇到用户界面 (UI) 问题,请执行以下检查:
  • 尝试清除浏览器的高速缓存,尝试使用私密浏览,并尝试使用不同的浏览器 - 查看行为是否有任何差异。
  • 检查浏览器窗口大小和屏幕分辨率,并尝试增减各个设置。
  • 调查浏览器开发人员工具控制台和网络选项卡,因为它们可能会提供一些诊断线索。
  • 请尝试从开发人员门户网站清除 Drupal 缓存;详情请参阅清除服务器缓存

如果您需要打开服务请求,请在 IBM API Connect MustGather 信息日志的同时,附上问题重现的详细时间和日期。 此外,导出浏览器开发人员工具控制台和网络输出将很有帮助。

为什么我在将基于 Drupal 8 的定制模块或子主题安装到基于 Drupal 9 的 Developer Portal时迂到问题?

IBM API Connect 10.0.3.0开始, Developer Portal 基于 Drupal 9 内容管理系统。 如果要将 Drupal 8 定制模块或子主题安装到基于 Drupal 9 的 Developer Portal中,那么必须确保它们与 Drupal 9 兼容,包括它们包含的任何定制代码,并且不使用任何不推荐使用的 API ,例如。 有一些工具可用于检查自定义代码,例如 GitHub, 上的 drupal_check ,它可检查 Drupal 代码是否存在折旧。

例如,包含不包含 Drupal 9 版本声明的模块或子主题的任何 Developer Portal 站点都将无法升级,并且将在 admin 日志中看到类似以下输出的错误:
[     queue stdout] 14834 729319:355ec8:a7d29c 2021-09-04 20:34:49: check_d9_compat: Checking theme: emeraldgreen
[     queue stdout] 14834 729319:355ec8:a7d29c 2021-09-04 20:34:49: check_d9_compat: ERROR: Incompatible core_version_requirement '' found for emeraldgreen
[     queue stdout] 14834 729319:355ec8:a7d29c 2021-09-04 20:34:49: check_d9_compat: Checking theme: rubyred
[     queue stdout] 14834 729319:355ec8:a7d29c 2021-09-04 20:34:49: check_d9_compat: ERROR: Incompatible core_version_requirement '8.x' found for rubyred
[     queue stdout] 14834 729319:355ec8:a7d29c 2021-09-04 20:34:49: check_d9_compat: ERROR: Found themes incompatible with Drupal 9: emeraldgreen rubyred
[     queue stdout] 14834 729319:355ec8:a7d29c 2021-09-04 20:34:49: check_d9_compat: ERROR: /tmp/restore_site.355ec8 is NOT Drupal 9 compatible
...
[     queue stdout] 14834 729319:355ec8:a7d29c 2021-09-04 20:44:49: check_d9_compat: Checking module: custom_mod_1
[     queue stdout] 14834 729319:355ec8:a7d29c 2021-09-04 20:44:49: check_d9_compat: ERROR: Incompatible core_version_requirement '' found for custom_mod_1
[     queue stdout] 14834 729319:355ec8:a7d29c 2021-09-04 20:44:49: check_d9_compat: Checking module: custom_mod_2
[     queue stdout] 14834 729319:355ec8:a7d29c 2021-09-04 20:44:49: check_d9_compat: ERROR: Incompatible core_version_requirement '8.x' found for custom_mod_2
[     queue stdout] 14834 729319:355ec8:a7d29c 2021-09-04 20:44:49: check_d9_compat: ERROR: Found modules incompatible with Drupal 9: emeraldgreen rubyred
[     queue stdout] 14834 729319:355ec8:a7d29c 2021-09-04 20:44:49: check_d9_compat: ERROR: site1.com is NOT Drupal 9 compatible
要修正版本兼容性错误,所有定制模块和子主题都应在其 *.info.yml 文件中声明 core_version_requirement 键,以指示 Drupal 9 兼容性。 例如:
name: Example module
type: module
description: Purely an example
core: 8.x
core_version_requirement: '^8 || ^9'
package: Example module

# Information added by Drupal.org packaging script on 2020-05-31
version: '8.x-1.3'
project: 'example_module'
datestamp: 1590905415
此示例指定模块与所有版本的 Drupal 8 和 9 兼容。 如需了解更多信息,请参阅 drupal.org 网站上的. info.yml 文件,让 Drupal 了解您的模块

如果您具有需要复原的站点的备份,并且正在获取版本兼容性错误,但无法轻松更改模块或主题 *.info.yml 文件,那么可以修改站点备份。

要修改站点备份,请将其解压缩,编辑其中的相关文件,然后再次 tar 备份文件。 请注意,此过程将覆盖原始备份文件,因此请确保在开始抽取之前保留原始文件的单独副本。 例如:

  1. mkdir /tmp/backup
  2. cd /tmp/backup
  3. tar xfz path_to_backup.tar.gz
  4. 编辑定制模块和主题文件以使其 Drupal 9 兼容,并添加正确的 core_version_requirement 设置。
  5. rm -f path_to_backup.tar.gz
  6. tar cfz path_to_backup.tar.gz
  7. cd /
  8. rm -rf /tmp/backup

我的升级问题是否与自定义 Drupal 模块或主题有关?

为了增强 Drupal 网站的功能,您可以安装 IBM 未提供的其他模块或主题。 虽然这些定制或第三方组件可以提供扩展功能,但它们也可能影响核心功能,并在升级时带来兼容性问题。 此外,这些模块或主题可能与 Drupal 或 IBM API Connect 模块的较新版本不一致,或可能包含错误或漏洞。
注意: IBM 支持不包括由第三方组件或自定义模块或主题引起的问题。
如果定制导致升级失败,请考虑以下步骤:
注意: 在继续之前,请务必确保您的自定义模块和主题与目标升级版本兼容。
  1. 使用导出功能备份自定义和网站配置。 更多信息,请参阅导出和导入自定义主题和站点配置
  2. 临时切换主题 - 将网站主题设为 connect_theme ,将管理员主题设为 claro
  3. 禁用或暂时删除有问题的模块。
  4. 继续升级。
  5. 成功升级后重新应用并重新测试自定义功能
有关查找自定义模块和主题的更多信息,请参阅如何在开发人员门户网站上查找自定义模块和主题

有关升级开发人员门户的更多信息,请参阅将开发人员门户升级到 Drupal 11 的准备工作

为什么我在非完全相同的环境中会遇到迁移问题?

导出和导入自定义主题和网站配置时,请确保源环境和目标 Drupal 环境尽可能完全相同。 不同的环境可能经常导致迁移失败或意外行为。 始终确保两个环境的配置、启用或禁用的模块或主题完全相同,并且目标环境的数据库模式是最新的。

您可以在管理 > 报告 > 状态报告中查看每个环境。

有关导出或导入自定义主题和站点配置的更多信息,请参阅导出和导入自定义主题和站点配置