JMX可视化监控线程池

浅浅的花香味﹌ 2023-02-23 07:55 9阅读 0赞

![format_png][]

喜欢请点关注

![format_png 1][]

![format_png 2][]

**前言**

### 通过阅读本篇文章你将了解到：    ###

*  JMX介绍
 *  线程池介绍
 *  JMX监控线程池应用

### 什么是JMX ###

######     ######

**JMX简介**

`JMX（Java Management Extensions）`，监控管理框架，通过使用`JMX`可以监控和管理应用程序。`JMX`最常见的场景是监控`Java`程序的基本信息和运行情况，任何Java程序都可以开启`JMX`，然后使用`JConsole`或`Visual VM`进行预览

###### JMX架构 ######

![format_png 3][]

JMX架构图

总共分为三层，分发层、代理层、设备层  
**分发层：**根据不同的协议定义了对代理层进行各种操作的管理接口，简单的来说是监控指标的查看方式，可以是`HTTP`连接、`RMI`连接、`SNMP`连接  
**代理层：**管理MBean，通过将MBean注册到代理层实现MBean的管理，除了注册`MBean`，还可以注册`Adapter`，代理层在应用中一般都是`MBeanService`

**设备层：**监控指标抽象出的类，可以分为以下几种:

*  Standard MBean
 *  Dynamic MBean
 *  Open MBean
 *  Model MBean
 *  MXBean
 *

应用中一般使用`Standard MBean`比较多，所以这里只介绍`Standard MBean`，使用`Standard MBean`需要满足一定的规则，规则如下：

*  定义一个接口，接口名必须为`XXXXMBean`的格式，**必须**以`MBean`结尾
 *  如果接口为`XXXXMBean`，则接口实现类必须为`MBean`，否则程序将报错
 *  接口中通过`get`和`set`方法表示监控指标是否可读、可写。比如`getXXX()`抽象方法，则`XXX`就是监控的指标，`getXXX()`表示`XXX`性能指标可读，`setXXX()`方法表示该监控指标可写
 *  参数和返回类型只能是简单的引用类型（如String）和基本数据类型，不可以是自定义类型，如果返回值为自定义类型可以选择`MXBean`

###     ###

**线程池简单介绍**

线程池是线程的管理工具，通过使用线程池可以复用线程降低资源消耗、提高响应速度、提高线程的可管理性。如果在系统中大量使用线程池，就必须对线程池进行监控方便出错时定位问题。可以通过线程池提供的参数进行监控，线程池提供的参数如下：

<table> 
 <thead> 
  <tr> 
   <td>方法</td> 
   <td>含义</td> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><p>getActiveCount</p></td> 
   <td><p>线程池中正在执行任务的线程数量</p></td> 
  </tr> 
  <tr> 
   <td><p>getCompletedTaskCount</p></td> 
   <td><p>线程池已完成的任务数量</p></td> 
  </tr> 
  <tr> 
   <td><p>getCorePoolSize</p></td> 
   <td><p>线程池的核心线程数量</p></td> 
  </tr> 
  <tr> 
   <td><p>getLargestPoolSize</p></td> 
   <td><p>线程池曾经创建过的最大线程数量</p></td> 
  </tr> 
  <tr> 
   <td><p>getMaximumPoolSize</p></td> 
   <td><p>线程池的最大线程数量</p></td> 
  </tr> 
  <tr> 
   <td><p>getPoolSize</p></td> 
   <td><p>线程池当前的线程数量</p></td> 
  </tr> 
  <tr> 
   <td><p>getTaskCount</p></td> 
   <td><p>线程池需要执行的任务数量</p></td> 
  </tr> 
 </tbody> 
</table>

###     ###

**应用**

介绍完`JMX`及线程池以后，写一个`JMX`监控线程池的`Demo`，总不能纸上谈兵吧

public class ThreadPoolMonitor extends ThreadPoolExecutor {
        private final Logger logger = LoggerFactory.getLogger(getClass());
    
        /**
         * ActiveCount
         * */
        int ac = 0;
    
