docs/1.3/api/metrics/index.html - gerrit/www.eclipse.org/hono - Git at Google

 <!DOCTYPE html>
 <html lang="1.3" class="js csstransforms3d">
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="Hugo 0.81.0" />
     <meta name="description" content="A set of micro-services for connecting millions of devices.">
 <meta name="author" content="The Eclipse Hono Project">

     <link rel="apple-touch-icon" sizes="180x180" href="/hono/docs/favicon/apple-touch-icon.png">
 <link rel="icon" type="image/png" sizes="48x48" href="/hono/docs/favicon/favicon-48x48.png">
 <link rel="icon" type="image/png" sizes="32x32" href="/hono/docs/favicon/favicon-32x32.png">
 <link rel="icon" type="image/png" sizes="16x16" href="/hono/docs/favicon/favicon-16x16.png">
 <link rel="manifest" href="/hono/docs/favicon/site.webmanifest">
 <link rel="mask-icon" href="/hono/docs/favicon/safari-pinned-tab.svg" color="#5bbad5">
 <link rel="shortcut icon" href="/hono/docs/favicon/favicon.ico">
 <meta name="msapplication-TileColor" content="#da532c">
 <meta name="msapplication-config" content="/hono/docs/favicon/browserconfig.xml">
 <meta name="theme-color" content="#ffffff">

     <title>Metrics :: Eclipse Hono&trade; Vers.: 1.3</title>


     <link href="/hono/docs/css/nucleus.css?1627002747" rel="stylesheet">
     <link href="/hono/docs/css/fontawesome-all.min.css?1627002747" rel="stylesheet">
     <link href="/hono/docs/css/hybrid.css?1627002747" rel="stylesheet">
     <link href="/hono/docs/css/featherlight.min.css?1627002747" rel="stylesheet">
     <link href="/hono/docs/css/perfect-scrollbar.min.css?1627002747" rel="stylesheet">
     <link href="/hono/docs/css/auto-complete.css?1627002747" rel="stylesheet">
     <link href="/hono/docs/css/atom-one-dark-reasonable.css?1627002747" rel="stylesheet">
     <link href="/hono/docs/css/theme.css?1627002747" rel="stylesheet">
     <link href="/hono/docs/css/hugo-theme.css?1627002747" rel="stylesheet">

     <link href="/hono/docs/css/theme-hono.css?1627002747" rel="stylesheet">

     <link href="/hono/docs/css/hono.css?1627002747" rel="stylesheet">

     <script src="/hono/docs/js/jquery-3.3.1.min.js?1627002747"></script>

     <style>
       :root #header + #content > #left > #rlblock_left{
           display:none !important;
       }

         :not(pre) > code + span.copy-to-clipboard {
             display: none;
         }

     </style>

 <link rel="stylesheet" href="https://www.eclipse.org/eclipse.org-common/themes/solstice/public/stylesheets/vendor/cookieconsent/cookieconsent.min.css">


 <meta name="twitter:card" content="summary_large_image">
 <meta name="twitter:site" content="@EclipseHono">
 <meta name="twitter:title" content="Metrics :: Eclipse Hono&amp;trade; Vers.: 1.3">
 <meta name="twitter:image" content="https://www.eclipse.org/hono/docs/images/twitter_image.png">
 <meta name="twitter:description" content="A set of micro-services for connecting millions of devices.">


 <meta property="og:title" content="Metrics :: Eclipse Hono&amp;trade; Vers.: 1.3" />
 <meta property="og:type" content="website" />
 <meta property="og:url" content="https://www.eclipse.org/hono/docs/1.3/api/metrics//" />
 <meta property="og:image" content="https://www.eclipse.org/hono/docs/images/twitter_image.png" />

   </head>
   <body class="" data-url="/hono/docs/1.3/api/metrics/">
     <nav id="sidebar" class="">


   <div id="header-wrapper">
     <div id="header">
       <a href="https://www.eclipse.org/hono/">
     <img src="/hono/docs/images/HONO-Logo_Bild-Wort_quer-w-310x120px.svg" alt="Hono logo" class="logo-img">
 </a>

     </div>

         <div class="searchbox">
     <label for="search-by"><i class="fas fa-search"></i></label>
     <input data-search-input id="search-by" type="search" placeholder="Search...">
     <span data-search-clear=""><i class="fas fa-times"></i></span>
 </div>

 <script type="text/javascript" src="/hono/docs/js/lunr.min.js?1627002747"></script>
 <script type="text/javascript" src="/hono/docs/js/auto-complete.js?1627002747"></script>
 <script type="text/javascript">

         var baseurl = "https:\/\/www.eclipse.org\/hono\/docs\/\/1.3";

 </script>
 <script type="text/javascript" src="/hono/docs/js/search.js?1627002747"></script>


   </div>

     <div class="highlightable">
     <ul class="topics">


     <li data-nav-id="/hono/docs/1.3/concepts/" title="Concepts" class="dd-item


         ">
       <a href="/hono/docs/1.3/concepts/">
           <i class="far fa-lightbulb"></i> Concepts

       </a>


         <ul>


       <li data-nav-id="/hono/docs/1.3/concepts/device-identity/" title="Device Identity" class="dd-item ">
         <a href="/hono/docs/1.3/concepts/device-identity/">
         Device Identity

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/concepts/tenancy/" title="Multi-Tenancy" class="dd-item ">
         <a href="/hono/docs/1.3/concepts/tenancy/">
         Multi-Tenancy

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/concepts/device-provisioning/" title="Device Provisioning" class="dd-item ">
         <a href="/hono/docs/1.3/concepts/device-provisioning/">
         Device Provisioning

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/concepts/connecting-devices/" title="Connecting Devices" class="dd-item ">
         <a href="/hono/docs/1.3/concepts/connecting-devices/">
         Connecting Devices

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/concepts/device-notifications/" title="Device Notifications" class="dd-item ">
         <a href="/hono/docs/1.3/concepts/device-notifications/">
         Device Notifications

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/concepts/command-and-control/" title="Command &amp; Control" class="dd-item ">
         <a href="/hono/docs/1.3/concepts/command-and-control/">
         Command &amp; Control

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/concepts/resource-limits/" title="Resource limits" class="dd-item ">
         <a href="/hono/docs/1.3/concepts/resource-limits/">
         Resource limits

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/concepts/connection-events/" title="Connection Events" class="dd-item ">
         <a href="/hono/docs/1.3/concepts/connection-events/">
         Connection Events

         </a>
     </li>


         </ul>

     </li>


     <li data-nav-id="/hono/docs/1.3/user-guide/" title="User Guide" class="dd-item


         ">
       <a href="/hono/docs/1.3/user-guide/">
           <i class="fas fa-book-reader"></i> User Guide

       </a>


         <ul>


       <li data-nav-id="/hono/docs/1.3/user-guide/mongodb-based-device-registry/" title="MongoDB Based Device Registry" class="dd-item ">
         <a href="/hono/docs/1.3/user-guide/mongodb-based-device-registry/">
         MongoDB Based Device Registry

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/user-guide/file-based-device-registry/" title="File Based Device Registry" class="dd-item ">
         <a href="/hono/docs/1.3/user-guide/file-based-device-registry/">
         File Based Device Registry

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/user-guide/http-adapter/" title="HTTP Adapter" class="dd-item ">
         <a href="/hono/docs/1.3/user-guide/http-adapter/">
         HTTP Adapter

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/user-guide/mqtt-adapter/" title="MQTT Adapter" class="dd-item ">
         <a href="/hono/docs/1.3/user-guide/mqtt-adapter/">
         MQTT Adapter

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/user-guide/amqp-adapter/" title="AMQP Adapter" class="dd-item ">
         <a href="/hono/docs/1.3/user-guide/amqp-adapter/">
         AMQP Adapter

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/user-guide/coap-adapter/" title="CoAP Adapter" class="dd-item ">
         <a href="/hono/docs/1.3/user-guide/coap-adapter/">
         CoAP Adapter

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/user-guide/kura-adapter/" title="Kura Adapter" class="dd-item ">
         <a href="/hono/docs/1.3/user-guide/kura-adapter/">
         Kura Adapter

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/user-guide/sigfox-adapter/" title="Sigfox Adapter" class="dd-item ">
         <a href="/hono/docs/1.3/user-guide/sigfox-adapter/">
         Sigfox Adapter

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/user-guide/jmeter_load_tests/" title="Load Tests with JMeter" class="dd-item ">
         <a href="/hono/docs/1.3/user-guide/jmeter_load_tests/">
         Load Tests with JMeter

         </a>
     </li>


         </ul>

     </li>


     <li data-nav-id="/hono/docs/1.3/admin-guide/" title="Admin Guide" class="dd-item


         ">
       <a href="/hono/docs/1.3/admin-guide/">
           <i class="fas fa-sliders-h"></i> Admin Guide

       </a>


         <ul>


       <li data-nav-id="/hono/docs/1.3/admin-guide/common-config/" title="Common Configuration" class="dd-item ">
         <a href="/hono/docs/1.3/admin-guide/common-config/">
         Common Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/admin-guide/auth-server-config/" title="Auth Server Configuration" class="dd-item ">
         <a href="/hono/docs/1.3/admin-guide/auth-server-config/">
         Auth Server Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/admin-guide/mongodb-device-registry-config/" title="MongoDB Based Device Registry Configuration" class="dd-item ">
         <a href="/hono/docs/1.3/admin-guide/mongodb-device-registry-config/">
         MongoDB Based Device Registry Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/admin-guide/file-based-device-registry-config/" title="File Based Device Registry Configuration" class="dd-item ">
         <a href="/hono/docs/1.3/admin-guide/file-based-device-registry-config/">
         File Based Device Registry Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/admin-guide/device-connection-config/" title="Configuring the Device Connection Service" class="dd-item ">
         <a href="/hono/docs/1.3/admin-guide/device-connection-config/">
         Device Connection Service Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/admin-guide/http-adapter-config/" title="HTTP Adapter Configuration" class="dd-item ">
         <a href="/hono/docs/1.3/admin-guide/http-adapter-config/">
         HTTP Adapter Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/admin-guide/mqtt-adapter-config/" title="MQTT Adapter Configuration" class="dd-item ">
         <a href="/hono/docs/1.3/admin-guide/mqtt-adapter-config/">
         MQTT Adapter Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/admin-guide/amqp-adapter-config/" title="AMQP Adapter Configuration" class="dd-item ">
         <a href="/hono/docs/1.3/admin-guide/amqp-adapter-config/">
         AMQP Adapter Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/admin-guide/coap-adapter-config/" title="CoAP Adapter Configuration" class="dd-item ">
         <a href="/hono/docs/1.3/admin-guide/coap-adapter-config/">
         CoAP Adapter Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/admin-guide/kura-adapter-config/" title="Kura Adapter Configuration" class="dd-item ">
         <a href="/hono/docs/1.3/admin-guide/kura-adapter-config/">
         Kura Adapter Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/admin-guide/hono-client-configuration/" title="Hono Client Configuration" class="dd-item ">
         <a href="/hono/docs/1.3/admin-guide/hono-client-configuration/">
         Hono Client Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/admin-guide/amqp-network-config/" title="AMQP 1.0 Messaging Network Configuration" class="dd-item ">
         <a href="/hono/docs/1.3/admin-guide/amqp-network-config/">
         AMQP 1.0 Messaging Network Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/admin-guide/secure_communication/" title="Secure Communication" class="dd-item ">
         <a href="/hono/docs/1.3/admin-guide/secure_communication/">
         Secure Communication

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/admin-guide/monitoring-tracing-config/" title="Monitoring &amp; Tracing" class="dd-item ">
         <a href="/hono/docs/1.3/admin-guide/monitoring-tracing-config/">
         Monitoring &amp; Tracing

         </a>
     </li>


         </ul>

     </li>


     <li data-nav-id="/hono/docs/1.3/dev-guide/" title="Developer Guide" class="dd-item


         ">
       <a href="/hono/docs/1.3/dev-guide/">
           <i class="fas fa-tools"></i> Developer Guide

       </a>


         <ul>


       <li data-nav-id="/hono/docs/1.3/dev-guide/building_hono/" title="Building from Source" class="dd-item ">
         <a href="/hono/docs/1.3/dev-guide/building_hono/">
         Building from Source

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/dev-guide/amqp_adapter_client/" title="AMQP Adapter Client for Java" class="dd-item ">
         <a href="/hono/docs/1.3/dev-guide/amqp_adapter_client/">
         AMQP Adapter Client for Java

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/dev-guide/java_client_consumer/" title="Consuming Messages from Java" class="dd-item ">
         <a href="/hono/docs/1.3/dev-guide/java_client_consumer/">
         Consuming Messages from Java

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/dev-guide/custom_http_adapter/" title="Implement a Custom Hono HTTP Protocol Adapter" class="dd-item ">
         <a href="/hono/docs/1.3/dev-guide/custom_http_adapter/">
         Implement a Custom Hono HTTP Protocol Adapter

         </a>
     </li>


         </ul>

     </li>


     <li data-nav-id="/hono/docs/1.3/api/" title="API" class="dd-item
         parent


         ">
       <a href="/hono/docs/1.3/api/">
           &nbsp;<i class='fas fa-plug'></i>&nbsp;API

       </a>


         <ul>


       <li data-nav-id="/hono/docs/1.3/api/telemetry/" title="Telemetry API Specification" class="dd-item ">
         <a href="/hono/docs/1.3/api/telemetry/">
         Telemetry API

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/api/event/" title="Event API Specification" class="dd-item ">
         <a href="/hono/docs/1.3/api/event/">
         Event API

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/api/command-and-control/" title="Command &amp; Control API Specification" class="dd-item ">
         <a href="/hono/docs/1.3/api/command-and-control/">
         Command &amp; Control API

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/api/tenant/" title="Tenant API Specification" class="dd-item ">
         <a href="/hono/docs/1.3/api/tenant/">
         Tenant API

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/api/device-connection/" title="Device Connection API Specification" class="dd-item ">
         <a href="/hono/docs/1.3/api/device-connection/">
         Device Connection API

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/api/device-registration/" title="Device Registration API Specification" class="dd-item ">
         <a href="/hono/docs/1.3/api/device-registration/">
         Device Registration API

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/api/credentials/" title="Credentials API Specification" class="dd-item ">
         <a href="/hono/docs/1.3/api/credentials/">
         Credentials API

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/api/authentication/" title="Authentication API Specification" class="dd-item ">
         <a href="/hono/docs/1.3/api/authentication/">
         Authentication API

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/api/management/" title="Device Registry Management API Specification" class="dd-item ">
         <a href="/hono/docs/1.3/api/management/">
         Device Registry Management API

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/api/metrics/" title="Metrics" class="dd-item active">
         <a href="/hono/docs/1.3/api/metrics/">
         Metrics

         </a>
     </li>


         </ul>

     </li>


     <li data-nav-id="/hono/docs/1.3/deployment/" title="Deployment" class="dd-item


         ">
       <a href="/hono/docs/1.3/deployment/">
           <i class="fas fa-shipping-fast"></i> Deployment

       </a>


         <ul>


       <li data-nav-id="/hono/docs/1.3/deployment/helm-based-deployment/" title="Helm based Deployment" class="dd-item ">
         <a href="/hono/docs/1.3/deployment/helm-based-deployment/">
         Helm based Deployment

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/deployment/openshift/" title="OpenShift / OKD" class="dd-item ">
         <a href="/hono/docs/1.3/deployment/openshift/">
         OpenShift / OKD

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/deployment/create-kubernetes-cluster/" title="Setting up a Kubernetes Cluster" class="dd-item ">
         <a href="/hono/docs/1.3/deployment/create-kubernetes-cluster/">
         Setting up a Kubernetes Cluster

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/deployment/resource-limitation/" title="Limiting Resource Usage" class="dd-item ">
         <a href="/hono/docs/1.3/deployment/resource-limitation/">
         Limiting Resource Usage

         </a>
     </li>


         </ul>

     </li>


     <li data-nav-id="/hono/docs/1.3/architecture/" title="Architecture" class="dd-item


         ">
       <a href="/hono/docs/1.3/architecture/">
           <i class="fas fa-landmark"></i> Architecture

       </a>


         <ul>


       <li data-nav-id="/hono/docs/1.3/architecture/component-view/" title="Component View" class="dd-item ">
         <a href="/hono/docs/1.3/architecture/component-view/">
         Component View

         </a>
     </li>


       <li data-nav-id="/hono/docs/1.3/architecture/auth/" title="Authentication/Authorization" class="dd-item ">
         <a href="/hono/docs/1.3/architecture/auth/">
         Authentication/Authorization

         </a>
     </li>


         </ul>

     </li>


     </ul>


       <section id="shortcuts">
         <h3></h3>
         <ul>

               <li>
                   <a class="padding" href="https://www.eclipse.org/hono/" title="Hono&#39;s Homepage"><i class='fas fa-home'></i> Hono Home</a>
               </li>

               <li>
                   <a class="padding" href="https://www.eclipse.org/hono/getting-started/" title="Getting started with Eclipse Hono"><i class='fas fa-plane-departure'></i> Getting Started</a>
               </li>

         </ul>
       </section>


     <section id="prefooter">
       <hr/>
       <ul>

         <li>
           <div id="select-box-wrapper">
           <div id="select-box">
           <a class="padding">
             Version:&nbsp;
           <div class="select-style">
             <select id="select-language" onchange="location = this.value;">


                       <option id="stable" value="https://www.eclipse.org/hono/docs/api/metrics/">stable (1.9)</option>


                       <option id="1.9" value="https://www.eclipse.org/hono/docs/1.9/api/metrics/">1.9</option>


                       <option id="1.8" value="https://www.eclipse.org/hono/docs/1.8/api/metrics/">1.8</option>


                       <option id="1.7" value="https://www.eclipse.org/hono/docs/1.7/api/metrics/">1.7</option>


                       <option id="1.6" value="https://www.eclipse.org/hono/docs/1.6/api/metrics/">1.6</option>


                       <option id="1.5" value="https://www.eclipse.org/hono/docs/1.5/api/metrics/">1.5</option>


                       <option id="1.4" value="https://www.eclipse.org/hono/docs/1.4/api/metrics/">1.4</option>


                       <option id="1.3" value="https://www.eclipse.org/hono/docs/1.3/api/metrics/" selected>1.3</option>


                       <option id="1.2" value="https://www.eclipse.org/hono/docs/1.2/api/metrics/">1.2</option>


                       <option id="1.1" value="https://www.eclipse.org/hono/docs/1.1/api/metrics/">1.1</option>


                       <option id="1.0" value="https://www.eclipse.org/hono/docs/1.0/api/metrics/">1.0</option>


                       <option id="dev" value="https://www.eclipse.org/hono/docs/dev/api/metrics/">dev</option>


         </select>
         <svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
           width="255px" height="255px" viewBox="0 0 255 255" style="enable-background:new 0 0 255 255;" xml:space="preserve">
           <g>
             <g id="arrow-drop-down">
               <polygon points="0,63.75 127.5,191.25 255,63.75 		" />
             </g>
           </g>
         </svg>
         </div>
         </a>
         </div>
         </div>
         </li>


       </ul>
     </section>

     <section id="footer">


 <p>&copy; 2021 <a href="https://www.eclipse.org/hono/">The Eclipse Hono Project</a></p>

 <p>
     Documentation built with
     <a href="https://gohugo.io/" target="_blank">Hugo</a>
     using the
     <a href="https://github.com/matcornic/hugo-theme-learn" target="_blank">Learn</a> theme.
 </p>

 <div class="eclipse-logo">
     <a href="https://www.eclipse.org" target="_blank">
         <img src="https://www.eclipse.org/hono/docs/images/eclipse_foundation_logo.svg"/>
     </a>
 </div>

     </section>
   </div>
 </nav>


         <section id="body">
         <div id="overlay"></div>


     <div class="old-version-hint">
         <p>This page refers to version <em>1.3</em>.
             You might want to use the <a href="https://www.eclipse.org/hono/docs/">current stable</a> version.
         </p>
     </div>


         <div class="padding highlightable">

               <div>
                 <div id="top-bar">


                   <div id="top-github-link">
                     <a class="github-link" title='Edit this page' href="https://github.com/eclipse/hono/edit/master/site/documentation/content/api/Metrics.md" target="blank">
                       <i class="fas fa-code-branch"></i>
                       <span id="top-github-link-text">Edit this page</span>
                     </a>
                   </div>


                 <div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
                     <span id="sidebar-toggle-span">
                         <a href="#" id="sidebar-toggle" data-sidebar-toggle="">
                           <i class="fas fa-bars"></i>
                         </a>
                     </span>

                   <span id="toc-menu"><i class="fas fa-list-alt"></i></span>

                   <span class="links">


             <a href='/hono/docs/1.3/'>Documentation</a> > <a href='/hono/docs/1.3/api/'>API</a> > Metrics


                   </span>
                 </div>

                     <div class="progress">
     <div class="wrapper">
 <nav id="TableOfContents">
   <ul>
     <li><a href="#reported-metrics">Reported Metrics</a>
       <ul>
         <li><a href="#common-metrics">Common Metrics</a></li>
         <li><a href="#protocol-adapter-metrics">Protocol Adapter Metrics</a></li>
         <li><a href="#service-metrics">Service Metrics</a></li>
       </ul>
     </li>
   </ul>
 </nav>
     </div>
 </div>


               </div>
             </div>

         <div id="head-tags">

         </div>

         <div id="body-inner">

             <h1>

               Metrics
             </h1>


 <p>Eclipse Hono™&rsquo;s components report several metrics which may be used to gain some insight
 into the running system. For instance, the HTTP adapter reports the number of successfully
 processed telemetry messages. Some of these metrics are considered part of Hono&rsquo;s external
 interface. This section describes the semantics and format of the metrics, how they can be retrieved
 and how to interpret actual values.</p>
 <h2 id="reported-metrics">Reported Metrics</h2>
 <p>Hono uses <a href="https://micrometer.io/">Micrometer</a> in combination with Spring Boot
 to internally collect metrics. Those metrics can be exported to different
 back ends. Please refer to <a href="/hono/docs/1.3/admin-guide/monitoring-tracing-config/#configuring-a-metrics-back-end">Configuring Metrics</a>
 for details.</p>
 <p>The example deployment by default uses <a href="https://prometheus.io/">Prometheus</a> as the metrics back end.</p>
 <p>When deploying to Kubernetes/OpenShift, the metrics reported by Hono may contain
 environment specific tags (like the <em>pod</em> name) which are added by the Prometheus
 scraper. However, those tags are not part of the Hono metrics definition.</p>
 <p>Hono applications may report other metrics in addition to the ones defined here.
 In particular, all components report metrics regarding the JVM&rsquo;s internal state, e.g.
 memory consumption and garbage collection status. Those metrics are not considered
 part of Hono&rsquo;s <em>official</em> metrics definition. However, all those metrics
 will still contain tags as described below.</p>
 <h3 id="common-metrics">Common Metrics</h3>
 <p>Tags for common metrics are:</p>
 <table>
 <thead>
 <tr>
 <th>Tag</th>
 <th>Value</th>
 <th>Description</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td><em>host</em></td>
 <td><em>string</em></td>
 <td>The name of the host that the component reporting the metric is running on</td>
 </tr>
 <tr>
 <td><em>component-type</em></td>
 <td><code>adapter</code>, <code>service</code></td>
 <td>The type of component reporting the metric</td>
 </tr>
 <tr>
 <td><em>component-name</em></td>
 <td><em>string</em></td>
 <td>The name of the component reporting the metric.</td>
 </tr>
 </tbody>
 </table>
 <p>The names of Hono&rsquo;s standard components are as follows:</p>
 <table>
 <thead>
 <tr>
 <th>Component</th>
 <th><em>component-name</em></th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td>Auth Server</td>
 <td><code>hono-auth</code></td>
 </tr>
 <tr>
 <td>Device Registry</td>
 <td><code>hono-registry</code></td>
 </tr>
 <tr>
 <td>AMQP adapter</td>
 <td><code>hono-amqp</code></td>
 </tr>
 <tr>
 <td>CoAP adapter</td>
 <td><code>hono-coap</code></td>
 </tr>
 <tr>
 <td>HTTP adapter</td>
 <td><code>hono-http</code></td>
 </tr>
 <tr>
 <td>Kura adapter</td>
 <td><code>hono-kura-mqtt</code></td>
 </tr>
 <tr>
 <td>MQTT adapter</td>
 <td><code>hono-mqtt</code></td>
 </tr>
 <tr>
 <td>Lora adapter</td>
 <td><code>hono-lora</code></td>
 </tr>
 <tr>
 <td>Sigfox adapter</td>
 <td><code>hono-sigfox</code></td>
 </tr>
 </tbody>
 </table>
 <h3 id="protocol-adapter-metrics">Protocol Adapter Metrics</h3>
 <p>Additional tags for protocol adapters are:</p>
 <table>
 <thead>
 <tr>
 <th>Name</th>
 <th>Value</th>
 <th>Description</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td><em>direction</em></td>
 <td><code>one-way</code>, <code>request</code>, <code>response</code></td>
 <td>The direction in which a Command &amp; Control message is being sent:<br><code>one-way</code> indicates a command sent to a device for which the sending application doesn&rsquo;t expect to receive a response.<br><code>request</code> indicates a command request message sent to a device.<br><code>response</code> indicates a command response received from a device.</td>
 </tr>
 <tr>
 <td><em>qos</em></td>
 <td><code>0</code>, <code>1</code>, <code>unknown</code></td>
 <td>The quality of service used for a telemetry or event message.<br><code>0</code> indicates <em>at most once</em>,<br><code>1</code> indicates <em>at least once</em> and<br> <code>none</code> indicates unknown delivery semantics.</td>
 </tr>
 <tr>
 <td><em>status</em></td>
 <td><code>forwarded</code>, <code>unprocessable</code>, <code>undeliverable</code></td>
 <td>The processing status of a message.<br><code>forwarded</code> indicates that the message has been forwarded to a downstream consumer<br><code>unprocessable</code> indicates that the message has not been processed not forwarded, e.g. because the message was malformed<br><code>undeliverable</code> indicates that the message could not be forwarded, e.g. because there is no downstream consumer or due to an infrastructure problem</td>
 </tr>
 <tr>
 <td><em>tenant</em></td>
 <td><em>string</em></td>
 <td>The identifier of the tenant that the metric is being reported for</td>
 </tr>
 <tr>
 <td><em>ttd</em></td>
 <td><code>command</code>, <code>expired</code>, <code>none</code></td>
 <td>A status indicating the outcome of processing a TTD value contained in a message received from a device.<br><code>command</code> indicates that a command for the device has been included in the response to the device&rsquo;s request for uploading the message.<br><code>expired</code> indicates that a response without a command has been sent to the device.<br><code>none</code> indicates that either no TTD value has been specified by the device or that the protocol adapter does not support it.</td>
 </tr>
 <tr>
 <td><em>type</em></td>
 <td><code>telemetry</code>, <code>event</code></td>
 <td>The type of (downstream) message that the metric is being reported for.</td>
 </tr>
 </tbody>
 </table>
 <p>Metrics provided by the protocol adapters are:</p>
 <table>
 <thead>
 <tr>
 <th>Metric</th>
 <th>Type</th>
 <th>Tags</th>
 <th>Description</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td><em>hono.commands.received</em></td>
 <td>Timer</td>
 <td><em>host</em>, <em>component-type</em>, <em>component-name</em>, <em>tenant</em>, <em>type</em>, <em>status</em>, <em>direction</em></td>
 <td>The time it took to process a message conveying a command or a response to a command.</td>
 </tr>
 <tr>
 <td><em>hono.commands.payload</em></td>
 <td>DistributionSummary</td>
 <td><em>host</em>, <em>component-type</em>, <em>component-name</em>, <em>tenant</em>, <em>type</em>, <em>status</em>, <em>direction</em></td>
 <td>The number of bytes conveyed in the payload of a command message.</td>
 </tr>
 <tr>
 <td><em>hono.connections.authenticated</em></td>
 <td>Gauge</td>
 <td><em>host</em>, <em>component-type</em>, <em>component-name</em>, <em>tenant</em></td>
 <td>Current number of connected, authenticated devices. <br/> <strong>NB</strong> This metric is only supported by protocol adapters that maintain <em>connection state</em> with authenticated devices. In particular, the HTTP adapter does not support this metric.</td>
 </tr>
 <tr>
 <td><em>hono.connections.unauthenticated</em></td>
 <td>Gauge</td>
 <td><em>host</em>, <em>component-type</em>, <em>component-name</em></td>
 <td>Current number of connected, unauthenticated devices. <br/> <strong>NB</strong> This metric is only supported by protocol adapters that maintain <em>connection state</em> with authenticated devices. In particular, the HTTP adapter does not support this metric.</td>
 </tr>
 <tr>
 <td><em>hono.connections.authenticated.duration</em></td>
 <td>Timer</td>
 <td><em>host</em>, <em>component-type</em>, <em>component-name</em>, <em>tenant</em></td>
 <td>The overall amount of time that authenticated devices have been connected to protocol adapters. <br/> <strong>NB</strong> This metric is only supported by protocol adapters that maintain <em>connection state</em> with authenticated devices. In particular, the HTTP adapter does not support this metric.</td>
 </tr>
 <tr>
 <td><em>hono.connections.attempts</em></td>
 <td>Counter</td>
 <td><em>host</em>, <em>component-type</em>, <em>component-name</em>, <em>outcome</em></td>
 <td>The number of connection attempts to protocol adapters. The outcome can be observed by looking the tag <em>outcome</em> which contains the result and the reason. At the moment there&rsquo;s only one possible value: <code>adapter-connection-limit-exceeded</code><br/> <strong>NB</strong> This metric is only supported by protocol adapters that maintain <em>connection state</em> with authenticated devices. In particular, the HTTP adapter does not support this metric.</td>
 </tr>
 <tr>
 <td><em>hono.messages.received</em></td>
 <td>Timer</td>
 <td><em>host</em>, <em>component-type</em>, <em>component-name</em>, <em>tenant</em>, <em>type</em>, <em>status</em>, <em>qos</em>, <em>ttd</em></td>
 <td>The time it took to process a message conveying telemetry data or an event.</td>
 </tr>
 <tr>
 <td><em>hono.messages.payload</em></td>
 <td>DistributionSummary</td>
 <td><em>host</em>, <em>component-type</em>, <em>component-name</em>, <em>tenant</em>, <em>type</em>, <em>status</em></td>
 <td>The number of bytes conveyed in the payload of a telemetry or event message.</td>
 </tr>
 </tbody>
 </table>
 <h4 id="minimum-message-size">Minimum Message Size</h4>
 <p>If a minimum message size is configured for a <a href="/hono/docs/1.3/api/tenant/#tenant-information-format">tenant</a>,
 then the payload size of the telemetry, event and command messages are calculated in accordance with the configured
 value and then reported to the metrics by the AMQP, HTTP and MQTT protocol adapters. If minimum message size is not
 configured for a tenant then the actual message payload size is reported.</p>
 <p>Assume that the minimum message size for a tenant is configured as 4096 bytes (4KB). The payload size of
 an incoming message with size 1KB is calculated as 4KB by the protocol adapters and reported to the metrics system.
 For an incoming message of size 10KB, it is reported as 12KB.</p>
 <h3 id="service-metrics">Service Metrics</h3>
 <p>Hono&rsquo;s service components do not report any metrics at the moment.</p>

 <footer class="footline">

 </footer>


         </div>


       </div>

     <div id="navigation">


     </div>

     </section>

     <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
       <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
     </div>
     <script src="/hono/docs/js/clipboard.min.js?1627002747"></script>
     <script src="/hono/docs/js/perfect-scrollbar.min.js?1627002747"></script>
     <script src="/hono/docs/js/perfect-scrollbar.jquery.min.js?1627002747"></script>
     <script src="/hono/docs/js/jquery.sticky.js?1627002747"></script>
     <script src="/hono/docs/js/featherlight.min.js?1627002747"></script>
     <script src="/hono/docs/js/highlight.pack.js?1627002747"></script>
     <script>hljs.initHighlightingOnLoad();</script>
     <script src="/hono/docs/js/modernizr.custom-3.6.0.js?1627002747"></script>
     <script src="/hono/docs/js/learn.js?1627002747"></script>
     <script src="/hono/docs/js/hugo-learn.js?1627002747"></script>

     <link href="/hono/docs/mermaid/mermaid.css?1627002747" rel="stylesheet" />
     <script src="/hono/docs/mermaid/mermaid.js?1627002747"></script>
     <script>
         mermaid.initialize({ startOnLoad: true });
     </script>


 <script>
     (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
             new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
         j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
         'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
     })(window,document,'script','dataLayer','GTM-5WLCZXC');
 </script>


 <script src="https://www.eclipse.org/eclipse.org-common/themes/solstice/public/javascript/vendor/cookieconsent/default.min.js"></script>

   </body>
 </html>