Skip to content

Commit b18215d

Browse files
authored
Added API per-queue usage metrics
1 parent d931621 commit b18215d

File tree

1 file changed

+256
-0
lines changed

1 file changed

+256
-0
lines changed

README.md

Lines changed: 256 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -828,6 +828,262 @@ Metrics
828828
</tbody>
829829
</table>
830830

831+
#### API per-queue usage statistics
832+
###### MQOPEN and MQCLOSE
833+
<table class="wrapped confluenceTable">
834+
<tbody>
835+
<tr>
836+
<td class="confluenceTd"><strong>Metric name</strong></td>
837+
<td class="confluenceTd"><strong>Short description</strong></td>
838+
<td class="confluenceTd"><strong>Requires object</strong></td>
839+
<td class="confluenceTd"><strong>Is a counter</strong></td>
840+
<td class="confluenceTd"><strong>Datatype</strong></td>
841+
</tr>
842+
<tr>
843+
<td class="confluenceTd">object_mqopen_count</td>
844+
<td class="confluenceTd">Shows the number of calls to MQOPEN.</td>
845+
<td class="confluenceTd">Yes</td>
846+
<td class="confluenceTd">Yes</td>
847+
<td class="confluenceTd">delta</td>
848+
</tr>
849+
<tr>
850+
<td class="confluenceTd">object_mqclose_count</td>
851+
<td class="confluenceTd">Shows the number of calls to MQCLOSE.</td>
852+
<td class="confluenceTd">Yes</td>
853+
<td class="confluenceTd">Yes</td>
854+
<td class="confluenceTd">delta</td>
855+
</tr>
856+
</tbody>
857+
</table>
858+
859+
###### MQINQ and MQSET
860+
<table class="wrapped confluenceTable">
861+
<tbody>
862+
<tr>
863+
<td class="confluenceTd"><strong>Metric name</strong></td>
864+
<td class="confluenceTd"><strong>Short description</strong></td>
865+
<td class="confluenceTd"><strong>Requires object</strong></td>
866+
<td class="confluenceTd"><strong>Is a counter</strong></td>
867+
<td class="confluenceTd"><strong>Datatype</strong></td>
868+
</tr>
869+
<tr>
870+
<td class="confluenceTd">object_mqinq_count</td>
871+
<td class="confluenceTd">Shows the number of calls to MQINQ.</td>
872+
<td class="confluenceTd">Yes</td>
873+
<td class="confluenceTd">Yes</td>
874+
<td class="confluenceTd">delta</td>
875+
</tr>
876+
<tr>
877+
<td class="confluenceTd">object_mqset_count</td>
878+
<td class="confluenceTd">Shows the number of calls to MQSET.</td>
879+
<td class="confluenceTd">Yes</td>
880+
<td class="confluenceTd">Yes</td>
881+
<td class="confluenceTd">delta</td>
882+
</tr>
883+
</tbody>
884+
</table>
885+
886+
###### MQPUT and MQPUT1
887+
<table class="wrapped confluenceTable">
888+
<tbody>
889+
<tr>
890+
<td class="confluenceTd"><strong>Metric name</strong></td>
891+
<td class="confluenceTd"><strong>Short description</strong></td>
892+
<td class="confluenceTd"><strong>Requires object</strong></td>
893+
<td class="confluenceTd"><strong>Is a counter</strong></td>
894+
<td class="confluenceTd"><strong>Datatype</strong></td>
895+
</tr>
896+
<tr>
897+
<td class="confluenceTd">object_mqput_mqput1_count</td>
898+
<td class="confluenceTd">Shows the number of calls to MQPUT and MQPUT1.</td>
899+
<td class="confluenceTd">Yes</td>
900+
<td class="confluenceTd">Yes</td>
901+
<td class="confluenceTd">delta</td>
902+
</tr>
903+
<tr>
904+
<td class="confluenceTd">object_mqput_byte_count</td>
905+
<td class="confluenceTd">Shows the total bytes of data that is put by calls to MQPUT and MQPUT1.</td>
906+
<td class="confluenceTd">Yes</td>
907+
<td class="confluenceTd">Yes</td>
908+
<td class="confluenceTd">delta</td>
909+
</tr>
910+
<tr>
911+
<td class="confluenceTd">object_mqput_non_persistent_message_count</td>
912+
<td class="confluenceTd">Shows the number of non-persistent messages that are put by MQPUT.</td>
913+
<td class="confluenceTd">Yes</td>
914+
<td class="confluenceTd">Yes</td>
915+
<td class="confluenceTd">delta</td>
916+
</tr>
917+
<tr>
918+
<td class="confluenceTd">object_mqput_persistent_message_count</td>
919+
<td class="confluenceTd">Shows the number of persistent messages that are put by MQPUT.</td>
920+
<td class="confluenceTd">Yes</td>
921+
<td class="confluenceTd">Yes</td>
922+
<td class="confluenceTd">delta</td>
923+
</tr>
924+
<tr>
925+
<td class="confluenceTd">object_mqput1_non_persistent_message_count</td>
926+
<td class="confluenceTd">Shows the number of non-persistent messages that are put by MQPUT1.</td>
927+
<td class="confluenceTd">Yes</td>
928+
<td class="confluenceTd">Yes</td>
929+
<td class="confluenceTd">delta</td>
930+
</tr>
931+
<tr>
932+
<td class="confluenceTd">object_mqput1_persistent_message_count</td>
933+
<td class="confluenceTd">Shows the number of persistent messages that are put by MQPUT1.</td>
934+
<td class="confluenceTd">Yes</td>
935+
<td class="confluenceTd">Yes</td>
936+
<td class="confluenceTd">delta</td>
937+
</tr>
938+
<tr>
939+
<td class="confluenceTd">object_non_persistent_byte_count</td>
940+
<td class="confluenceTd">Shows the number of bytes put in non-persistent messages.</td>
941+
<td class="confluenceTd">Yes</td>
942+
<td class="confluenceTd">Yes</td>
943+
<td class="confluenceTd">delta</td>
944+
</tr>
945+
<tr>
946+
<td class="confluenceTd">object_persistent_byte_count</td>
947+
<td class="confluenceTd">Shows the number of bytes put in persistent messages.</td>
948+
<td class="confluenceTd">Yes</td>
949+
<td class="confluenceTd">Yes</td>
950+
<td class="confluenceTd">delta</td>
951+
</tr>
952+
<tr>
953+
<td class="confluenceTd">object_queue_avoided_puts</td>
954+
<td class="confluenceTd">Shows the percentage of messages that avoided put - if a message is put to a queue when there is a waiting getter, the message may not need to be queued as it may be possible for it to be passed to the getter immediately.</td>
955+
<td class="confluenceTd">Yes</td>
956+
<td class="confluenceTd">No</td>
957+
<td class="confluenceTd">percent</td>
958+
</tr>
959+
<tr>
960+
<td class="confluenceTd">object_queue_avoided_bytes</td>
961+
<td class="confluenceTd">Shows the percentage of bytes that avoided put - if a message is put to a queue when there is a waiting getter, the message may not need to be queued as it may be possible for it to be passed to the getter immediately.</td>
962+
<td class="confluenceTd">Yes</td>
963+
<td class="confluenceTd">No</td>
964+
<td class="confluenceTd">percent</td>
965+
</tr>
966+
<tr>
967+
<td class="confluenceTd">object_lock_contention</td>
968+
<td class="confluenceTd">Shows the percentage of attempts to lock the queue that resulted in waiting for another process to release the lock first.</td>
969+
<td class="confluenceTd">Yes</td>
970+
<td class="confluenceTd">No</td>
971+
<td class="confluenceTd">percent</td>
972+
</tr>
973+
</tbody>
974+
</table>
975+
976+
###### MQGET
977+
<table class="wrapped confluenceTable">
978+
<tbody>
979+
<tr>
980+
<td class="confluenceTd"><strong>Metric name</strong></td>
981+
<td class="confluenceTd"><strong>Short description</strong></td>
982+
<td class="confluenceTd"><strong>Requires object</strong></td>
983+
<td class="confluenceTd"><strong>Is a counter</strong></td>
984+
<td class="confluenceTd"><strong>Datatype</strong></td>
985+
</tr>
986+
<tr>
987+
<td class="confluenceTd">object_mqget_count</td>
988+
<td class="confluenceTd">Shows the number of calls to MQGET.</td>
989+
<td class="confluenceTd">Yes</td>
990+
<td class="confluenceTd">Yes</td>
991+
<td class="confluenceTd">delta</td>
992+
</tr>
993+
<tr>
994+
<td class="confluenceTd">object_mqget_byte_count</td>
995+
<td class="confluenceTd">Shows the total bytes of data that is got by calls to MQGET.</td>
996+
<td class="confluenceTd">Yes</td>
997+
<td class="confluenceTd">Yes</td>
998+
<td class="confluenceTd">delta</td>
999+
</tr>
1000+
<tr>
1001+
<td class="confluenceTd">object_destructive_mqget_non_persistent_message_count</td>
1002+
<td class="confluenceTd">Number of non-persistent messages that are removed from the queue by MQGET.</td>
1003+
<td class="confluenceTd">Yes</td>
1004+
<td class="confluenceTd">Yes</td>
1005+
<td class="confluenceTd">delta</td>
1006+
</tr>
1007+
<tr>
1008+
<td class="confluenceTd">object_destructive_mqget_persistent_message_count</td>
1009+
<td class="confluenceTd">Number of persistent messages that are removed from the queue by MQGET.</td>
1010+
<td class="confluenceTd">Yes</td>
1011+
<td class="confluenceTd">Yes</td>
1012+
<td class="confluenceTd">delta</td>
1013+
</tr>
1014+
<tr>
1015+
<td class="confluenceTd">object_destructive_mqget_non_persistent_byte_count</td>
1016+
<td class="confluenceTd">Shows a count of bytes of non-persistent messages that are returned to MQGET.</td>
1017+
<td class="confluenceTd">Yes</td>
1018+
<td class="confluenceTd">Yes</td>
1019+
<td class="confluenceTd">delta</td>
1020+
</tr>
1021+
<tr>
1022+
<td class="confluenceTd">object_destructive_mqget_persistent_byte_count</td>
1023+
<td class="confluenceTd">Shows a count of bytes of persistent messages that are returned to MQGET.</td>
1024+
<td class="confluenceTd">Yes</td>
1025+
<td class="confluenceTd">Yes</td>
1026+
<td class="confluenceTd">delta</td>
1027+
</tr>
1028+
<tr>
1029+
<td class="confluenceTd">object_mqget_browse_non_persistent_message_count</td>
1030+
<td class="confluenceTd">Shows a count of non-persistent messages that have been browsed.</td>
1031+
<td class="confluenceTd">Yes</td>
1032+
<td class="confluenceTd">Yes</td>
1033+
<td class="confluenceTd">delta</td>
1034+
</tr>
1035+
<tr>
1036+
<td class="confluenceTd">object_mqget_browse_persistent_message_count</td>
1037+
<td class="confluenceTd">Shows a count of persistent messages that have been browsed.</td>
1038+
<td class="confluenceTd">Yes</td>
1039+
<td class="confluenceTd">Yes</td>
1040+
<td class="confluenceTd">delta</td>
1041+
</tr>
1042+
<tr>
1043+
<td class="confluenceTd">object_mqget_browse_non_persistent_byte_count</td>
1044+
<td class="confluenceTd">Shows the number of bytes of non-persistent messages that have been browsed.</td>
1045+
<td class="confluenceTd">Yes</td>
1046+
<td class="confluenceTd">Yes</td>
1047+
<td class="confluenceTd">delta</td>
1048+
</tr>
1049+
<tr>
1050+
<td class="confluenceTd">object_mqget_browse_persistent_byte_count</td>
1051+
<td class="confluenceTd">Shows the number of bytes of persistent messages that have been browsed.</td>
1052+
<td class="confluenceTd">Yes</td>
1053+
<td class="confluenceTd">Yes</td>
1054+
<td class="confluenceTd">delta</td>
1055+
</tr>
1056+
<tr>
1057+
<td class="confluenceTd">object_messages_expired</td>
1058+
<td class="confluenceTd">Shows a count of expired messages.</td>
1059+
<td class="confluenceTd">Yes</td>
1060+
<td class="confluenceTd">Yes</td>
1061+
<td class="confluenceTd">delta</td>
1062+
</tr>
1063+
<tr>
1064+
<td class="confluenceTd">object_queue_purged_count</td>
1065+
<td class="confluenceTd">Shows a count of queues that have been purged.</td>
1066+
<td class="confluenceTd">Yes</td>
1067+
<td class="confluenceTd">Yes</td>
1068+
<td class="confluenceTd">delta</td>
1069+
</tr>
1070+
<tr>
1071+
<td class="confluenceTd">object_average_queue_time</td>
1072+
<td class="confluenceTd">Shows the average latency of messages that are retrieved from the queue.</td>
1073+
<td class="confluenceTd">Yes</td>
1074+
<td class="confluenceTd">No</td>
1075+
<td class="confluenceTd">microseconds</td>
1076+
</tr>
1077+
<tr>
1078+
<td class="confluenceTd">object_queue_depth</td>
1079+
<td class="confluenceTd">Shows&nbsp;the number of messages on the&nbsp;queue.</td>
1080+
<td class="confluenceTd">Yes</td>
1081+
<td class="confluenceTd">No</td>
1082+
<td class="confluenceTd">units</td>
1083+
</tr>
1084+
</tbody>
1085+
</table>
1086+
8311087
License
8321088
-------
8331089

0 commit comments

Comments
 (0)