        /**
         * 当前所有线程消耗的时间
         * */
        private AtomicLong totalCostTime = new AtomicLong();
    
        /**
         * 当前执行的线程总数
         * */
        private AtomicLong totalTasks = new AtomicLong();
    
        /**
         * 线程池名称
         */
        private String poolName;
    
        /**
         * 最短 执行时间
         * */
        private long minCostTime;
    
        /**
         * 最长执行时间
         * */
        private long maxCostTime;
    
    
        /**
         * 保存任务开始执行的时间
         */
        private ThreadLocal<Long> startTime = new ThreadLocal<>();
    
        public ThreadPoolMonitor(int corePoolSize, int maximumPoolSize, long keepAliveTime,
                               TimeUnit unit, BlockingQueue<Runnable> workQueue, String poolName) {
            this(corePoolSize, maximumPoolSize, keepAliveTime, unit, workQueue,
              Executors.defaultThreadFactory(), poolName);
        }
    
        public ThreadPoolMonitor(int corePoolSize, int maximumPoolSize, long keepAliveTime,
                               TimeUnit unit, BlockingQueue<Runnable> workQueue,
                               ThreadFactory threadFactory, String poolName) {
            super(corePoolSize, maximumPoolSize, keepAliveTime, unit, workQueue, threadFactory);
            this.poolName = poolName;
        }
    
        public static ExecutorService newFixedThreadPool(int nThreads, String poolName) {
            return new ThreadPoolMonitor(nThreads, nThreads, 0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<>(), poolName);
        }
    
        public static ExecutorService newCachedThreadPool(String poolName) {
            return new ThreadPoolMonitor(0, Integer.MAX_VALUE, 60L, TimeUnit.SECONDS, new SynchronousQueue<>(), poolName);
        }
    
        public static ExecutorService newSingleThreadExecutor(String poolName) {
            return new ThreadPoolMonitor(1, 1, 0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<>(), poolName);
        }
    
        /**
         * 线程池延迟关闭时（等待线程池里的任务都执行完毕），统计线程池情况
         */
        @Override
        public void shutdown() {
            // 统计已执行任务、正在执行任务、未执行任务数量
            logger.info("{} Going to shutdown. Executed tasks: {}, Running tasks: {}, Pending tasks: {}",
              this.poolName, this.getCompletedTaskCount(), this.getActiveCount(), this.getQueue().size());
            super.shutdown();
        }
    
        @Override
        public List<Runnable> shutdownNow() {
            // 统计已执行任务、正在执行任务、未执行任务数量
            logger.info("{} Going to immediately shutdown. Executed tasks: {}, Running tasks: {}, Pending tasks: {}",
              this.poolName, this.getCompletedTaskCount(), this.getActiveCount(), this.getQueue().size());
            return super.shutdownNow();
        }
    
        /**
         * 任务执行之前，记录任务开始时间
         */
        @Override
        protected void beforeExecute(Thread t, Runnable r) {
            startTime.set(System.currentTimeMillis());
        }
    
        /**
         * 任务执行之后，计算任务结束时间
         */
        @Override
        protected void afterExecute(Runnable r, Throwable t) {
            long costTime = System.currentTimeMillis() - startTime.get();
            startTime.remove();  //删除，避免占用太多内存
            //设置最大最小执行时间
            maxCostTime = maxCostTime > costTime ? maxCostTime : costTime;
            if (totalTasks.get() == 0) {
                minCostTime = costTime;
            }
            minCostTime = minCostTime < costTime ? minCostTime : costTime;
            totalCostTime.addAndGet(costTime);
            totalTasks.incrementAndGet();
    
            logger.info("{}-pool-monitor: " +
                          "Duration: {} ms, PoolSize: {}, CorePoolSize: {}, ActiveCount: {}, " +
                          "Completed: {}, Task: {}, Queue: {}, LargestPoolSize: {}, " +
                          "MaximumPoolSize: {},  KeepAliveTime: {}, isShutdown: {}, isTerminated: {}",
                    this.poolName,
                    costTime, this.getPoolSize(), this.getCorePoolSize(), super.getActiveCount(),
                    this.getCompletedTaskCount(), this.getTaskCount(), this.getQueue().size(), this.getLargestPoolSize(),
                    this.getMaximumPoolSize(), this.getKeepAliveTime(TimeUnit.MILLISECONDS), this.isShutdown(), this.isTerminated());
        }
    
