配置对指标的访问

指标 API 捕获有关 ArcGIS Enterprise 组件及其运行所在计算机的信息。要利用指标 API 提供的信息，您需要创建一个密钥或令牌以授权访问指标，配置 Prometheus 来抓取指标，还可以配置 Grafana 来可视化这些指标。

指标默认为启用状态，但如有需要，可以禁用指标。

配置访问权限

在抓取指标之前，确保您启用了正确的访问权限。

运行每个软件组件的账户必须是性能监控群组的一员，负责收集机器指标。

对于 ArcGIS Enterprise 部署，包括任何联合服务器，请用 API 密钥对请求进行身份验证。对于独立的 ArcGIS Server 站点，使用管理令牌对请求进行身份验证。

注:

要成功进行身份验证以获取任何 ArcGIS Enterprise 组件的指标，必须能够访问 Portal for ArcGIS 服务。 ArcGIS Data Store 指标的身份验证还要求可访问托管服务器。

使用 ArcGIS Enterprise 获取 API 密钥

如需使用 ArcGIS Enterprise 获取适合访问指标 API 的 API 密钥，请完成以下步骤：

以管理员身份登录到您的组织。
在内容页面的我的内容选项卡中，单击新建项目，然后单击开发者凭据。
选择 API 密钥凭据，然后单击下一步。
选择具有所选权限和访问权的私有应用程序，然后单击下一步。
选择无项目访问权，然后单击下一步。
选择可观测性权限，然后单击下一步。
选择到期日期和可选的任意引用者 URL，然后单击下一步。
为 API 密钥项添加标题，并可选添加标签和摘要，然后单击下一步。
检查 API 密钥配置以确保准确性，然后单击下一步。
确保选择了现在生成 API 密钥选项，然后单击下一步。
复制 API 密钥。

使用 ArcGIS Server 获取管理令牌

对于独立的 ArcGIS Server 站点，您可以使用 ArcGIS Server 获取管理令牌。对于联合 ArcGIS Server 站点，请改为获取 API 密钥。

以具有管理权限的用户身份登录 ArcGIS Server Administrator Directory。
单击 generateToken。
提供以下信息：
- 用户名 - 拥有管理员权限的用户的用户名
- 密码 - 指定用户名的密码
- 客户端 - HTTP 参照地址
- HTTP 参照地址 - 与 Prometheus 配置中指定的参照地址匹配的 URL。示例 Prometheus 配置使用 ARCGIS.COM 作为参照地址。
可以选择设置以分钟为单位的有效期。

注:

默认有效期是 60 分钟。默认的最长有效期为 1440 分钟（24 小时）。若要生成有效期更长的令牌，管理员必须在生成令牌之前更新令牌配置，以增加 longTimeout 属性。增加 longTimeout 值时请务必谨慎，以确保更新后的值符合您的安全要求。
单击生成。
复制令牌。

配置 Prometheus 服务器

要将指标 API 添加为抓取目标，需要更新 Prometheus 配置。关于部署 Prometheus 的说明，请参见部署指南。

为 ArcGIS Enterprise 中每个需要获取指标的组件配置一个独立的抓取任务。每种抓取配置都需要以下信息：

job_name - 作业的唯一名称。
http_sd_configs - 服务发现端点的配置。需要以下信息：
- url - 服务发现端点的 URL。该 URL 格式将为 <scheme>://<machine fqdn>/<context>/monitoring/discovery。
  
  对于 Portal for ArcGIS 和 ArcGIS Server，建议使用 ArcGIS Web Adaptor 或反向代理的 URL。例如，组织可能会将 https://portal.example.com/portal/monitoring/discovery 用于门户指标的服务发现，或者将 https://gisserver.example.com/server/monitoring/discovery 用于 ArcGIS Server 站点的服务发现。
  
  对于 ArcGIS Data Store，必须指定安装关系存储的计算机和端口号。例如：https://relational.example.com:2443/arcgis/monitoring/discovery
