Dropwizard-metric的使用

2023-12-06 14:12
文章标签 使用 metric dropwizard

本文主要是介绍Dropwizard-metric的使用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

背景

近期在开发中用到了dropwizard-metric作为监控metric的埋点框架,由于是分布式的系统,前期曾经对比过hadoop-metric的实现和dropwizard-metric的实现,因为开发的项目后续会和hadoop的项目有一定的上下游关系,所以考虑排除掉hadoop的引用,防止后续出现循环依赖等问题。所以深度的调研了dropwizard-metric的使用,发现alluxio,ozone,ratis等项目都或多或少的使用了dropwizard-metric框架,所以本文详细的介绍一下dropwizard-metric的使用。


dropwizard-metric介绍

官方的介绍为,它提供了一个强大的组件包,可以用来衡量生产环境中关键组件的行为方法。简化来说就是监控!大家现在普遍接受的架构多半是promethus+grafa,那promethus的数据来源就依赖系统中的埋点,dropwizard-metric就是这样一个框架,它支持埋点并将数据以多种形式report对外暴漏供用户使用。

首先,当然需要引入mvn依赖,注意版本号,当前官方文档最新的release版本为4.2,之前的release已经停止维护了。

<dependencies><dependency><groupId>io.dropwizard.metrics</groupId><artifactId>metrics-core</artifactId><version>${metrics.version}</version></dependency>
</dependencies>

下面介绍dropwizard中的几个常用的埋点类型:

  • Counter :递增的数据,配置告警和监控时需要使用diff

  • Gauge: 使用与瞬时值,比如查看当前队列长度等等

  • Timer: 使用try with resource包含,可以用来查看try包含的操作的执行时间

  • Histograms:用来查看各种延迟信息,95th,99th,最大值,最小值等等

  • Meter:一段时间内发生的请求数,可以用来计算QPM,QPS等等?这个暂时没用到

  • healthCheck:可用于监控某些链接是否正常,状态是否正常等等,如连接数据库,定期check

埋点操作完成后,要进行数据的report, 该框架提供了多种report方法,其中包含:

  • jmxReporter,  report之后可以从VisualVM查看当前的metric值
  • httpReporter,  需要增加引用, 该引用作用是默认认为你的系统中使用jetty等或者其他框架的web框架,可以将metric的数据暴露到http界面中
<dependency><groupId>io.dropwizard.metrics</groupId><artifactId>metrics-servlets</artifactId><version>${metrics.version}</version>
</dependency>
  • ConsoleReporter: 将metric信息打印到控制台,可以设置时间间隔
  • Log4jReporter: 将metric信息通过日志的形式打印
  • 其它的还有CSVReporter, GraphiteReporter 

dropwizard-metric的使用

需要有一个全局的registry负责注册系统中的所有metric,注意healthCheck的使用方式有些不同,后面单独讲解

private final MetricRegistry metrics = new MetricRegistry();

 有了registry就可以之后可以用来注册具体的指标类型使用了。

  • gauge, 其中getValue可以自己定义一个方法,用来获取某一个瞬时值
metrics.register("testGaugeSize", () -> getValue());
  • counter, 注册之后可以调用counter的icr()和dec()等方法
// 注册
private final Counter testCounter = metrics.counter("testCounterNums");// 使用
testCounter.icr();
testCounter.dec();
  • meter,用来计算QPM或QPS等等,可以放在一个统一的入口位置。
// 注册
private final Meter meterTest = metrics.meter("meterTest");// 使用
public void handleRequest(Request request, Response response) {meterTest.mark();
}
  • timer, 用来计算某一些操作的耗时,可以使用try with resource的形式,或者使用try finally记得要关闭context即可