        public int getAc() {
            return ac;
        }
    
        /**
         * 线程平均耗时
         *
         * @return
         * */
        public float getAverageCostTime() {
            return totalCostTime.get() / totalTasks.get();
        }
    
        /**
         * 线程最大耗时
         * */
        public long getMaxCostTime() {
            return maxCostTime;
        }
    
        /**
         * 线程最小耗时
         * */
        public long getMinCostTime() {
            return minCostTime;
        }
    
        /**
         * 生成线程池所用的线程，改写了线程池默认的线程工厂
         */
        static class EventThreadFactory implements ThreadFactory {
            private static final AtomicInteger poolNumber = new AtomicInteger(1);
            private final ThreadGroup group;
            private final AtomicInteger threadNumber = new AtomicInteger(1);
            private final String namePrefix;
    
            /**
             * 初始化线程工厂
             *
             * @param poolName 线程池名称
             */
            EventThreadFactory(String poolName) {
                SecurityManager s = System.getSecurityManager();
                group = Objects.nonNull(s) ? s.getThreadGroup() :   Thread.currentThread().getThreadGroup();
                namePrefix = poolName + "-pool-" + poolNumber.getAndIncrement() + "-thread-";
            }
    
            @Override
            public Thread newThread(Runnable r) {
                Thread t = new Thread(group, r, namePrefix + threadNumber.getAndIncrement(), 0);
                if (t.isDaemon())
                    t.setDaemon(false);
                if (t.getPriority() != Thread.NORM_PRIORITY)
                    t.setPriority(Thread.NORM_PRIORITY);
                return t;
            }
        }
    }

通过继承线程池来自定义线程池，并在构造函数中加入了`poolName`标明是哪一个线程池，同时重写了`beforeExecute`、`afterExecute`、`terminated`等方法，在`beforeExecute`方法中记录线程池执行的时间，在`afterExecute`方法中计算线程执行的耗时、最大耗时、最小耗时、平均耗时。重写线程池生成线程的方法，指定了生成的线程名

*  定义一个`MBean`：`ThreadPoolParamMBean.java`  
    `MBean`其实并不是一个实体类而是一个接口，里面定义了监控的指标

public interface ThreadPoolParamMBean {
        /**
         * 线程池中正在执行任务的线程数量
         *
         * @return
         */
        int getActiveCount();
    
        /**
         * 线程池已完成的任务数量
         *
         * @return
         */
        long getCompletedTaskCount();
    
        /**
         * 线程池的核心线程数量
         *
         * @return
         */
        int getCorePoolSize();
    
        /**
         * 线程池曾经创建过的最大线程数量
         *
         * @return
         */
        int getLargestPoolSize();
    
        /**
         * 线程池的最大线程数量
         *
         * @return
         */
        int getMaximumPoolSize();
    
        /**
         * 线程池当前的线程数量
         *
         * @return
         */
        int getPoolSize();
    
        /**
         * 线程池需要执行的任务数量
         *
         * @return
         */
        long getTaskCount();
    
        /**
         * 线程最大耗时
         *
         * @return
         * */
        long getMaxCostTime();
    
        /**
         * 线程最小耗时
         *
         * @return
         * */
        long getMinCostTime();
    
        /**
         * 线程平均耗时
         *
         * @return
         * */
        float getAverageCostTime();
    }

定义一个`MBean`实现类：`ThreadPoolParam.java`

定义的是静态MBean，所以接口实现类必须满足规定，即`xxxMBean`，实现类为`xxx`

public class ThreadPoolParam implements ThreadPoolParamMBean  {
        private ThreadPoolMonitor threadPoolMonitor;
    
