# 第七十章 使用 REST API 监控 IRIS - 互操作性指标

除了上一节中描述的指标外， IRIS 实例还可以记录有关活动互操作性产品的指标，并将它们包含在 `/metrics` 端点的输出中。默认情况下禁用这些互操作性指标的记录。要启用它，必须为要监控的每个互操作性产品执行以下步骤：

1. 为运行要监控的生产的 `IRIS` 实例打开一个终端会话。如有必要，通过执行以下命令切换到与生产关联的命名空间：

```
set $namespace = "[interopNS]"
```
其中 `[interopNS]` 是命名空间名称。

2. 在终端中，执行以下命令以启用当前命名空间内活动生产的指标收集（`SAM` 指的是系统警报和监控， 监控解决方案）：

```
do ##class(Ens.Util.Statistics).EnableSAMForNamespace()
```

注意：如果为命名空间启用了指标记录但相应的生产未激活，则 `/metrics` 端点不会返回任何指标。

`Ens.Util.Statistics` 类提供了自定义 `/metrics` 端点输出的方法。例如，调用方法 `DisableSAMIncludeHostLabel` 将为整个生产提供聚合指标，而不是为每个主机单独提供它们。

完成此步骤后可用的指标在下面的基本互操作性指标表中进行了描述。

3.

license和 cpf 文件的使用机制

 InterSystems 开发者竞赛：Tool（工具）已进入投票时间，我们收集到来自全球的21个参赛作品，其中有三个参赛应用来自中国开发者。

# 第六十九章 使用 REST API 监控 IRIS

每个 `IRIS®` 数据平台实例都包含一个提供实例统计信息的 `REST` 接口。 `REST API` 提供了一种从多台运行 `IRIS` 的机器收集信息的方法，使能够详细监控构成您的应用程序的所有实例。

本附录描述了 `/api/monitor` 服务提供的指标。这些指标与开源监控和警报工具 `Prometheus` 兼容。配置 `Prometheus` 以抓取多个连接的 `IRIS` 实例提供了整个系统的内聚视图，从而更容易评估系统是否正常有效地运行。

注意：有关创建和使用 REST 接口的介绍，请参阅第一眼：使用 产品开发 `Rest` 接口。

# /api/monitor Service

`/api/monitor` 服务提供有关运行它的  `IRIS` 实例的信息。默认情况下，`/api/monitor Web` 应用程序启用了“未经身份验证”的访问权限。有关为此服务设置身份验证的信息，请参阅创建 `REST` 服务中的保护 REST 服务一章。

此 API 具有以下两个端点：

- `/metrics Endpoint`,，它返回所有实例指标，并且可以配置为返回特定的应用程序指标。
- `/alerts Endpoint`，它返回自上次抓取端点以来发布的所有系统警报。

第六十八章 使用 Web 服务监控 IRIS - 监控网络客户端

SYS.WSMon.Client 类和相关类是一个 IRIS 网络服务客户端，可以在同一个 IRIS 实例或另一个 IRIS 实例中调用 SYS.WSMon.Server 网络服务的方法。

此 Web 客户端类使用以下 LOCATION 参数：

Parameter LOCATION = "http://server:port/csp/sys/SYS.WSMon.Service.cls" 

其中，服务器是运行 IRIS 的服务器，端口是 IRIS Web 服务服务器使用的端口。

以与使用其他 IRIS 网络服务客户端相同的方式使用此网络客户端：

1. 创建 Web 客户端类的实例。
2. 如果需要，设置其 Location 属性。

如果要使用的 SYS.WSMon.Server Web 服务与客户端位于不同的计算机上，或者如果它使用 52773 以外的端口，则这是必需的。

3. 如果需要，设置其他属性。
4. 调用网络方法。
5. 检查 web 方法返回的值。

详细信息取决于调用的 Web 方法；请参阅“监视 Web 服务的 Web 方法”部分并查看返回类型的类参考。

下面显示了一个示例终端会话：

USER>set $namespace = "%SYS"
 
%SYS>set client=##class(SYS.WSMon.Client).

第六十七章 使用 Web 服务监控 IRIS - 监控 Web 服务的 URL

对于给定的 IRIS 实例，日志监控 Web 服务可从以下 URL 获得：

http://server:port/csp/sys/SYS.WSMon.Service.cls