- bearer_token 或 bearer_token_file - 您创建的 ArcGIS Enterprise API 密钥或 ArcGIS Server 管理令牌。
  
  该令牌作为 http_sd_configs 的一部分提供，用于向服务发现端点进行身份验证。
bearer_token 或 bearer_token_file - 您创建的 ArcGIS Enterprise API 密钥或 ArcGIS Server 管理令牌。

该令牌作为抓取配置的一部分再次提供，用于对指标收集端点进行身份验证。
metrics_path - 值必须为 /arcgis/monitoring/metrics

抓取计算机指标需要直接向每台计算机发出请求。这些请求不会通过已配置的任何 ArcGIS Web Adaptor 或反向代理进行。确保 Prometheus 服务器可以通过端口 6443 访问每台 ArcGIS Server 计算机，以及通过端口 7443 访问每台 Portal for ArcGIS 计算机。
scheme - 为 http 或 https，具体取决于 https_sd_configs 中指定的 URL 配置为通过 http 还是 https 访问。

请参阅示例 Prometheus 配置，获取用于抓取 ArcGIS Enterprise 指标的 YAML 模板文件。可使用示例仪表盘模板配置 Grafana，以便在使用 Prometheus 收集指标后进行可视化。

配置指标清理间隔

系统清除指标的默认间隔为 1 小时，这对于大多数组织来说是合适的。关于更改清除间隔时的考虑因素，请参见清除指标。

如果需要更改清除间隔，具体步骤取决于 ArcGIS Enterprise 组件。

配置 ArcGIS Server 的指标清除间隔

以具有管理权限的用户身份登录 ArcGIS Server Administrator Directory。
导航至系统 > 属性 > 更新。
在属性文本框中，以 JSON 格式为 metricsClearingIntervalInHours 键添加一个值。

例如，如需设置两小时的间隔，可以使用以下 JSON：
```
{
   "isMetricsEnabled": true,
   "metricsClearingIntervalInHours": 2
}
```
单击更新。
重新启动 ArcGIS Server 服务。

配置 Portal for ArcGIS 的指标清除间隔

以组织管理员的身份登录到 Portal Administrator Directory。
导航至系统 > 属性 > 更新属性。
在属性文本框中，以 JSON 格式为 metricsClearingIntervalInHours 键添加一个值。

例如，如需设置两小时的间隔，可以使用以下 JSON：
```
{
   "isMetricsEnabled": true,
   "metricsClearingIntervalInHours": 2
}
```
单击更新属性。

此操作将自动重启 Portal for ArcGIS 服务。

配置 ArcGIS Data Store 的指标清除间隔

在安装关系存储的计算机上运行 datastoremetrics 实用程序，并指定 interval 参数。例如，如需设置两小时的间隔，可以使用以下命令：

./datastoremetrics --enabled true --interval 2

datastoremetrics --enabled true --interval 2

要更改主关系存储和备用关系存储的指标清除间隔，必须在两者上都运行该实用程序。

禁用指标

禁用指标的步骤取决于 ArcGIS Enterprise 组件。

禁用 ArcGIS Server 站点的指标

以具有管理权限的用户身份登录 ArcGIS Server Administrator Directory。
导航至系统 > 属性 > 更新。
在属性文本框中，将 isMetricsEnabled 关键字设置为 false：
```
{"isMetricsEnabled": false}
```
单击更新。
重新启动 ArcGIS Server 服务。

禁用 Portal for ArcGIS 的指标

以组织管理员的身份登录到 Portal Administrator Directory。
导航至系统 > 属性 > 更新属性。
在属性文本框中，将 isMetricsEnabled 关键字设置为 false：
```
{"isMetricsEnabled": false}
```
单击更新属性。

此操作将自动重启 Portal for ArcGIS 服务。

禁用 ArcGIS Data Store 的指标

要禁用 ArcGIS Data Store 的指标，请在安装关系存储的计算机上使用以下命令运行 datastoremetrics 实用程序：

./datastoremetrics --enabled false

datastoremetrics --enabled false