        public ThreadPoolParam(ExecutorService es) {
            this.threadPoolMonitor = (ThreadPoolMonitor) es;
        }
    
        /**
         * 线程池中正在执行任务的线程数量
         *
         * @return
         */
        @Override
        public int getActiveCount() {
            return threadPoolMonitor.getAc();
        }
    
        /**
         * 线程池已完成的任务数量
         *
         * @return
         */
        @Override
        public long getCompletedTaskCount() {
            return threadPoolMonitor.getCompletedTaskCount();
        }
    
        /**
         * 线程池的核心线程数量
         *
         * @return
         */
        @Override
        public int getCorePoolSize() {
            return threadPoolMonitor.getCorePoolSize();
        }
    
        /**
         * 线程池曾经创建过的最大线程数量
         *
         * @return
         */
        @Override
        public int getLargestPoolSize() {
            return threadPoolMonitor.getLargestPoolSize();
        }
    
        /**
         * 线程池的最大线程数量
         *
         * @return
         */
        @Override
        public int getMaximumPoolSize() {
            return threadPoolMonitor.getMaximumPoolSize();
        }
    
        /**
         * 线程池当前的线程数量
         *
         * @return
         */
        @Override
        public int getPoolSize() {
            return threadPoolMonitor.getPoolSize();
        }
    
        /**
         * 线程池需要执行的任务数量
         *
         * @return
         */
        @Override
        public long getTaskCount() {
            return threadPoolMonitor.getTaskCount();
        }
    
        /**
         * 线程最大耗时
         *
         * @return
         * */
        @Override
        public long getMaxCostTime() {
            return threadPoolMonitor.getMaxCostTime();
        }
    
        /**
         * 线程最小耗时
         *
         * @return
         * */
        @Override
        public long getMinCostTime() {
            return threadPoolMonitor.getMinCostTime();
        }
    
        /**
         * 线程平均耗时
         *
         * @return
         * */
        @Override
        public float getAverageCostTime() {
            return threadPoolMonitor.getAverageCostTime();
        }
    }

*  监控的参数指标通过线程池得到
 *  测试类：`Test.java`

public class Test {
        private static Random random = new Random();
        public static void main(String[] args) throws MalformedObjectNameException,  InterruptedException {
            ExecutorService es1 = ThreadPoolMonitor.newCachedThreadPool("test-pool-1");
            ThreadPoolParam threadPoolParam1 = new ThreadPoolParam(es1);
    
            ExecutorService es2 = ThreadPoolMonitor.newCachedThreadPool("test-pool-2");
            ThreadPoolParam threadPoolParam2 = new ThreadPoolParam(es2);
    
            MBeanServerUtil.registerMBean(threadPoolParam1, new ObjectName("test-pool-1:type=threadPoolParam"));
            MBeanServerUtil.registerMBean(threadPoolParam2, new ObjectName("test-pool-2:type=threadPoolParam"));
    
            //http连接的方式查看监控任务
            HtmlAdaptor.start();
    
            executeTask(es1);
            executeTask(es2);
            Thread.sleep(1000 * 60 * 60);
        }
    
        private static void executeTask(ExecutorService es) {
            new Thread(() -> {
                for (int i = 0; i < 10; i++) {
                    int temp = i;
                    es.submit(() -> {
                        //随机睡眠时间
                        try {
                            Thread.sleep(random.nextInt(60) * 1000);
                        } catch (InterruptedException e) {
                            e.printStackTrace();
                        }
                        System.out.println(temp);
                    });
                }
            }).start();
        }
    }

*  说明：
    
    启动程序后打开`http://localhost:8082/`如下图：  
    
    
    ![format_png 4][]
    
    image.png
 *   *  `MBeanServerUtil.registerMBean()`注册监控的类
     *  `HtmlAdaptor.start()`开启`HTTP`连接的方式查看监控任务

点击`test-pool-1`下的`type=threadPoolParam`

![format_png 5][]