其中，服务器是运行 IRIS 的服务器，端口是 IRIS Web 服务服务器使用的端口。例如：

http://localhost:52773/csp/sys/SYS.WSMon.Service.cls

同样，此 Web 服务的 WSDL 可从以下 URL 获得：

http://server:port/csp/sys/SYS.WSMon.Service.cls?WSDL=1

监控 Web 服务的 Web 方法

类中的 SYS.WSMon.Service提供以下 Web 方法：

EnumBuffer()

method EnumBuffer() as %XML.DataSet

在枚举所有缓冲区大小的统计信息中返回 %XML.DataSet的实例。对于此实例，数据集使用类中 SYS.Stats.Buffer的 Sample() 类查询。

EnumDatabase()

method EnumDatabase() as %XML.DataSet

在中返回 %XML.DataSetO 的实例，该枚举该实例的所有数据库。对于此实例，数据集在类中使用 SYS.

通常，如果你想部署一个解决方案，你需要手动添加项目、配置你的查找表和默认配置。
如果您拥有执行这些操作的所有权限，那也没关系。如果您想部署到客户的生产服务器，但您没有权限，则需要在文档中指明系统部署必须执行的所有步骤。

第六十六章 使用 Web 服务监控 IRIS - IRIS 对 WS-Monitoring 的支持概述

本附录介绍并简要描述了如何使用 IRIS® 数据平台支持 WS-Management 规范，它使能够通过 SOAP 远程监控 IRIS 实例。

IRIS 对 WS-Monitoring 的支持概述

按照 WS-Management 规范，SYS.WSMon 包提供了一个 Web 服务，可以使用它来远程监控 IRIS 实例。它在功能上类似于 SNMP 接口（请参阅本指南的“使用 SNMP 监控 IRIS”附录），但使用内置的 IRIS 网络服务支持。

对 WS-Management 的支持包括以下元素：

• 提供返回有关 IRIS 实例信息的方法的日志监控 Web 服务（SYS.WSMon.Service）。
• 一个 IRIS Web 服务客户端（SYS.WSMon.Client），可以调用此监控 Web 服务或另一个 IRIS 实例的监控 Web 服务中的方法。

可以创建自己的 Web 客户端，而不是使用此 Web 客户端，可能使用第三方技术。

此 Web 服务和客户端使用几个启用 XML 的类来表示监视信息。

这些类包括 SYS.WSMon.wsEvent，它可以表示事件。

可以接收和处理事件的示例事件接收器 Web 服务（SYS.WSMon.EventSink）。

第六十五章 使用 SNMP 监控 IRIS - 用户定义的 SNMP 监视器类示例

本节介绍如何定义可通过 SNMP 查询的用户应用程序监视器类的示例。应用程序监视器仅包括 SNMP 数据中具有 %Monitor 数据类型的属性。

Example Sample Class

以下是此示例的示例类：

