blob: 8853ce4c64f9c16416b57ae08ba0e5067377115d [file] [log] [blame]
Hono Bot1f51cfc2021-05-21 01:12:32 +00001<!DOCTYPE html>
2<html lang="1.8" class="js csstransforms3d">
3 <head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width, initial-scale=1.0">
6 <meta name="generator" content="Hugo 0.81.0" />
7 <meta name="description" content="A set of micro-services for connecting millions of devices.">
8<meta name="author" content="The Eclipse Hono Project">
9
10 <link rel="apple-touch-icon" sizes="180x180" href="/hono/docs/favicon/apple-touch-icon.png">
11<link rel="icon" type="image/png" sizes="48x48" href="/hono/docs/favicon/favicon-48x48.png">
12<link rel="icon" type="image/png" sizes="32x32" href="/hono/docs/favicon/favicon-32x32.png">
13<link rel="icon" type="image/png" sizes="16x16" href="/hono/docs/favicon/favicon-16x16.png">
14<link rel="manifest" href="/hono/docs/favicon/site.webmanifest">
15<link rel="mask-icon" href="/hono/docs/favicon/safari-pinned-tab.svg" color="#5bbad5">
16<link rel="shortcut icon" href="/hono/docs/favicon/favicon.ico">
17<meta name="msapplication-TileColor" content="#da532c">
18<meta name="msapplication-config" content="/hono/docs/favicon/browserconfig.xml">
19<meta name="theme-color" content="#ffffff">
20
21 <title>Monitoring & Tracing :: Eclipse Hono&trade; Vers.: 1.8</title>
22
23
Hono Bot6cac68b2021-07-16 01:10:29 +000024 <link href="/hono/docs/css/nucleus.css?1626397808" rel="stylesheet">
25 <link href="/hono/docs/css/fontawesome-all.min.css?1626397808" rel="stylesheet">
26 <link href="/hono/docs/css/hybrid.css?1626397808" rel="stylesheet">
27 <link href="/hono/docs/css/featherlight.min.css?1626397808" rel="stylesheet">
28 <link href="/hono/docs/css/perfect-scrollbar.min.css?1626397808" rel="stylesheet">
29 <link href="/hono/docs/css/auto-complete.css?1626397808" rel="stylesheet">
30 <link href="/hono/docs/css/atom-one-dark-reasonable.css?1626397808" rel="stylesheet">
31 <link href="/hono/docs/css/theme.css?1626397808" rel="stylesheet">
32 <link href="/hono/docs/css/hugo-theme.css?1626397808" rel="stylesheet">
Hono Bot1f51cfc2021-05-21 01:12:32 +000033
Hono Bot6cac68b2021-07-16 01:10:29 +000034 <link href="/hono/docs/css/theme-hono.css?1626397808" rel="stylesheet">
Hono Bot1f51cfc2021-05-21 01:12:32 +000035
Hono Bot6cac68b2021-07-16 01:10:29 +000036 <link href="/hono/docs/css/hono.css?1626397808" rel="stylesheet">
Hono Bot1f51cfc2021-05-21 01:12:32 +000037
Hono Bot6cac68b2021-07-16 01:10:29 +000038 <script src="/hono/docs/js/jquery-3.3.1.min.js?1626397808"></script>
Hono Bot1f51cfc2021-05-21 01:12:32 +000039
40 <style>
41 :root #header + #content > #left > #rlblock_left{
42 display:none !important;
43 }
44
45 :not(pre) > code + span.copy-to-clipboard {
46 display: none;
47 }
48
49 </style>
50
51<link rel="stylesheet" href="https://www.eclipse.org/eclipse.org-common/themes/solstice/public/stylesheets/vendor/cookieconsent/cookieconsent.min.css">
52
53
54<meta name="twitter:card" content="summary_large_image">
55<meta name="twitter:site" content="@EclipseHono">
56<meta name="twitter:title" content="Monitoring &amp; Tracing :: Eclipse Hono&amp;trade; Vers.: 1.8">
57<meta name="twitter:image" content="https://www.eclipse.org/hono/docs/images/twitter_image.png">
58<meta name="twitter:description" content="A set of micro-services for connecting millions of devices.">
59
60
61<meta property="og:title" content="Monitoring &amp; Tracing :: Eclipse Hono&amp;trade; Vers.: 1.8" />
62<meta property="og:type" content="website" />
63<meta property="og:url" content="https://www.eclipse.org/hono/docs/1.8/admin-guide/monitoring-tracing-config//" />
64<meta property="og:image" content="https://www.eclipse.org/hono/docs/images/twitter_image.png" />
65
66 </head>
67 <body class="" data-url="/hono/docs/1.8/admin-guide/monitoring-tracing-config/">
68 <nav id="sidebar" class="">
69
70
71
72 <div id="header-wrapper">
73 <div id="header">
74 <a href="https://www.eclipse.org/hono/">
75 <img src="/hono/docs/images/HONO-Logo_Bild-Wort_quer-w-310x120px.svg" alt="Hono logo" class="logo-img">
76</a>
77
78 </div>
79
80 <div class="searchbox">
81 <label for="search-by"><i class="fas fa-search"></i></label>
82 <input data-search-input id="search-by" type="search" placeholder="Search...">
83 <span data-search-clear=""><i class="fas fa-times"></i></span>
84</div>
85
Hono Bot6cac68b2021-07-16 01:10:29 +000086<script type="text/javascript" src="/hono/docs/js/lunr.min.js?1626397808"></script>
87<script type="text/javascript" src="/hono/docs/js/auto-complete.js?1626397808"></script>
Hono Bot1f51cfc2021-05-21 01:12:32 +000088<script type="text/javascript">
89
90 var baseurl = "https:\/\/www.eclipse.org\/hono\/docs\/\/1.8";
91
92</script>
Hono Bot6cac68b2021-07-16 01:10:29 +000093<script type="text/javascript" src="/hono/docs/js/search.js?1626397808"></script>
Hono Bot1f51cfc2021-05-21 01:12:32 +000094
95
96 </div>
97
98 <div class="highlightable">
99 <ul class="topics">
100
101
102
103
104
105
106
107
108
109
110
111 <li data-nav-id="/hono/docs/1.8/concepts/" title="Concepts" class="dd-item
112
113
114
115 ">
116 <a href="/hono/docs/1.8/concepts/">
117 <i class="far fa-lightbulb"></i> Concepts
118
119 </a>
120
121
122 <ul>
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138 <li data-nav-id="/hono/docs/1.8/concepts/device-identity/" title="Device Identity" class="dd-item ">
139 <a href="/hono/docs/1.8/concepts/device-identity/">
140 Device Identity
141
142 </a>
143 </li>
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159 <li data-nav-id="/hono/docs/1.8/concepts/tenancy/" title="Multi-Tenancy" class="dd-item ">
160 <a href="/hono/docs/1.8/concepts/tenancy/">
161 Multi-Tenancy
162
163 </a>
164 </li>
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180 <li data-nav-id="/hono/docs/1.8/concepts/device-provisioning/" title="Device Provisioning" class="dd-item ">
181 <a href="/hono/docs/1.8/concepts/device-provisioning/">
182 Device Provisioning
183
184 </a>
185 </li>
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201 <li data-nav-id="/hono/docs/1.8/concepts/connecting-devices/" title="Connecting Devices" class="dd-item ">
202 <a href="/hono/docs/1.8/concepts/connecting-devices/">
203 Connecting Devices
204
205 </a>
206 </li>
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222 <li data-nav-id="/hono/docs/1.8/concepts/device-notifications/" title="Device Notifications" class="dd-item ">
223 <a href="/hono/docs/1.8/concepts/device-notifications/">
224 Device Notifications
225
226 </a>
227 </li>
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243 <li data-nav-id="/hono/docs/1.8/concepts/command-and-control/" title="Command &amp; Control" class="dd-item ">
244 <a href="/hono/docs/1.8/concepts/command-and-control/">
245 Command &amp; Control
246
247 </a>
248 </li>
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264 <li data-nav-id="/hono/docs/1.8/concepts/resource-limits/" title="Resource limits" class="dd-item ">
265 <a href="/hono/docs/1.8/concepts/resource-limits/">
266 Resource limits
267
268 </a>
269 </li>
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285 <li data-nav-id="/hono/docs/1.8/concepts/connection-events/" title="Connection Events" class="dd-item ">
286 <a href="/hono/docs/1.8/concepts/connection-events/">
287 Connection Events
288
289 </a>
290 </li>
291
292
293
294
295
296
297
298 </ul>
299
300 </li>
301
302
303
304
305
306
307
308
309
310
311
312
313 <li data-nav-id="/hono/docs/1.8/user-guide/" title="User Guide" class="dd-item
314
315
316
317 ">
318 <a href="/hono/docs/1.8/user-guide/">
319 <i class="fas fa-book-reader"></i> User Guide
320
321 </a>
322
323
324 <ul>
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340 <li data-nav-id="/hono/docs/1.8/user-guide/mongodb-based-device-registry/" title="MongoDB Based Device Registry" class="dd-item ">
341 <a href="/hono/docs/1.8/user-guide/mongodb-based-device-registry/">
342 MongoDB Based Device Registry
343
344 </a>
345 </li>
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361 <li data-nav-id="/hono/docs/1.8/user-guide/jdbc-based-device-registry/" title="JDBC Based Device Registry" class="dd-item ">
362 <a href="/hono/docs/1.8/user-guide/jdbc-based-device-registry/">
363 JDBC Based Device Registry
364
365 </a>
366 </li>
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382 <li data-nav-id="/hono/docs/1.8/user-guide/file-based-device-registry/" title="File Based Device Registry" class="dd-item ">
383 <a href="/hono/docs/1.8/user-guide/file-based-device-registry/">
384 File Based Device Registry
385
386 </a>
387 </li>
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403 <li data-nav-id="/hono/docs/1.8/user-guide/http-adapter/" title="HTTP Adapter" class="dd-item ">
404 <a href="/hono/docs/1.8/user-guide/http-adapter/">
405 HTTP Adapter
406
407 </a>
408 </li>
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424 <li data-nav-id="/hono/docs/1.8/user-guide/mqtt-adapter/" title="MQTT Adapter" class="dd-item ">
425 <a href="/hono/docs/1.8/user-guide/mqtt-adapter/">
426 MQTT Adapter
427
428 </a>
429 </li>
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445 <li data-nav-id="/hono/docs/1.8/user-guide/amqp-adapter/" title="AMQP Adapter" class="dd-item ">
446 <a href="/hono/docs/1.8/user-guide/amqp-adapter/">
447 AMQP Adapter
448
449 </a>
450 </li>
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466 <li data-nav-id="/hono/docs/1.8/user-guide/coap-adapter/" title="CoAP Adapter" class="dd-item ">
467 <a href="/hono/docs/1.8/user-guide/coap-adapter/">
468 CoAP Adapter
469
470 </a>
471 </li>
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487 <li data-nav-id="/hono/docs/1.8/user-guide/kura-adapter/" title="Kura Adapter" class="dd-item ">
488 <a href="/hono/docs/1.8/user-guide/kura-adapter/">
489 Kura Adapter
490
491 </a>
492 </li>
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508 <li data-nav-id="/hono/docs/1.8/user-guide/sigfox-adapter/" title="Sigfox Adapter" class="dd-item ">
509 <a href="/hono/docs/1.8/user-guide/sigfox-adapter/">
510 Sigfox Adapter
511
512 </a>
513 </li>
514
515
516
517
518
519
520
521
522
523
524 </ul>
525
526 </li>
527
528
529
530
531
532
533
534
535
536
537
538
539 <li data-nav-id="/hono/docs/1.8/admin-guide/" title="Admin Guide" class="dd-item
540 parent
541
542
543 ">
544 <a href="/hono/docs/1.8/admin-guide/">
545 <i class="fas fa-sliders-h"></i> Admin Guide
546
547 </a>
548
549
550 <ul>
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566 <li data-nav-id="/hono/docs/1.8/admin-guide/common-config/" title="Common Configuration" class="dd-item ">
567 <a href="/hono/docs/1.8/admin-guide/common-config/">
568 Common Configuration
569
570 </a>
571 </li>
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587 <li data-nav-id="/hono/docs/1.8/admin-guide/auth-server-config/" title="Auth Server Configuration" class="dd-item ">
588 <a href="/hono/docs/1.8/admin-guide/auth-server-config/">
589 Auth Server Configuration
590
591 </a>
592 </li>
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608 <li data-nav-id="/hono/docs/1.8/admin-guide/mongodb-device-registry-config/" title="MongoDB Based Device Registry Configuration" class="dd-item ">
609 <a href="/hono/docs/1.8/admin-guide/mongodb-device-registry-config/">
610 MongoDB Based Device Registry Configuration
611
612 </a>
613 </li>
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629 <li data-nav-id="/hono/docs/1.8/admin-guide/jdbc-device-registry-config/" title="JDBC Based Device Registry Configuration" class="dd-item ">
630 <a href="/hono/docs/1.8/admin-guide/jdbc-device-registry-config/">
631 JDBC Based Device Registry Configuration
632
633 </a>
634 </li>
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650 <li data-nav-id="/hono/docs/1.8/admin-guide/file-based-device-registry-config/" title="File Based Device Registry Configuration" class="dd-item ">
651 <a href="/hono/docs/1.8/admin-guide/file-based-device-registry-config/">
652 File Based Device Registry Configuration
653
654 </a>
655 </li>
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671 <li data-nav-id="/hono/docs/1.8/admin-guide/command-router-config/" title="Configuring the Command Router Service" class="dd-item ">
672 <a href="/hono/docs/1.8/admin-guide/command-router-config/">
673 Command Router Service Configuration
674
675 </a>
676 </li>
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692 <li data-nav-id="/hono/docs/1.8/admin-guide/device-connection-config/" title="Configuring the Device Connection Service" class="dd-item ">
693 <a href="/hono/docs/1.8/admin-guide/device-connection-config/">
694 Device Connection Service Configuration
695
696 </a>
697 </li>
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713 <li data-nav-id="/hono/docs/1.8/admin-guide/http-adapter-config/" title="HTTP Adapter Configuration" class="dd-item ">
714 <a href="/hono/docs/1.8/admin-guide/http-adapter-config/">
715 HTTP Adapter Configuration
716
717 </a>
718 </li>
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734 <li data-nav-id="/hono/docs/1.8/admin-guide/mqtt-adapter-config/" title="MQTT Adapter Configuration" class="dd-item ">
735 <a href="/hono/docs/1.8/admin-guide/mqtt-adapter-config/">
736 MQTT Adapter Configuration
737
738 </a>
739 </li>
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755 <li data-nav-id="/hono/docs/1.8/admin-guide/amqp-adapter-config/" title="AMQP Adapter Configuration" class="dd-item ">
756 <a href="/hono/docs/1.8/admin-guide/amqp-adapter-config/">
757 AMQP Adapter Configuration
758
759 </a>
760 </li>
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776 <li data-nav-id="/hono/docs/1.8/admin-guide/coap-adapter-config/" title="CoAP Adapter Configuration" class="dd-item ">
777 <a href="/hono/docs/1.8/admin-guide/coap-adapter-config/">
778 CoAP Adapter Configuration
779
780 </a>
781 </li>
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797 <li data-nav-id="/hono/docs/1.8/admin-guide/kura-adapter-config/" title="Kura Adapter Configuration" class="dd-item ">
798 <a href="/hono/docs/1.8/admin-guide/kura-adapter-config/">
799 Kura Adapter Configuration
800
801 </a>
802 </li>
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818 <li data-nav-id="/hono/docs/1.8/admin-guide/hono-client-configuration/" title="Hono Client Configuration" class="dd-item ">
819 <a href="/hono/docs/1.8/admin-guide/hono-client-configuration/">
820 Hono Client Configuration
821
822 </a>
823 </li>
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839 <li data-nav-id="/hono/docs/1.8/admin-guide/hono-kafka-client-configuration/" title="Hono Kafka Client Configuration" class="dd-item ">
840 <a href="/hono/docs/1.8/admin-guide/hono-kafka-client-configuration/">
841 Hono Kafka Client Configuration
842
843 </a>
844 </li>
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860 <li data-nav-id="/hono/docs/1.8/admin-guide/amqp-network-config/" title="AMQP 1.0 Messaging Network Configuration" class="dd-item ">
861 <a href="/hono/docs/1.8/admin-guide/amqp-network-config/">
862 AMQP 1.0 Messaging Network Configuration
863
864 </a>
865 </li>
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881 <li data-nav-id="/hono/docs/1.8/admin-guide/secure_communication/" title="Secure Communication" class="dd-item ">
882 <a href="/hono/docs/1.8/admin-guide/secure_communication/">
883 Secure Communication
884
885 </a>
886 </li>
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902 <li data-nav-id="/hono/docs/1.8/admin-guide/monitoring-tracing-config/" title="Monitoring &amp; Tracing" class="dd-item active">
903 <a href="/hono/docs/1.8/admin-guide/monitoring-tracing-config/">
904 Monitoring &amp; Tracing
905
906 </a>
907 </li>
908
909
910
911
912
913
914
915
916
917
918 </ul>
919
920 </li>
921
922
923
924
925
926
927
928
929
930
931
932
933 <li data-nav-id="/hono/docs/1.8/dev-guide/" title="Developer Guide" class="dd-item
934
935
936
937 ">
938 <a href="/hono/docs/1.8/dev-guide/">
939 <i class="fas fa-tools"></i> Developer Guide
940
941 </a>
942
943
944 <ul>
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960 <li data-nav-id="/hono/docs/1.8/dev-guide/building_hono/" title="Building from Source" class="dd-item ">
961 <a href="/hono/docs/1.8/dev-guide/building_hono/">
962 Building from Source
963
964 </a>
965 </li>
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981 <li data-nav-id="/hono/docs/1.8/dev-guide/amqp_adapter_client/" title="AMQP Adapter Client for Java" class="dd-item ">
982 <a href="/hono/docs/1.8/dev-guide/amqp_adapter_client/">
983 AMQP Adapter Client for Java
984
985 </a>
986 </li>
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002 <li data-nav-id="/hono/docs/1.8/dev-guide/java_client_consumer/" title="Consuming Messages from Java" class="dd-item ">
1003 <a href="/hono/docs/1.8/dev-guide/java_client_consumer/">
1004 Consuming Messages from Java
1005
1006 </a>
1007 </li>
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023 <li data-nav-id="/hono/docs/1.8/dev-guide/custom_http_adapter/" title="Implement a Custom Hono HTTP Protocol Adapter" class="dd-item ">
1024 <a href="/hono/docs/1.8/dev-guide/custom_http_adapter/">
1025 Implement a Custom Hono HTTP Protocol Adapter
1026
1027 </a>
1028 </li>
1029
1030
1031
1032
1033
1034
1035
1036 </ul>
1037
1038 </li>
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051 <li data-nav-id="/hono/docs/1.8/api/" title="API" class="dd-item
1052
1053
1054
1055 ">
1056 <a href="/hono/docs/1.8/api/">
1057 &nbsp;<i class='fas fa-plug'></i>&nbsp;API
1058
1059 </a>
1060
1061
1062 <ul>
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078 <li data-nav-id="/hono/docs/1.8/api/telemetry/" title="Telemetry API Specification" class="dd-item ">
1079 <a href="/hono/docs/1.8/api/telemetry/">
1080 Telemetry API
1081
1082 </a>
1083 </li>
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099 <li data-nav-id="/hono/docs/1.8/api/event/" title="Event API Specification" class="dd-item ">
1100 <a href="/hono/docs/1.8/api/event/">
1101 Event API
1102
1103 </a>
1104 </li>
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120 <li data-nav-id="/hono/docs/1.8/api/command-and-control/" title="Command &amp; Control API Specification" class="dd-item ">
1121 <a href="/hono/docs/1.8/api/command-and-control/">
1122 Command &amp; Control API
1123
1124 </a>
1125 </li>
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141 <li data-nav-id="/hono/docs/1.8/api/kafka-api/" title="Kafka-based APIs" class="dd-item ">
1142 <a href="/hono/docs/1.8/api/kafka-api/">
1143 Kafka-based APIs
1144
1145 </a>
1146 </li>
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162 <li data-nav-id="/hono/docs/1.8/api/telemetry-kafka/" title="Telemetry API for Kafka Specification" class="dd-item ">
1163 <a href="/hono/docs/1.8/api/telemetry-kafka/">
1164 Telemetry API for Kafka
1165
1166 </a>
1167 </li>
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183 <li data-nav-id="/hono/docs/1.8/api/event-kafka/" title="Event API for Kafka Specification" class="dd-item ">
1184 <a href="/hono/docs/1.8/api/event-kafka/">
1185 Event API for Kafka
1186
1187 </a>
1188 </li>
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204 <li data-nav-id="/hono/docs/1.8/api/command-and-control-kafka/" title="Command &amp; Control API for Kafka Specification" class="dd-item ">
1205 <a href="/hono/docs/1.8/api/command-and-control-kafka/">
1206 Command &amp; Control API for Kafka
1207
1208 </a>
1209 </li>
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225 <li data-nav-id="/hono/docs/1.8/api/tenant/" title="Tenant API Specification" class="dd-item ">
1226 <a href="/hono/docs/1.8/api/tenant/">
1227 Tenant API
1228
1229 </a>
1230 </li>
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246 <li data-nav-id="/hono/docs/1.8/api/command-router/" title="Command Router API Specification" class="dd-item ">
1247 <a href="/hono/docs/1.8/api/command-router/">
1248 Command Router API
1249
1250 </a>
1251 </li>
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267 <li data-nav-id="/hono/docs/1.8/api/device-connection/" title="Device Connection API Specification" class="dd-item ">
1268 <a href="/hono/docs/1.8/api/device-connection/">
1269 Device Connection API
1270
1271 </a>
1272 </li>
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288 <li data-nav-id="/hono/docs/1.8/api/device-registration/" title="Device Registration API Specification" class="dd-item ">
1289 <a href="/hono/docs/1.8/api/device-registration/">
1290 Device Registration API
1291
1292 </a>
1293 </li>
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309 <li data-nav-id="/hono/docs/1.8/api/credentials/" title="Credentials API Specification" class="dd-item ">
1310 <a href="/hono/docs/1.8/api/credentials/">
1311 Credentials API
1312
1313 </a>
1314 </li>
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330 <li data-nav-id="/hono/docs/1.8/api/authentication/" title="Authentication API Specification" class="dd-item ">
1331 <a href="/hono/docs/1.8/api/authentication/">
1332 Authentication API
1333
1334 </a>
1335 </li>
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351 <li data-nav-id="/hono/docs/1.8/api/management/" title="Device Registry Management API Specification" class="dd-item ">
1352 <a href="/hono/docs/1.8/api/management/">
1353 Device Registry Management API
1354
1355 </a>
1356 </li>
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372 <li data-nav-id="/hono/docs/1.8/api/metrics/" title="Metrics" class="dd-item ">
1373 <a href="/hono/docs/1.8/api/metrics/">
1374 Metrics
1375
1376 </a>
1377 </li>
1378
1379
1380
1381
1382
1383
1384
1385 </ul>
1386
1387 </li>
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400 <li data-nav-id="/hono/docs/1.8/deployment/" title="Deployment" class="dd-item
1401
1402
1403
1404 ">
1405 <a href="/hono/docs/1.8/deployment/">
1406 <i class="fas fa-shipping-fast"></i> Deployment
1407
1408 </a>
1409
1410
1411 <ul>
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427 <li data-nav-id="/hono/docs/1.8/deployment/helm-based-deployment/" title="Helm based Deployment" class="dd-item ">
1428 <a href="/hono/docs/1.8/deployment/helm-based-deployment/">
1429 Helm based Deployment
1430
1431 </a>
1432 </li>
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448 <li data-nav-id="/hono/docs/1.8/deployment/openshift/" title="OpenShift / OKD" class="dd-item ">
1449 <a href="/hono/docs/1.8/deployment/openshift/">
1450 OpenShift / OKD
1451
1452 </a>
1453 </li>
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469 <li data-nav-id="/hono/docs/1.8/deployment/create-kubernetes-cluster/" title="Setting up a Kubernetes Cluster" class="dd-item ">
1470 <a href="/hono/docs/1.8/deployment/create-kubernetes-cluster/">
1471 Setting up a Kubernetes Cluster
1472
1473 </a>
1474 </li>
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490 <li data-nav-id="/hono/docs/1.8/deployment/resource-limitation/" title="Limiting Resource Usage" class="dd-item ">
1491 <a href="/hono/docs/1.8/deployment/resource-limitation/">
1492 Limiting Resource Usage
1493
1494 </a>
1495 </li>
1496
1497
1498
1499
1500
1501
1502
1503 </ul>
1504
1505 </li>
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518 <li data-nav-id="/hono/docs/1.8/architecture/" title="Architecture" class="dd-item
1519
1520
1521
1522 ">
1523 <a href="/hono/docs/1.8/architecture/">
1524 <i class="fas fa-landmark"></i> Architecture
1525
1526 </a>
1527
1528
1529 <ul>
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545 <li data-nav-id="/hono/docs/1.8/architecture/component-view/" title="Component View" class="dd-item ">
1546 <a href="/hono/docs/1.8/architecture/component-view/">
1547 Component View
1548
1549 </a>
1550 </li>
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566 <li data-nav-id="/hono/docs/1.8/architecture/auth/" title="Authentication/Authorization" class="dd-item ">
1567 <a href="/hono/docs/1.8/architecture/auth/">
1568 Authentication/Authorization
1569
1570 </a>
1571 </li>
1572
1573
1574
1575
1576
1577
1578
1579 </ul>
1580
1581 </li>
1582
1583
1584
1585
1586
1587 </ul>
1588
1589
1590
1591 <section id="shortcuts">
1592 <h3></h3>
1593 <ul>
1594
1595 <li>
1596 <a class="padding" href="https://www.eclipse.org/hono/" title="Hono&#39;s Homepage"><i class='fas fa-home'></i> Hono Home</a>
1597 </li>
1598
1599 <li>
1600 <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>
1601 </li>
1602
1603 </ul>
1604 </section>
1605
1606
1607
1608 <section id="prefooter">
1609 <hr/>
1610 <ul>
1611
1612 <li>
1613 <div id="select-box-wrapper">
1614 <div id="select-box">
1615 <a class="padding">
1616 Version:&nbsp;
1617 <div class="select-style">
1618 <select id="select-language" onchange="location = this.value;">
1619
1620
1621
1622
1623
1624
1625
1626
Hono Bot8fa7d952021-07-14 01:12:12 +00001627 <option id="stable" value="https://www.eclipse.org/hono/docs/admin-guide/monitoring-tracing-config/">stable (1.9)</option>
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661 <option id="1.9" value="https://www.eclipse.org/hono/docs/1.9/admin-guide/monitoring-tracing-config/">1.9</option>
Hono Bot1f51cfc2021-05-21 01:12:32 +00001662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
Hono Bot8fa7d952021-07-14 01:12:12 +00001691
1692
Hono Bot1f51cfc2021-05-21 01:12:32 +00001693
1694
1695 <option id="1.8" value="https://www.eclipse.org/hono/docs/1.8/admin-guide/monitoring-tracing-config/" selected>1.8</option>
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
Hono Bot8fa7d952021-07-14 01:12:12 +00001725
1726
Hono Bot1f51cfc2021-05-21 01:12:32 +00001727
1728
1729 <option id="1.7" value="https://www.eclipse.org/hono/docs/1.7/admin-guide/monitoring-tracing-config/">1.7</option>
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
Hono Bot8fa7d952021-07-14 01:12:12 +00001759
1760
Hono Bot1f51cfc2021-05-21 01:12:32 +00001761
1762
1763 <option id="1.6" value="https://www.eclipse.org/hono/docs/1.6/admin-guide/monitoring-tracing-config/">1.6</option>
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
Hono Bot8fa7d952021-07-14 01:12:12 +00001793
1794
Hono Bot1f51cfc2021-05-21 01:12:32 +00001795
1796
1797 <option id="1.5" value="https://www.eclipse.org/hono/docs/1.5/admin-guide/monitoring-tracing-config/">1.5</option>
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
Hono Bot8fa7d952021-07-14 01:12:12 +00001827
1828
Hono Bot1f51cfc2021-05-21 01:12:32 +00001829
1830
1831 <option id="1.4" value="https://www.eclipse.org/hono/docs/1.4/admin-guide/monitoring-tracing-config/">1.4</option>
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
Hono Bot8fa7d952021-07-14 01:12:12 +00001861
1862
Hono Bot1f51cfc2021-05-21 01:12:32 +00001863
1864
1865 <option id="1.3" value="https://www.eclipse.org/hono/docs/1.3/admin-guide/monitoring-tracing-config/">1.3</option>
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
Hono Bot8fa7d952021-07-14 01:12:12 +00001895
1896
Hono Bot1f51cfc2021-05-21 01:12:32 +00001897
1898
1899 <option id="1.2" value="https://www.eclipse.org/hono/docs/1.2/admin-guide/monitoring-tracing-config/">1.2</option>
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
Hono Bot8fa7d952021-07-14 01:12:12 +00001929
1930
Hono Bot1f51cfc2021-05-21 01:12:32 +00001931
1932
1933 <option id="1.1" value="https://www.eclipse.org/hono/docs/1.1/admin-guide/monitoring-tracing-config/">1.1</option>
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
Hono Bot8fa7d952021-07-14 01:12:12 +00001963
1964
Hono Bot1f51cfc2021-05-21 01:12:32 +00001965
1966
1967 <option id="1.0" value="https://www.eclipse.org/hono/docs/1.0/admin-guide/monitoring-tracing-config/">1.0</option>
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
Hono Bot8fa7d952021-07-14 01:12:12 +00001997
1998
Hono Bot1f51cfc2021-05-21 01:12:32 +00001999
2000
2001 <option id="dev" value="https://www.eclipse.org/hono/docs/dev/admin-guide/monitoring-tracing-config/">dev</option>
2002
2003
2004
2005
2006 </select>
2007 <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"
2008 width="255px" height="255px" viewBox="0 0 255 255" style="enable-background:new 0 0 255 255;" xml:space="preserve">
2009 <g>
2010 <g id="arrow-drop-down">
2011 <polygon points="0,63.75 127.5,191.25 255,63.75 " />
2012 </g>
2013 </g>
2014 </svg>
2015 </div>
2016 </a>
2017 </div>
2018 </div>
2019 </li>
2020
2021
2022
2023 </ul>
2024 </section>
2025
2026 <section id="footer">
2027
2028
2029<p>&copy; 2021 <a href="https://www.eclipse.org/hono/">The Eclipse Hono Project</a></p>
2030
2031<p>
2032 Documentation built with
2033 <a href="https://gohugo.io/" target="_blank">Hugo</a>
2034 using the
2035 <a href="https://github.com/matcornic/hugo-theme-learn" target="_blank">Learn</a> theme.
2036</p>
2037
2038<div class="eclipse-logo">
2039 <a href="https://www.eclipse.org" target="_blank">
2040 <img src="https://www.eclipse.org/hono/docs/images/eclipse_foundation_logo.svg"/>
2041 </a>
2042</div>
2043
2044 </section>
2045 </div>
2046</nav>
2047
2048
2049
2050
2051 <section id="body">
2052 <div id="overlay"></div>
2053
2054
Hono Bot8fa7d952021-07-14 01:12:12 +00002055 <div class="old-version-hint">
2056 <p>This page refers to version <em>1.8</em>.
2057 You might want to use the <a href="https://www.eclipse.org/hono/docs/">current stable</a> version.
2058 </p>
2059 </div>
2060
Hono Bot1f51cfc2021-05-21 01:12:32 +00002061
2062
2063 <div class="padding highlightable">
2064
2065 <div>
2066 <div id="top-bar">
2067
2068
2069
2070
2071 <div id="top-github-link">
2072 <a class="github-link" title='Edit this page' href="https://github.com/eclipse/hono/edit/master/site/documentation/content/admin-guide/monitoring-tracing-config.md" target="blank">
2073 <i class="fas fa-code-branch"></i>
2074 <span id="top-github-link-text">Edit this page</span>
2075 </a>
2076 </div>
2077
2078
2079
2080 <div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
2081 <span id="sidebar-toggle-span">
2082 <a href="#" id="sidebar-toggle" data-sidebar-toggle="">
2083 <i class="fas fa-bars"></i>
2084 </a>
2085 </span>
2086
2087 <span id="toc-menu"><i class="fas fa-list-alt"></i></span>
2088
2089 <span class="links">
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103 <a href='/hono/docs/1.8/'>Documentation</a> > <a href='/hono/docs/1.8/admin-guide/'>Admin Guide</a> > Monitoring & Tracing
2104
2105
2106
2107
2108
2109
2110
2111 </span>
2112 </div>
2113
2114 <div class="progress">
2115 <div class="wrapper">
2116<nav id="TableOfContents">
2117 <ul>
2118 <li><a href="#monitoring">Monitoring</a>
2119 <ul>
2120 <li><a href="#configuring-a-metrics-back-end">Configuring a Metrics Back End</a></li>
2121 <li><a href="#using-prometheus">Using Prometheus</a></li>
2122 </ul>
2123 </li>
2124 <li><a href="#health-check-server-configuration">Health Check Server Configuration</a></li>
2125 <li><a href="#tracing">Tracing</a>
2126 <ul>
2127 <li><a href="#configuring-a-tracer">Configuring a Tracer</a></li>
2128 </ul>
2129 </li>
2130 <li><a href="#configuring-usage-of-jaeger-tracing-included-in-docker-images">Configuring usage of Jaeger tracing (included in Docker images)</a></li>
2131 <li><a href="#enforcing-the-recording-of-traces-for-a-tenant">Enforcing the recording of traces for a tenant</a></li>
2132 </ul>
2133</nav>
2134 </div>
2135</div>
2136
2137
2138 </div>
2139 </div>
2140
2141 <div id="head-tags">
2142
2143 </div>
2144
2145 <div id="body-inner">
2146
2147 <h1>
2148
2149 Monitoring &amp; Tracing
2150 </h1>
2151
2152
2153
2154
2155
2156<p>The individual components of an Eclipse Honoâ„¢ installation need to work together in order to provide their functionality to devices and applications. Under normal circumstances these interactions work flawlessly. However, due to the nature of distributed systems, any one (or more) of the components may crash or become otherwise unavailable due to arbitrary reasons. This page describes how Hono supports operations teams by providing insights into the individual service components and their interactions with each other by means of reporting metrics and tracing the processing of individual messages through the system.</p>
2157<p>When a device uploads telemetry data to the HTTP adapter, the adapter invokes operations on the Device Registration, Credentials and the Tenant services in order to authenticate and authorize the device before sending the telemetry data downstream to the AMQP 1.0 Messaging Network. The overall success of this process and the latency involved before the message reaches the consumer is determined by the individual interactions between the service components.</p>
2158<h2 id="monitoring">Monitoring</h2>
2159<p>In a production environment, an operations team will usually want to keep track of some <em>key performance indicators</em> (KPI) which allow the team to determine the overall <em>health</em> of the system, e.g. memory and CPU consumption etc. Hono supports the tracking of such KPIs by means of metrics it can be configured to report. The metrics are usually collected in a time series database like <em>InfluxDB</em> or <em>Prometheus</em> and then visualized on a monitoring dash-board built using frameworks like <em>Grafana</em>. Such a dash-board can usually also be configured to send alarms when certain thresholds are exceeded.</p>
2160<p>Metrics usually provide insights into the past and current status of an individual component. The values can be aggregated to provide a picture of the overall system&rsquo;s status. As such, metrics provide a great way to <em>monitor</em> system health and, in particular, to anticipate resource shortages and use such knowledge to pro-actively prevent system failure.</p>
2161<h3 id="configuring-a-metrics-back-end">Configuring a Metrics Back End</h3>
2162<p>Hono uses <a href="http://micrometer.io/">Micrometer</a> for providing metrics. It is
2163possible to drop in any Micrometer compatible back end. Hono also uses the
2164Micrometer integration with Spring Boot and Vert.x.</p>
2165<p>Please refer to the <a href="http://micrometer.io/docs">Micrometer documentation</a>
2166for details regarding the configuration of a specific Micrometer back end.
2167In most cases, you only need to add the back end specific jar files to the class path and
2168add back end specific configuration to the <code>application.yml</code> file.</p>
2169<p>The Hono build supports configuration of a specific metrics back end by means
2170of Maven profiles. The following build profiles are currently supported:</p>
2171<ul>
2172<li><code>metrics-prometheus</code> – Enables the Prometheus backend.</li>
2173<li><code>metrics-graphite</code> – Enables the Graphite backend.</li>
2174<li><code>metrics-influxdb</code> – Enables the InfluxDB backend.</li>
2175</ul>
2176<p>Additionally, to selecting a metrics back end, you may need to configure the
2177back end using Spring configuration options. See the documentation mentioned
2178above for more information.</p>
2179<p>Note that none of the above profiles are active by default, i.e. you need to
2180explicitly activate one of them when starting the build using Maven&rsquo;s <code>-p</code>
2181command line parameter.</p>
2182<h3 id="using-prometheus">Using Prometheus</h3>
2183<p>Most of the metrics back ends have data being <em>pushed</em> to from the components
2184reporting the metrics. However, Prometheus is different in that it <em>polls</em>
2185(or <em>scrapes</em>) all components periodically for new metrics data.
2186For this to work, the Prometheus server needs to be configured with the IP
2187addresses of the components to monitor. In the example deployment that comes
2188with Hono, the Prometheus server is configured with the names of the Kubernetes
2189services corresponding to the Hono components that it should scrape.
2190The components themselves need to expose a corresponding HTTP endpoint that
2191the Prometheus server can connect to for scraping the meter data. All
2192Hono components that report metrics can be configured to expose such an
2193endpoint via their <a href="#health-check-server-configuration"><em>Health Check</em> server</a>
2194which already exposes endpoints for determining the component&rsquo;s readiness and liveness status.</p>
2195<h2 id="health-check-server-configuration">Health Check Server Configuration</h2>
2196<p>All of Hono&rsquo;s service components and protocol adapters contain a <em>Health Check</em> server which can be configured to
2197expose several HTTP endpoints for determining the component&rsquo;s status.
2198In particular, the server exposes a <code>/readiness</code>, a <code>/liveness</code> and an optional <code>/prometheus</code> URI endpoint.</p>
2199<p>The former two endpoints are supposed to be used by container orchestration platforms like Kubernetes to monitor the runtime status of the containers
2200that it manages. These endpoints are <em>always</em> exposed when the health check server is started.</p>
2201<p>The <code>/prometheus</code> endpoint can be used by a Prometheus server to retrieve collected meter data from the component. It is <em>only</em> exposed if Prometheus has
2202been configured as the metrics back end as described <a href="#configuring-a-metrics-back-end">above</a>.</p>
2203<p>The health check server can be configured by means of the following environment variables:</p>
2204<table>
2205<thead>
2206<tr>
2207<th style="text-align:left">Environment Variable<br>Command Line Option</th>
2208<th style="text-align:left">Default Value</th>
2209<th style="text-align:left">Description</th>
2210</tr>
2211</thead>
2212<tbody>
2213<tr>
2214<td style="text-align:left"><code>HONO_HEALTHCHECK_BINDADDRESS</code><br><code>--hono.healthCheck.bindAddress</code></td>
2215<td style="text-align:left"><code>127.0.0.1</code></td>
2216<td style="text-align:left">The IP address of the network interface that the health check server&rsquo;s secure port should be bound to. The server will only be started if this property is set to some other than the default value and corresponding key material has been configured using the <code>HONO_HEALTHCHECK_KEYPATH</code> and <code>HONO_HEALTHCHECK_CERTPATH</code> variables.</td>
2217</tr>
2218<tr>
2219<td style="text-align:left"><code>HONO_HEALTHCHECK_CERTPATH</code><br><code>--hono.healthCheck.certPath</code></td>
2220<td style="text-align:left">-</td>
2221<td style="text-align:left">The absolute path to the PEM file containing the certificate that the secure server should use for authenticating to clients. This option must be used in conjunction with <code>HONO_HEALTHCHECK_KEYPATH</code>.<br>Alternatively, the <code>HONO_HEALTHCHECK_KEYSTOREPATH</code> option can be used to configure a key store containing both the key as well as the certificate.</td>
2222</tr>
2223<tr>
2224<td style="text-align:left"><code>HONO_HEALTHCHECK_INSECUREPORTBINDADDRESS</code><br><code>--hono.healthCheck.insecurePortBindAddress</code></td>
2225<td style="text-align:left"><code>127.0.0.1</code></td>
2226<td style="text-align:left">The IP address of the network interface that the health check server&rsquo;s insecure port should be bound to. The server will only be started if this property is set to some other than the default value.</td>
2227</tr>
2228<tr>
2229<td style="text-align:left"><code>HONO_HEALTHCHECK_INSECUREPORT</code><br><code>--hono.healthCheck.insecurePort</code></td>
2230<td style="text-align:left"><code>8088</code></td>
2231<td style="text-align:left">The port that the insecure server should listen on.</td>
2232</tr>
2233<tr>
2234<td style="text-align:left"><code>HONO_HEALTHCHECK_KEYPATH</code><br><code>--hono.healthCheck.keyPath</code></td>
2235<td style="text-align:left">-</td>
2236<td style="text-align:left">The absolute path to the (PKCS8) PEM file containing the private key that the secure server should use for authenticating to clients. This option must be used in conjunction with <code>HONO_HEALTHCHECK_CERTPATH</code>. Alternatively, the <code>HONO_HEALTHCHECK_KEYSTOREPATH</code> option can be used to configure a key store containing both the key as well as the certificate.</td>
2237</tr>
2238<tr>
2239<td style="text-align:left"><code>HONO_HEALTHCHECK_PORT</code><br><code>--hono.healthCheck.port</code></td>
2240<td style="text-align:left"><code>8088</code></td>
2241<td style="text-align:left">The port that the secure server should listen on.</td>
2242</tr>
2243<tr>
2244<td style="text-align:left"><code>HONO_HEALTHCHECK_KEYSTOREPASSWORD</code><br><code>--hono.healthCheck.keyStorePassword</code></td>
2245<td style="text-align:left">-</td>
2246<td style="text-align:left">The password required to read the contents of the key store.</td>
2247</tr>
2248<tr>
2249<td style="text-align:left"><code>HONO_HEALTHCHECK_KEYSTOREPATH</code><br><code>--hono.healthCheck.keyStorePath</code></td>
2250<td style="text-align:left">-</td>
2251<td style="text-align:left">The absolute path to the Java key store containing the private key and certificate that the secure server should use for authenticating to clients. Either this option or the <code>HONO_HEALTHCHECK_KEYPATH</code> and <code>HONO_HEALTHCHECK_CERTPATH</code> options need to be set in order to enable TLS secured connections with clients. The key store format can be either <code>JKS</code> or <code>PKCS12</code> indicated by a <code>.jks</code> or <code>.p12</code> file suffix respectively. The <code>HONO_HEALTHCHECK_KEYSTOREPASSWORD</code> variable can be used to set the password required for reading the key store.</td>
2252</tr>
2253</tbody>
2254</table>
2255<div class="alert alert-warning">
2256 <h4 class="alert-heading"><i class="fas fa-exclamation-triangle"></i> Failure to start</h4>
2257 <div>The component/service will fail to start if neither the secure not the insecure server have been configured properly.</div>
2258</div>
2259<h2 id="tracing">Tracing</h2>
2260<p>In normal operation the vast majority of messages should be flowing through the system without any noteworthy delays or problems. In fact, that is the whole purpose of Hono. However, that doesn&rsquo;t mean that nothing can go wrong. For example, when a tenant&rsquo;s device administrator changes the credentials of a device in the Credentials service but has not yet updated the credentials on the device yet, then the device will start to fail in uploading any data to the protocol adapter it connects to. After a while, a back end application&rsquo;s administrator might notice, that there hasn&rsquo;t been any data being received from that particular device for quite some time. The application administrator therefore calls up the Hono operations team and complains about the data <em>being lost somewhere</em>.</p>
2261<p>The operations team will have a hard time determining what is happening, because it will need to figure out which components have been involved in the processing of the device and why the data hasn&rsquo;t been processed as usual. The metrics alone usually do not help much here because metrics are usually not scoped to individual devices. The logs written by the individual components, on the other hand, might contain enough information to correlate individual entries in the log with each other and thus <em>trace</em> the processing of the message throughout the system. However, this is usually a very tedious (and error prone) process and the relevant information is often only logged at a level (e.g. <em>DEBUG</em>) that is not used in production (often <em>INFO</em> or above).</p>
2262<p>In order to address this problem, Hono&rsquo;s service components are instrumented using <a href="https://opentracing.io/">OpenTracing</a>. OpenTracing provides <em>Vendor-neutral APIs and instrumentation for distributed tracing</em>. The OpenTracing web page provides a <a href="https://opentracing.io/docs/supported-tracers/">list of supported tracer implementations</a> from which users can choose in order to collect (and examine) the tracing information generated by Hono&rsquo;s individual components.</p>
2263<h3 id="configuring-a-tracer">Configuring a Tracer</h3>
2264<p><strong>Hint</strong>: The description in this chapter applies to any compatible OpenTracing implementation. For an easier approach to configure usage of <a href="https://www.jaegertracing.io/">Jaeger tracing</a>, see the next chapter.</p>
2265<p>Hono&rsquo;s components use the <a href="https://github.com/opentracing-contrib/java-tracerresolver">OpenTracing Tracer Resolver</a> mechanism to find and initialize a concrete OpenTracing implementation during startup of the component. The discovery mechanism is using Java&rsquo;s <a href="https://docs.oracle.com/javase/9/docs/api/java/util/ServiceLoader.html">ServiceLoader</a> and as such relies on the required resources to be available on the class path.</p>
2266<p>When starting up any of Hono&rsquo;s Docker images as a container, the JVM will look for additional jar files to include in its class path in the container&rsquo;s <code>/opt/hono/extensions</code> folder. Thus, using a specific implementation of OpenTracing is just a matter of configuring the container to mount a volume or binding a host folder at that location and putting the implementation&rsquo;s jar files and resources into the corresponding volume or host folder.</p>
2267<div class="alert alert-notice">
2268 <h4 class="alert-heading"><i class="fas fa-info-circle"></i> Note</h4>
2269 <div>This also means that (currently) only Tracer implementations can be used with Hono that also implement the Tracer Resolver mechanism.</div>
2270</div>
2271<p>Assuming that the HTTP adapter should be configured to use <a href="https://www.jaegertracing.io/">Jaeger tracing</a>, the following steps are necessary:</p>
2272<ol>
2273<li>
2274<p>Download <a href="https://github.com/jaegertracing/jaeger-client-java/tree/master/jaeger-tracerresolver">Jaeger&rsquo;s Java Tracer Resolver</a> implementation and its dependencies (see the hint at the end).</p>
2275</li>
2276<li>
2277<p>Put the jars to a folder on the Docker host, e.g. <code>/tmp/jaeger</code>.</p>
2278</li>
2279<li>
2280<p>Start the HTTP adapter Docker image mounting the host folder:</p>
2281<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-sh" data-lang="sh">docker run --name hono-adapter-http-vertx <span style="color:#ae81ff">\
2282</span><span style="color:#ae81ff"></span>--mount type<span style="color:#f92672">=</span>bind,src<span style="color:#f92672">=</span>/tmp/jaeger,dst<span style="color:#f92672">=</span>/opt/hono/extensions,ro <span style="color:#ae81ff">\
2283</span><span style="color:#ae81ff"></span>... <span style="color:#ae81ff">\
2284</span><span style="color:#ae81ff"></span>eclipse/hono-adapter-http-vertx
2285</code></pre></div></li>
2286</ol>
2287<p><strong>Note</strong>: the command given above does not contain the environment variables and secrets that are required to configure the service properly. The environment variables for configuring the Jaeger client are also missing. Please refer to the <a href="https://github.com/jaegertracing/jaeger-client-java/blob/master/jaeger-core/README.md">Jaeger documentation</a> for details.</p>
2288<p>When the HTTP adapter starts up, it will look for a working implementation of the Tracer Resolver on its classpath and (if found) initialize and use it for publishing traces. The adapter&rsquo;s log file will indicate the name of the Tracer implementation being used.</p>
2289<p>Using a Docker <em>volume</em> instead of a <em>bind mount</em> works the same way but requires the use of <code>volume</code> as the <em>type</em> of the <code>--mount</code> parameter. Please refer to the <a href="https://docs.docker.com/engine/reference/commandline/service_create/#add-bind-mounts-volumes-or-memory-filesystems">Docker reference documentation</a> for details.</p>
2290<p><strong>Hint</strong>: to resolve all dependencies for <code>jaeger-tracerresolver</code> in order to provide them to <code>/opt/hono/extensions</code>, you may want to rely on Maven&rsquo;s dependency plugin. To obtain all jar files you can invoke the following command in a simple Maven project that contains only the dependency to <code>jaeger-tracerresolver</code>:</p>
2291<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-sh" data-lang="sh">mvn dependency:copy-dependencies
2292</code></pre></div><p>All jar files can then be found in the directory <code>target/dependency</code>.</p>
2293<h2 id="configuring-usage-of-jaeger-tracing-included-in-docker-images">Configuring usage of Jaeger tracing (included in Docker images)</h2>
2294<p>In case <a href="https://www.jaegertracing.io/">Jaeger tracing</a> shall be used, there is an alternative to putting the jar files in the container&rsquo;s <code>/opt/hono/extensions</code> folder as described above.
2295This is to have the Jaeger tracing jar files be included in the Hono Docker images by using the <code>jaeger</code> Maven profile when building Hono.</p>
2296<p>For example, building the HTTP adapter image with the Jaeger client included:</p>
2297<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-sh" data-lang="sh"><span style="color:#75715e"># in directory: hono/adapters/http-vertx/</span>
2298mvn clean install -Pbuild-docker-image,jaeger
2299</code></pre></div><p>Note that when running the created docker image, the environment variables for configuring the Jaeger client still need to be set. Please refer to the <a href="https://github.com/jaegertracing/jaeger-client-java/blob/master/jaeger-core/README.md">Jaeger documentation</a> for details.</p>
2300<h2 id="enforcing-the-recording-of-traces-for-a-tenant">Enforcing the recording of traces for a tenant</h2>
2301<p>Typically, in production systems, the tracing components will be configured to not store <em>all</em> trace spans in the tracing backend, in order to reduce the performance impact. For debugging purposes it can however be beneficial to enforce the recording of certain traces. Hono allows this by providing a configuration option in the Tenant information with which all traces concerning the processing of telemetry, event and command messages for that specific tenant will be recorded. Furthermore, this enforced trace sampling can be restricted to only apply to messages sent in the context of a specific authentication identifier. Please refer to the <a href="/hono/docs/1.8/api/tenant/#tracing-format">description of the <code>tracing</code> object</a> in the Tenant Information for details.</p>
2302
2303<footer class="footline">
2304
2305</footer>
2306
2307
2308 </div>
2309
2310
2311 </div>
2312
2313 <div id="navigation">
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418 </div>
3419
3420 </section>
3421
3422 <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
3423 <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
3424 </div>
Hono Bot6cac68b2021-07-16 01:10:29 +00003425 <script src="/hono/docs/js/clipboard.min.js?1626397808"></script>
3426 <script src="/hono/docs/js/perfect-scrollbar.min.js?1626397808"></script>
3427 <script src="/hono/docs/js/perfect-scrollbar.jquery.min.js?1626397808"></script>
3428 <script src="/hono/docs/js/jquery.sticky.js?1626397808"></script>
3429 <script src="/hono/docs/js/featherlight.min.js?1626397808"></script>
3430 <script src="/hono/docs/js/highlight.pack.js?1626397808"></script>
Hono Bot1f51cfc2021-05-21 01:12:32 +00003431 <script>hljs.initHighlightingOnLoad();</script>
Hono Bot6cac68b2021-07-16 01:10:29 +00003432 <script src="/hono/docs/js/modernizr.custom-3.6.0.js?1626397808"></script>
3433 <script src="/hono/docs/js/learn.js?1626397808"></script>
3434 <script src="/hono/docs/js/hugo-learn.js?1626397808"></script>
Hono Bot1f51cfc2021-05-21 01:12:32 +00003435
Hono Bot6cac68b2021-07-16 01:10:29 +00003436 <link href="/hono/docs/mermaid/mermaid.css?1626397808" rel="stylesheet" />
3437 <script src="/hono/docs/mermaid/mermaid.js?1626397808"></script>
Hono Bot1f51cfc2021-05-21 01:12:32 +00003438 <script>
3439 mermaid.initialize({ startOnLoad: true });
3440 </script>
3441
3442
3443
3444
3445<script>
3446 (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
3447 new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
3448 j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
3449 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
3450 })(window,document,'script','dataLayer','GTM-5WLCZXC');
3451</script>
3452
3453
3454<script src="https://www.eclipse.org/eclipse.org-common/themes/solstice/public/javascript/vendor/cookieconsent/default.min.js"></script>
3455
3456 </body>
3457</html>
3458