通过刷新获取线程池最新的监控指标  
`test-pool-1`和`type=threadPoolParam`这些属性是在`ObjectName`中定义的属性值

有你想看的精彩

[LOL钓鱼网站实战渗透][LOL]  
[边缘计算  一文简单读懂][Link 1]  
[Tomcat是如何运行的？整体架构又是怎样的？][Tomcat]

[支持百亿级别的 Java 分布式日志组件EasyLog][Java _EasyLog]

![format_png 6][]

![format_png 7][]

戳这儿

[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2dpZi9iOTZDaWJDdDcwaWFhcjlYMW1mb2szUmlhNVhSMjhxMDhzSEx2UEdRUVNKYzlySUtTUTVIdTRIU1VlR3h1eHpWU1ZlM2lhcVNHdUhhMzZIUklpYkVSZFowUnBBLzY0MA?x-oss-process=image/format,png
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2dpZi94aWNXWVRTSUN6UnRvTEpJeGUyVlhuU3d0OXJRWHRNOUVMbmNvWVVGQ1NqU3BIMzdBT2NnaWFrd3VBZWFxWXdVV0U0OVZpYW9oWTE4d3RHVklqRkVmZU5XUS82NDA?x-oss-process=image/format,png
[format_png 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2pwZy94aWNXWVRTSUN6UnRvTEpJeGUyVlhuU3d0OXJRWHRNOUV2ckNyZlB1UGc3Y2lhNFNxMzNsaWFwejBveGQ3TXp0a2ozVmliaWJrSUVOMXUyeGN0clNIcnViMGlhZy82NDA?x-oss-process=image/format,png
[format_png 3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6L3hpY1dZVFNJQ3pSdG9MSkl4ZTJWWG5Td3Q5clFYdE05RWhPN1laQWg5YXRVUWNXU2ZoaWNzSzVpYXY3UmwwWFhUaGlhZ0FiRVUyWUlHbTgwR1hzZnIydWZzUS82NDA?x-oss-process=image/format,png
[format_png 4]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6L3hpY1dZVFNJQ3pSdG9MSkl4ZTJWWG5Td3Q5clFYdE05RWs1ZkxWeHJMa2owaWJHNHhpYWdhYlBFdVdIOTFkdG9KS1c2TTI4aWNVVThGYlFTaWJoMGQwN0ttcEEvNjQw?x-oss-process=image/format,png
[format_png 5]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6L3hpY1dZVFNJQ3pSdG9MSkl4ZTJWWG5Td3Q5clFYdE05RWdoeU9UUlJ6Y1JteXhMT1poYWhRclFVSUxhSnFEbFQyYzBYQ3ZOOWZDY2lidFM3YzlGMG5pYlR3LzY0MA?x-oss-process=image/format,png
[LOL]: https://blog.csdn.net/u012811805/article/details/107133330
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44f274cb337b62cc7edea14329c91d78603bb89f88ea3347ae4cecc6551145cf5fe4bf87dd&idx=1&mid=2247485261&scene=21&sn=925f195372cfe5102198bd007c7ec932#wechat_redirect
[Tomcat]: https://blog.csdn.net/u012811805/article/details/106561816
[Java _EasyLog]: https://blog.csdn.net/u012811805/article/details/106485531
[format_png 6]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy94aWNXWVRTSUN6UnZ6aGRLck1pY1NQSWliZzhQRWJPa2E4bmpjOHJFZmFLa09YTHAyd21wckxpY0JRaWNYMWlhdVFzWEdTTDlpYXhreFZTb3RQQ2F2U2hva1NvVHcvNjQw?x-oss-process=image/format,png
[format_png 7]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2dpZi9HR1RyME9hWmYyWHNUMnFVYkVsaWJCT1Z6dDJpYWpPMndQQkZjUlN2bkJOaWF0MXJtRUF4c1hDMWljdUdKZ1RSdHJKNTJhbTJ3azVxNlNXdGVmOEtOSEFvR2cvNjQw?x-oss-process=image/format,png