JSON 响应对象

JSON 响应对象包含发现模式的版本号和已部署存档的列表。响应对象包含以下字段：

存档 JSON 对象

archives 对象包含所有已部署存档的列表。此列表中的每个对象都是一个 JSON 对象，其键是已部署存档的名称，例如 <Name of the CTF archive>，其值是一个具有以下字段的 JSON 对象：

函数 JSON 对象

functions 对象包含嵌套的 JSON 对象列表，其中每个嵌套对象对应已部署存档中的一个 MATLAB 函数。

每个函数对象都以部署的函数名称作为其键，例如 <MATLAB_function_name1>，并以 JSON 对象作为其值。JSON 对象包含一个 signatures 键，其值是一个 JSON 对象数组，其中包含有关 MATLAB 函数签名的信息。

signatures 数组中的每个对象包含以下字段：

inputs 数组中的每个对象包含以下字段：

outputs 对象中的每个对象包含以下字段：

typedefs JSON 对象

仅当部署的函数包含元胞数组或结构体作为输入或输出参量时，响应才包含 typedefs 对象。

如果部署的函数包含元胞数组作为输入或输出参量，则 typedefs 对象包含嵌套对象，其键是元胞数组的名称，例如 <homogeneous_cell_name>，相应的值包含一个包含有关元胞数组信息的对象。

<cell_array_name> 对象中的每个对象包含以下字段：

elements 中的每个对象包含以下字段：

如果部署的函数包含结构体数组作为输入或输出参量，则 typedefs 对象包含嵌套对象，其键是结构体的名称，例如 <struct_name>，相应的值包含一个具有有关该结构体信息的对象。

<struct_name> 对象中的每个对象包含以下字段：

fields 中的每个对象包含以下字段：

自定义度量

您可以通过添加特定于您的应用程序或请求处理的自定义度量来检测已部署的 MATLAB 代码。在部署的 MATLAB 代码中，您可以使用函数 prodserver.metrics.incrementCounter (MATLAB Compiler SDK) 和 prodserver.metrics.setGauge (MATLAB Compiler SDK) 创建自定义 Prometheus 度量。这些函数分别创建 Prometheus 计数器和计量度量类型的度量。

当客户端调用已部署的 MATLAB 函数时，服务器会收集自定义度量。除了默认的服务器度量之外，度量服务的输出还包括自定义度量和创建这些度量的可部署存档的名称。

例如，在您部署到服务器的 MATLAB 函数中包含以下函数会创建名为 test_function_execution_count 和 test_timer_seconds 的自定义度量。

prodserver.metrics.incrementCounter("test_function_execution_count",1);
prodserver.metrics.setGauge("test_timer_seconds",0.421147);

在客户端调用已部署的函数后查询度量 API 时，您会看到以下输出：

# TYPE matlabprodserver_up_time_seconds counter
matlabprodserver_up_time_seconds 16705.3
# TYPE matlabprodserver_queue_time_seconds gauge
matlabprodserver_queue_time_seconds 0
# TYPE matlabprodserver_cpu_time_seconds counter
matlabprodserver_cpu_time_seconds 29.1406
# TYPE matlabprodserver_memory_working_set_bytes gauge
matlabprodserver_memory_working_set_bytes 5.17153e+08
# TYPE matlabprodserver_requests_accepted_total counter
matlabprodserver_requests_accepted_total 7
# TYPE matlabprodserver_requests_in_queue gauge
matlabprodserver_requests_in_queue 0
# TYPE matlabprodserver_requests_processing gauge
matlabprodserver_requests_processing 0
# TYPE matlabprodserver_requests_succeeded_total counter
matlabprodserver_requests_succeeded_total 7
# TYPE matlabprodserver_requests_failed_total counter
matlabprodserver_requests_failed_total 0
# TYPE matlabprodserver_requests_canceled_total counter
matlabprodserver_requests_canceled_total 0
# TYPE test_function_execution_count counter
test_function_execution_count{archive="test_metrics_2"} 1
# TYPE test_timer_seconds gauge
test_timer_seconds{archive="test_metrics"} 0.421147

有关详细示例，请参阅创建自定义 Prometheus 度量。