本页采用了机器翻译。点击此处可查看最新英文版本。

GET Metrics

检索服务器度量

自 R2021a 起

描述

使用 GET 方法以 Prometheus® 度量格式检索服务器实例的度量。度量服务返回有关客户端应用程序发送到服务器的请求以及服务器执行请求所需的时间和内存的信息。您可以使用度量服务来监控 Kubernetes® 环境中的服务器度量。服务器重启时所有服务器度量都会重置。

除了服务器度量之外，度量服务还返回您可以在部署到服务器的 MATLAB® 函数中创建的自定义度量。有关详细示例，请参阅创建自定义 Prometheus 度量。自定义度量根据 worker-restart-interval 属性的值重置。

要使用度量服务，您必须在服务器上启用度量服务。通过取消注释 main_config 服务器配置文件中的选项 --enable-metrics 来执行此操作。

请求

HTTP 方法

GET

URI

http(s)://host:port/api/metrics

响应

成功

HTTP 状态代码

200 OK

主体
名称描述
matlabprodserver_up_time_seconds自服务器启动以来的时间（以秒为单位）。
matlabprodserver_queue_time_seconds当前排队的同步和异步请求的等待时间总和（以秒为单位）。
matlabprodserver_cpu_time_seconds

服务器启动后执行请求所花费的总 CPU 时间（以秒为单位）。

matlabprodserver_memory_working_set_bytes在给定时间内所有 MATLAB Production Server™ 进程的内存使用量总和（以字节为单位）。
matlabprodserver_requests_accepted_total

服务器启动后收到的有效请求总数。

在给定时间内接受的总请求数是取消的请求、排队的请求、处理的请求以及服务器启动后失败和成功完成的请求的总和。

matlabprodserver_requests_in_queue当前等待服务器处理的请求数。
matlabprodserver_requests_processing服务器当前正在处理的请求数。
matlabprodserver_requests_succeeded_total成功完成的请求总数。
matlabprodserver_requests_failed_total失败的请求总数。如果请求包含已部署的 MATLAB 函数的错误名称，则请求可能会失败。
matlabprodserver_requests_canceled_total客户端取消的异步请求总数。

错误

403 Metrics Disabled

示例调用

HTTP

请求：

GET /api/metrics HTTP/1.1
Host: localhost:9910

响应：

# TYPE matlabprodserver_up_time_seconds counter
matlabprodserver_up_time_seconds 68140.5
# TYPE matlabprodserver_queue_time_seconds gauge
matlabprodserver_queue_time_seconds 0
# TYPE matlabprodserver_cpu_time_seconds counter
matlabprodserver_cpu_time_seconds 18.2188
# TYPE matlabprodserver_memory_working_set_bytes gauge
matlabprodserver_memory_working_set_bytes 1.57426e+08
# TYPE matlabprodserver_requests_accepted_total counter
matlabprodserver_requests_accepted_total 0
# 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 0
# TYPE matlabprodserver_requests_failed_total counter
matlabprodserver_requests_failed_total 0
# TYPE matlabprodserver_requests_canceled_total counter
matlabprodserver_requests_canceled_total 0

JavaScript

var data = null;
var xhr = new XMLHttpRequest();
xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://localhost:9910/api/metrics");
xhr.send(data);

版本历史记录

在 R2021a 中推出

另请参阅

| (MATLAB Compiler SDK) | (MATLAB Compiler SDK)

主题

外部网站