在Perl程序中暴露Prometheus指标

SLI 与 SLO

---

SLI(服务质量指标) 指的是一个服务的某项服务质量的一个具体量化指标(如请求延迟、错误率、QPS)。

SLO(服务质量目标) 则是服务的某个 SLI 的目标值，例如，我们可以定义一个SLO，要求 95% 的请求的延迟小于 100ms。

SLI与SLO是传统运维转型SRE绕不过的主题，它们是SRE实践的核心。传统运维通常追求 100% 的可用性，但这个目标是不可能实现的，通过实施SLO，可以带来如下好处：

• 监控应用程序的行为，以便更好地改进应用程序

• 确定工作优先级，即开发新特性还是保障服务稳定性

• 作为控制手段使用，通过比较SLI与SLO，决定某项操作是否执行

• 建立用户预期

定义 SLI

---

要实施 SLO，首先要定义出来 SLI，而 Prometheus 监控则是定义 SLI 的一种很好的工具，下面将介绍在 Perl 程序中暴露 Prometheus Metric 来定义 SLI。

在 Perl 程序中暴露 Prometheus Metric

---

在 Perl 程序中暴露 Prometheus Metric，我们用到了两个模块：

• Dancer2 [1]：Perl 的一款轻量级Web应用程序框架。

• Net::Prometheus [2]: Perl 的 Prometheus 客户端库

下面借助这两个模块，我们在 Perl 应用程序中统计 '/login' 接口的调用次数：

#!/usr/bin/perl

use strict;
use warnings;
use Dancer2;
use Net::Prometheus;
# 使用 Time::HiRes 模块中的 time 函数获取毫秒级的 Epoch 时间
use Time::HiRes qw/time/;

set host => '0.0.0.0';
set port => 3678;

# 初始化 Prometheus 客户端
my $client = Net::Prometheus->new;
# 设置 counter 类型的 metric，并指定 metric 的 name, help, labels 信息
my $counter = $client->new_counter(
    name => "requests_count",
    help => "Number of received requests",
    labels => ['path']
);

 post '/login' => sub {
    # counter 加1，设置 label 为 path=login
    # $counter->inc({path => 'login'}); 或
    $counter->inc(('login'));
    # do something else
};

get '/metrics' => sub {
    if(request->user_agent =~ /curl|prometheus/i) {
        $client->render
    } else {
        "<pre>" . $client->render . "</pre>"
    }   
};

运行上面的 Perl 程序，并打开浏览器，输入地址：

http://SERVER-IP:3678/metrics

其中，SERVER-IP 为 Perl 程序所在服务器的 IP。

在浏览器打开上述地址后，就可以看到输出的 Prometheus metrics 了：

# HELP perl_heap_arenas Number of arenas in the Perl heap
# TYPE perl_heap_arenas gauge
perl_heap_arenas 713
# HELP perl_heap_svs Number of SVs in the Perl heap
# TYPE perl_heap_svs gauge
perl_heap_svs 120441
...
# HELP requests_count Number of received requests
# TYPE requests_count counter

但是，我们并没有看到我们自己定义的 requests_count 指标，只看到了这个指标的注释信息：

# HELP requests_count Number of received requests
# TYPE requests_count counter

这是由于 '/login' 这个接口还没有被访问过，尝试访问 '/login' 这个接口后，刷新浏览器后再次查看 Prometheus Metrics 就可以看到我们定义的指标了：

# HELP requests_count Number of received requests
# TYPE requests_count counter
requests_count{path="login"} 1

到这里，我们已经成功地为我们的 Perl 应用程序暴露了 Prometheus Metrics。

有了 Counter 类型的指标 requests_count，我们可以借助 Prometheus 的 rate() 函数[3] 来计算访问 '/login' 接口的 QPS，这样我们就定义好了一个 SLI。

Net::Prometheus 模块除了支持 counter 类型的 metric，还支持 gauge，summary，histogram 类型的 metric，使用方法都类似，详细的使用说明可以参考 Net::Prometheus 的文档[2]。

参考

---

[1]: https://metacpan.org/pod/Dancer2

[2]: https://metacpan.org/pod/Net::Prometheus

[3]: https://prometheus.io/docs/prometheus/latest/querying/functions/#rate

一如既往，如果你对文章中的内容有任何疑问，或者是发现文章中有任何错误，都可以通过留言告诉我；如果你喜欢我的文章，欢迎关注我的微信公众号 Tech For Geek。