Class SNMP.Example Extends %Monitor.Adaptor
{

  /// Give the application a name. This allows you to group different 
  /// classes together under the same application level in the SNMP MIB.
  /// The default is the same as the Package name.
  Parameter APPLICATION = "MyApp";

  /// This groups a set of properties together at the "table" level of the
  /// SNMP MIB hierarchy. The default is the Class name.

目的

这两个工具（RanRead 和 RanWrite）用于在数据库（或一对数据库）内生成随机读写事件，以测试每秒输入/输出的操作数 (IOPS)。它们可以一起使用或分开单独使用，以测试 IO 硬件容量、验证目标 IOPS 并确保系统拥有可接受的磁盘响应时间。从 IO 测试中收集的结果将因配置而异，具体取决于 IO 子系统。在运行这些测试之前，请确保相应的操作系统监控和存储级别监控已配置，这些捕获的 IO 性能指标可以为以后的分析提供帮助。我们推荐使用 IRIS 中捆绑的系统性能工具，例如^SystemPerformance。

请注意，这里使用的工具是对先前版本的更新。之前的版本可在这里找到。

发布您自己的软件

首先：要发布您的软件，您要支持这个”命名规范。其中和zmp最相关的是包名和l类名的设计，你要定义成这样：

company.project.subpackage.TheClass.cls

如果您的Package Name定义是： Company.Project, 有大写字母，对不起，是无法用zpm打包的。

这个链接给了最简单的例子，但还不详细，我来总结一下：

发布您的软件前，有几件事情要了解：

1. zpm的注册中心并不存代码，存的只是一个到您代码的链接。因此，您得找地方放您的代码。当前最常用的是github。

2. 文件目录的结构

   举例：有一个class定义是 com.tony.Test1.cls, 你的目录应该这么组织，假设您要放在 /myDemo, 那么class应该在/myDemo/src/com/tony/Test1.cls。这是使用VSCode组织代码的默认方式，只有保证这样的目录结构，您才可能用zpm加载代码到iris.

让我来做个简单的例子。

首先，有这样的class:

Class com.tony.Test1
{	Property p1;
}

我的文件目录设置

$ ls -l /external/myDemo/src
total 4
-rw-r--r-- 1 irisowner irisowner 40 Nov 12 10:00 Test1.

Intersystems IRIS平台

队列监控组件

1. 概述

随着医院信息化建设的逐步完善，医院业务接口越来越多，业务接口数据处理可能会由于多种因素（网络、消费方系统等）影响下，出现消息堆积过多甚至造成接口卡顿的情况，影响院内正常业务开展，因此对于业务接口组件队列的的监控愈发重要。

当前Intersystems IRIS平台内置的队列监控界面仅展示接口组件实时队列信息，对于对于医院实际应用场景所需要的队列数据信息提供较为局限。队列监控组件程序是基于Intersystems IRIS平台开发，可以对所有接口组件进行统一监控，并展示组件24h内组件队列信息，也可通过设置时间段查询组件历史队列数据，更好满足当前的院内应用需求。      

关键应用：IRIS、Analytics

2. 应用介绍
   1. 功能简介

通过配置该程序组件，对Intersystems IRIS平台中production运行组件的消息队列实现实时统一监控功能，并展示当前业务接口组件24h队列趋势情况，也可以通过指定时间范围展示历史队列趋势情况，可通过组件历史队列数据分析当前业务接口组件配置是否合理、是否需优化；通过历史队列数据趋势分析，对队列数量产生频次；对于由队列问题引起的事故可通过趋势图快速定位队列起始时间及业务事件ID，减少事故排查时间，极大地提高排查效率。

第六十四章 使用 SNMP 监控 IRIS - 扩展 IRIS MIB

应用程序员可以添加托管对象定义并扩展 IRIS 子代理为其提供数据的 MIB。这不是一个完整的 MIB 编辑器或 SNMP 工具包；相反，它是一种添加简单应用程序指标的方法，可以通过 SNMP 浏览或查询这些指标。

注意：对象必须遵循基本的 IRIS SNMP 结构，对 SNMP 表结构的支持有限（仅支持整数值索引），并且不会创建 SNMP 陷阱（请参阅新选项卡类中的 %Monitor.AlertOpens） 对管理信息的 SNMP 结构有一个基本的了解是很有帮助的。

要创建这些对象，请执行以下操作：

1. 在继承 %Monitor.Adaptor 的类中创建 IRIS 对象定义。
2. 执行 SNMP 类方法以在 SNMP 中启用这些被管理对象，并创建 MIB 定义文件供管理应用程序使用。实现此目的的方法是 MonitorTools.SNMP.CreateMIB()。

该方法为 %Monitor 数据库中定义的特定应用程序创建私有企业 MIB 树的一个分支。除了为应用程序创建实际的 MIB 文件之外，该方法还创建了 MIB 树的内部轮廓。 IRIS 子代理使用它来注册 MIB 子树，为 GETNEXT 请求遍历树，并引用特定对象方法以在 GET 请求中收集实例数据。

正如之前在 2022 年全球峰会上宣布的那样，InterSystems 将停止交付或安装基于 Apache 的web服务器（通常称为私有web服务器或 PWS）；此更改目前计划用于 InterSystems IRIS 2023.2。

使用这种新方法，您可以完全控制选择最适合您目的的 Web 服务器，以及如何配置、维护和更新它。这一变化的一个主要好处是您将不再需要等待 InterSystems 的更新套件来获得最新版本，这在安全漏洞情况下尤其重要。 InterSystems 将提供可用于帮助配置 Apache 或 IIS 的工具。 （请注意，InterSystems IRIS Community Edition 将继续安装 PWS。）

安装 Web 服务器是一个常见的过程，通常很容易 - 各个 Web 服务器供应商都有详细的文档记录。

以下是适用于 Ubuntu、Windows 和 macOS 的示例。它们演示了快速安装，因此您可以看到当 InterSystems 产品不包含或安装 Web 服务器时的新行为。 （请注意，此代码按原样提供，不受支持，也不足以托管关键任务或数据敏感的应用程序。）

提供了常见问题解答，其中提供了更多信息并可访问用于尝试此新过程的工具包。请参阅本文末尾链接的 PDF 以获取常见问题解答，或者如果您想添加到讨论中，请访问https://community.

第六十三章 使用 SNMP 监控 IRIS - SNMP 故障排除

SNMP 故障排除

IRIS 子代理（运行 ^SNMP 例程）取决于操作系统提供的 SNMP 主代理的正确安装和配置。正如 IRIS 作为子代理中所述，^SNMP 例程与此主代理通信有两种主要方式：

• ^SNMP 主要在 TCP 端口 705 上使用 AgentX 协议。
• 在 Windows 上，^SNMP 使用安装为 iscsnmp.dll 的 Windows 扩展代理 DLL。

操作系统应该提供配置 SNMP 代理的详细说明，系统管理员应该花一些时间来了解如何执行此操作。如果在使 IRIS 与 SNMP 代理通信时遇到问题，以下是一些基本的故障排除指南和提示。

所有系统

• 确保 SNMP 代理独立于 IRIS 工作，并且至少可以查询 mib-2.system 树以获取一般系统信息。如果失败，在 Windows 上检查 Windows SNMP 服务；在 UNIX®/Linux 上查看 SNMP 守护程序 (snmpd) 是否正在运行。
• 如果可以成功查询 SNMP 系统信息但不能查询 IRIS MIB，则检查 IRIS 中运行 ^SNMP 例程的后台进程。尝试使用 $$start^SNMP() 函数启动它。如果例程启动但没有继续运行，请检查 IRIS install-dir/mgr 目录中的 messages.

第六十二章 使用 SNMP 监控 IRIS

本附录描述了 IRIS 数据平台和 SNMP（简单网络管理协议）之间的接口。 SNMP 是一种通信协议，作为一种管理 TCP/IP 网络（包括单个网络设备和一般计算机设备）的方法已获得广泛接受。它的流行扩大了它作为许多企业管理工具的底层结构和协议的用途。这是它对 IRIS 的主要重要性：一种向各种管理工具提供管理和监控信息的标准方法。

SNMP 既是一种标准消息格式，也是管理对象的一组标准定义。它还提供用于添加自定义管理对象的标准结构，这是 IRIS 用来定义其管理信息以供其他应用程序使用的功能。

将 SNMP 与 IRIS 结合使用

SNMP 定义了客户端-服务器关系，其中客户端（网络管理应用程序）连接到在远程网络设备或计算机系统上执行的服务器程序（称为 SNMP 代理）。客户端请求并从该代理接收信息。有四种基本类型的 SNMP 消息：

• GET – 获取特定托管对象的数据
• GETNEXT – 获取分层树中下一个管理对象的数据，允许系统管理员遍历设备的所有数据
• SET——为特定的管理对象设置值
• TRAP——被管理设备或系统发送的异步警报

SNMP MIB（管理信息库）包含管理对象的定义。每个设备都会发布一个文件，也称为其 MIB，该文件定义了它支持的标准 MIB 的哪一部分，以及托管对象的任何自定义定义。

亲爱的开发者们！是时候公布2022 年 InterSystems 开发者社区杰出贡献者了🎉

我们很高兴为所有社区站点（英文、西文、葡语、日文、中文和法语）中最活跃的贡献者提供奖励，包括：

• 顶级作者——热门作者；
• 顶级专家——InterSystems专家；
• 顶级舆论制造者——意见领袖；
• 还有一个最新提名......年度突破奖！

亲爱的开发者们，

非常感谢您又在 InterSystems 开发者社区度过了一年！

我们的团队日复一日地努力让它变得更好，这对我们12000+ 每一位成员都很重要！

我们想知道目前开发者社区对您有多大用处。请花点时间让我们了解您的想法，以及可以改进的地方：

👉🏼 InterSystems 开发者社区2022年度调查 👈🏼

请知悉：调查可在 5 分钟内完成。

亲爱的社区开发者们，

有一些开发者已经通过了InterSystems 官方认证，并希望在个人资料头像上有一个漂亮的绿色标识

以及您社区中的所有证书，以便其他人更好地了解你的能力……

那么，要将认证添加到您的社区资料中，您需要执行 3 个简单的步骤：

1️⃣ 打开社区个人主页（点击右上角头像即可）

2️⃣ 找到InterSystems 认证（ InterSystems Certification）

3️⃣ 点击加载我的认证（Load my certification）

就这么简单！

消息查看器可以重新发送消息，但不适合重新发送大量消息（>100）。为此，您应该使用如下的Object Script代码：

第六十章 使用 ^PERFSAMPLE 监控进程 - 预定义分析示例

预定义分析示例

以下是从过程状态维度开始的分析示例。

在此示例中，^PERFSAMPLE 在 319994 个样本中找到了 76755 个处于可样本状态的进程样本（如果选择了忽略空闲的选项，则为非空闲）：

– PERFSAMPLE for Local Process Activity. 3.89s at 11/17/2020 16:59:59
76755 events in 319994 samples [24.0 %-total] | CPULoad* 8.22
Multiple jobs included: 2191 samples per job
----------------------------'?' for help----------------------------
Process State [24.0 %-total]
GGET [8.46 %-total]
RUN [5.88 %-total]
GDEF [3.16 %-total]
GSETW [1.63 %-total]
BSETW [1.21 %-total]
GDEFW [1.18 %-total]
GGETW [0.931 %-total]
SEMW [0.685 %-total]
GSET [0.

第五十九章 使用 ^PERFSAMPLE 监控进程 - 收集样本

本主题介绍 ^PERFSAMPLE 实用程序，这是一种用于分析 IRIS® 数据平台流程的工具。该实用程序处理实时系统上的活动，并呈现采样活动的易于导航的细分，这可以提供对系统的洞察力。例如，可以通过检查 ECP 请求来发现应用程序瓶颈，或者通过查看等待事件的类型来识别整个系统的瓶颈。

要开始，请从感兴趣的 IRIS 实例上的 %SYS 命名空间运行 ^PERFSAMPLE：

USER>set $namespace = "%SYS"
 
%SYS>do ^PERFSAMPLE

Collecting Samples

运行^PERFSAMPLE后，立即显示以下消息：

This utility performs high frequency sampling of processes on the system,
analyzing and counting data points in different ways to understand where
processes are spending most of their time.

第五十八章 使用 ^BLKCOL 监视块冲突

当一个进程被迫等待访问一个块时，就会发生块冲突。过多的块冲突会降低应用程序性能。

Using ^BLKCOL

在 IRIS® 数据平台中，^BLKCOL 实用程序对指定时间段（默认为 10 秒）内的块碰撞进行采样，记录这段时间内指定时间间隔（默认为 10 毫秒）内的最新块碰撞。对于每个记录的冲突，^BLKCOL 不仅标识块，还标识涉及的全局及其在块中的第一个和最后一个引用，以及创建试图访问块的进程的例程和行。

注意：irisstat -D 选项，如本指南附录“使用 irisstat 实用程序监视 IRIS”中的使用选项运行 irisstat 中所述，也对块冲突进行采样，但仅识别涉及的块。

irisstat -D 的输出包含在 ^SystemPerformance 实用程序生成的报告中，如本指南的使用 ^SystemPerformance 监控性能一章所述。

大家好，

我在 OEX 上加载了一个新软件包，我也计划在本月参加比赛。

简而言之，它为您提供以下内容。

• 用于 InterSystems IRIS 的持久（表）类以保存记录历史的基类
• 这些类允许在touch时将持久类记录历史化到另一个持久类中。
• 这提供了任何记录的完整历史记录。
• 它允许记录回滚到特定版本。
• 它可以自动清除旧的历史记录。

请检查一下。

谢谢你们。

第五十七章 历史监视器 - 汇总

汇总

Application Monitor 执行的 %Monitor.System.HistoryPerf 和 %Monitor.System.HistorySys 类也在每天结束时创建每小时和每天的摘要。摘要被定义为持久类 SYS.History.Hourly 和 SYS.History.Daily；它们包括所有四个基类作为嵌入对象。

对于每个度量属性，系统可以计算每小时和全天的平均值、最大值（高水位线）、标准差、最小值、中值或总数。对于每个基类（SYS.History.PerformanceO、SYS.History.WriteDaemon、SYS.History.SystemUsage 或 SYS.History .Database) 和每个汇总期间类，使用每个基类的 SetSummary() 方法。默认情况下，History Monitor 计算每小时和每日摘要的每个类的平均值、最大值和标准偏差。

注意：SYS.History.Performance 的计数器属性已标准化为这些计算的每秒速率（Total 除外）。

清除数据 创建摘要后，Application Monitor 会自动清除间隔和每小时数据库。间隔数据的默认值为七 (7) 天，每小时数据的默认值为 60 天，但可以使用 SYS.History.PerfData 和 SYS.

以下是 2023 年 InterSystems 开发者工具大赛的技术红利，您可以在投票中获得额外加分：

• 嵌入式 Python的使用
• Docker容器的使用
• ZPM 包部署
• 在线演示
• 代码质量通过
• 开发者社区文章
• 开发者社区第二篇文章
• 上传 YouTube 视频
• 第一次贡献

请参阅下面的额外加分项详细信息：

嵌入式 Python的使用 - 3 分

在您的应用程序中使用嵌入式 Python，可以获得 3 分加分。您至少需要 InterSystems IRIS 2021.2及以上版本。

Docker 容器的使用 - 2 分

如果应用程序使用在 docker 容器中运行的 InterSystems IRIS，则该应用程序将获得“Docker 容器”奖励。这是最简单的模板。

ZPM 包部署 - 2 分

如果您为您的全栈应用程序构建和发布 ZPM（ObjectScript 包管理器）包，您可以获得2分加分，以便它可以使用如下方式部署：

zpm "install your-multi-model-solution"

已安装的ZPM 客户端命令，请参考：

ZPM客户端。文档。

项目的在线演示 - 2 分
如果您将项目作为在线演示提供给云，则可额外获得 3 个奖励积分。您可以自己完成，也可以使用此模板- 这是一个 示例。这是有关如何使用它的视频。

使用学习服务中的一系列资源制定您今年的学习目标。在2023 年 1 月简报中，了解如何找到与您的工作任务相关的有针对性的学习资源，并通过课堂课程或练习题为认证做准备。

第五十六章 历史监视器

History Monitor 维护性能和系统使用指标的历史数据库。其主要目的是：

• 提供性能基准并帮助分析性能问题。
• 帮助分析一段时间内的系统使用情况以进行容量规划。

该数据库在 SYS.History 类包中定义并保存在 %SYS 命名空间中。数据库结构的所有细节都在那里发布，并且可以通过 SQL 或正常的持久对象访问访问数据。 SYS.History 中的类文档还包含对所有可用的单个属性、方法和查询的描述。

数据通常分为性能（请参阅 SYS.History.Performance）和系统使用情况（请参阅 SYS.History.SystemUsage）数据。性能指标旨在以较短的时间间隔（默认情况下为 30 秒）进行采样，系统使用数据以较长的时间间隔（默认情况下为 5 分钟）进行采样。在每天开始时，将各个时间间隔样本作为平均值、最大值、最小值、标准偏差、中值和总计汇总到每小时和每天的表格中。可以选择为每个度量类保留哪些汇总函数（如果有）。间隔和每小时数据可能会在定义的天数（默认分别为七 (7) 天和 60 天）后自动清除；每日摘要用于长期分析，可以手动清除。

基本指标

所有收集的指标都在 SYS.History 的四个 %SerialObject 类中定义。

第五十五章 使用 ^mgstat 监控性能 - Seizes、ASeizes 和 NSeizes

嘿开发者，

我们想邀请您参加我们的下一场比赛，该比赛致力于创造有用的工具，让您的开发伙伴们的生活更轻松：

🏆 InterSystems 开发者竞赛：Tool（工具）🏆

提交有助于加快开发速度、贡献更多定性代码并有助于使用 InterSystems IRIS 测试、部署、支持或监控您的解决方案的应用程序。

时间： 2023 年 1 月 23 日至 2 月 12 日（美国东部时间）

奖金池： 13,500 美元