private final Timer testTimer = metrics.timer("testTimer");public String handleRequest(Request request, Response response) {try(final Timer.Context context = testTimer.time()) {// 一些处理逻辑,也就是计算耗时的部分} 
}
  • histograms,直方图,顾名思义是一算一些最大值,最小值,平均值,中位数等等
private final Histogram testHistogram = metrics.histogram("testHistogram");public void handleRequest(Request request, Response response) {// etctestHistogram.update(response.getContent().length);
}
  • Health_check的使用和以上有一些差别,如下:
// 需要单独注册registry,不和上边的metric类型公用
final HealthCheckRegistry healthChecks = new HealthCheckRegistry();
// 使用方式,需要先继承HealthCheck的类,实现自己的check逻辑
public class DatabaseHealthCheck extends HealthCheck {private final Database database;public DatabaseHealthCheck(Database database) {this.database = database;}@Overridepublic HealthCheck.Result check() throws Exception {if (database.isConnected()) {return HealthCheck.Result.healthy();} else {return HealthCheck.Result.unhealthy("Cannot connect to " + database.getUrl());}}
}
// 注册到全局的healthChecks中
healthChecks.register("testHealthCheck", new DatabaseHealthCheck(database));
  • 可以注册一些dropwizard原生的JVM或者GC相关的数据到registry当中,可以帮助定位JVM的相关问题
  • registry.registerAll(new JvmAttributeGaugeSet());
    registry.registerAll(new GarbageCollectorMetricSet());
    registry.registerAll(new MemoryUsageGaugeSet());
    registry.registerAll(new ClassLoadingGaugeSet());
     

dropwizard-metric的report方式

report的方式有多种,一般常用的可能有jmxReporter, httpReporter在本文中只是简单的举例,大家可以根据自己的用法继续探索挖掘。

  • jmxReporter

需要增加mvn引用

<dependency><groupId>io.dropwizard.metrics</groupId><artifactId>metrics-jmx</artifactId><version>${metrics.version}</version>
</dependency>

使用方式也比较简单:

// registry为上文提到的全局registry
final JmxReporter reporter = JmxReporter.forRegistry(registry).build();
reporter.start();

在以上完成后,可以使用VisualVM查看是否被report到JVM的MBeans中,使用java中自带的即可,但是需要安装Mbeans的插件,安装成功后可以看到如下:

  • HttpReporter, 该reporter的方式为用户可视化的方式看到metric

需要额外的引用

<dependency><groupId>io.dropwizard.metrics</groupId><artifactId>metrics-servlets</artifactId><version>${metrics.version}</version>
</dependency>

使用方式为,项目中的web服务,自定义一个servlet并将它加到你的httpServer中,类似

addServlet("metrics", "/metrics", MetricsServlet.class);

servlet注册成功后,可以从界面上看到如下界面:

其它的reporter的使用方式,在此不再多余的讲解,感兴趣可以直接查看官方文档other-reporting 

其它思考

按照当前的使用方式,每个metric定义的时候都需要使用registry.counter或者.timer或者.meter才能使用这个metric,很样就导致metric的对象实现在项目中特别琐碎,可能放到任何一个你需要监控的类中,在用户使用过程中可以参考hadoop的@Metric的注解,自定义实现一个注解,用来标注metric的类型,name等等,在类加载的过程中将指标register到全局registry中,使用起来更加的方便,其他人在使用时可以直接标注注解即可,不需要学习更多的dropwizard-metric的使用方法即可参与到代码实现中。

这篇关于Dropwizard-metric的使用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/462106

相关文章

vue使用docxtemplater导出word

《vue使用docxtemplater导出word》docxtemplater是一种邮件合并工具,以编程方式使用并处理条件、循环,并且可以扩展以插入任何内容,下面我们来看看如何使用docxtempl... 目录docxtemplatervue使用docxtemplater导出word安装常用语法 封装导出方

Linux换行符的使用方法详解

《Linux换行符的使用方法详解》本文介绍了Linux中常用的换行符LF及其在文件中的表示,展示了如何使用sed命令替换换行符,并列举了与换行符处理相关的Linux命令,通过代码讲解的非常详细,需要的... 目录简介检测文件中的换行符使用 cat -A 查看换行符使用 od -c 检查字符换行符格式转换将

使用Jackson进行JSON生成与解析的新手指南

《使用Jackson进行JSON生成与解析的新手指南》这篇文章主要为大家详细介绍了如何使用Jackson进行JSON生成与解析处理,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1. 核心依赖2. 基础用法2.1 对象转 jsON(序列化)2.2 JSON 转对象(反序列化)3.

使用Python实现快速搭建本地HTTP服务器

《使用Python实现快速搭建本地HTTP服务器》:本文主要介绍如何使用Python快速搭建本地HTTP服务器,轻松实现一键HTTP文件共享,同时结合二维码技术,让访问更简单,感兴趣的小伙伴可以了... 目录1. 概述2. 快速搭建 HTTP 文件共享服务2.1 核心思路2.2 代码实现2.3 代码解读3.

Elasticsearch 在 Java 中的使用教程

《Elasticsearch在Java中的使用教程》Elasticsearch是一个分布式搜索和分析引擎,基于ApacheLucene构建,能够实现实时数据的存储、搜索、和分析,它广泛应用于全文... 目录1. Elasticsearch 简介2. 环境准备2.1 安装 Elasticsearch2.2 J

使用C#代码在PDF文档中添加、删除和替换图片

《使用C#代码在PDF文档中添加、删除和替换图片》在当今数字化文档处理场景中,动态操作PDF文档中的图像已成为企业级应用开发的核心需求之一,本文将介绍如何在.NET平台使用C#代码在PDF文档中添加、... 目录引言用C#添加图片到PDF文档用C#删除PDF文档中的图片用C#替换PDF文档中的图片引言在当

Java中List的contains()方法的使用小结

《Java中List的contains()方法的使用小结》List的contains()方法用于检查列表中是否包含指定的元素,借助equals()方法进行判断,下面就来介绍Java中List的c... 目录详细展开1. 方法签名2. 工作原理3. 使用示例4. 注意事项总结结论:List 的 contain

C#使用SQLite进行大数据量高效处理的代码示例

《C#使用SQLite进行大数据量高效处理的代码示例》在软件开发中,高效处理大数据量是一个常见且具有挑战性的任务,SQLite因其零配置、嵌入式、跨平台的特性,成为许多开发者的首选数据库,本文将深入探... 目录前言准备工作数据实体核心技术批量插入:从乌龟到猎豹的蜕变分页查询:加载百万数据异步处理:拒绝界面

Android中Dialog的使用详解

《Android中Dialog的使用详解》Dialog(对话框)是Android中常用的UI组件,用于临时显示重要信息或获取用户输入,本文给大家介绍Android中Dialog的使用,感兴趣的朋友一起... 目录android中Dialog的使用详解1. 基本Dialog类型1.1 AlertDialog(

Python使用自带的base64库进行base64编码和解码

《Python使用自带的base64库进行base64编码和解码》在Python中,处理数据的编码和解码是数据传输和存储中非常普遍的需求,其中,Base64是一种常用的编码方案,本文我将详细介绍如何使... 目录引言使用python的base64库进行编码和解码编码函数解码函数Base64编码的应用场景注意