Skip to content

Commit 6bafddf

Browse files
sberdyshevsberdyshev
authored
Updated API per-queue usage statistics
1 parent c4afc26 commit 6bafddf

File tree

1 file changed

+140
-174
lines changed

1 file changed

+140
-174
lines changed

‎README.md

Lines changed: 140 additions & 174 deletions
Original file line numberDiff line numberDiff line change
@@ -729,256 +729,222 @@ mvn package
729729

730730
#### API per-queue usage statistics
731731
###### MQOPEN and MQCLOSE
732-
<table class="wrapped confluenceTable">
732+
<table>
733733
<tbody>
734-
<tr>
735-
<td class="confluenceTd"><strong>Metric name</strong></td>
736-
<td class="confluenceTd"><strong>Short description</strong></td>
737-
<td class="confluenceTd"><strong>Requires object</strong></td>
738-
<td class="confluenceTd"><strong>Is a counter</strong></td>
739-
<td class="confluenceTd"><strong>Datatype</strong></td>
734+
<tr>
735+
<td><strong>Prometheus metric name</strong></td>
736+
<td><strong>Metric type</strong></td>
737+
<td><strong>Short description</strong></td>
738+
<td><strong>MQ metric elemen</strong></td>
740739
</tr>
741740
<tr>
742-
<td class="confluenceTd">object_mqopen_count</td>
743-
<td class="confluenceTd">Shows the number of calls to MQOPEN.</td>
744-
<td class="confluenceTd">Yes</td>
745-
<td class="confluenceTd">Yes</td>
746-
<td class="confluenceTd">delta</td>
741+
<td>mqobject_mqopen_mqopen_count_totalcalls</td>
742+
<td>counter</td>
743+
<td>Shows the number of calls to MQOPEN.</td>
744+
<td>MQOPEN count</td>
747745
</tr>
748746
<tr>
749-
<td class="confluenceTd">object_mqclose_count</td>
750-
<td class="confluenceTd">Shows the number of calls to MQCLOSE.</td>
751-
<td class="confluenceTd">Yes</td>
752-
<td class="confluenceTd">Yes</td>
753-
<td class="confluenceTd">delta</td>
747+
<td>mqobject_mqclose_mqclose_count_totalcalls</td>
748+
<td>counter</td>
749+
<td>Shows the number of calls to MQCLOSE.</td>
750+
<td>MQCLOSE count</td>
754751
</tr>
755752
</tbody>
756753
</table>
757754

758755
###### MQINQ and MQSET
759-
<table class="wrapped confluenceTable">
756+
<table>
760757
<tbody>
761-
<tr>
762-
<td class="confluenceTd"><strong>Metric name</strong></td>
763-
<td class="confluenceTd"><strong>Short description</strong></td>
764-
<td class="confluenceTd"><strong>Requires object</strong></td>
765-
<td class="confluenceTd"><strong>Is a counter</strong></td>
766-
<td class="confluenceTd"><strong>Datatype</strong></td>
767-
</tr>
768758
<tr>
769-
<td class="confluenceTd">object_mqinq_count</td>
770-
<td class="confluenceTd">Shows the number of calls to MQINQ.</td>
771-
<td class="confluenceTd">Yes</td>
772-
<td class="confluenceTd">Yes</td>
773-
<td class="confluenceTd">delta</td>
759+
<td><strong>Prometheus metric name</strong></td>
760+
<td><strong>Metric type</strong></td>
761+
<td><strong>Short description</strong></td>
762+
<td><strong>MQ metric elemen</strong></td>
763+
</tr>
764+
<td>mqobject_mqinq_mqinq_count_totalcalls</td>
765+
<td>counter</td>
766+
<td>Shows the number of calls to MQINQ.</td>
767+
<td>MQINQ count</td>
774768
</tr>
775769
<tr>
776-
<td class="confluenceTd">object_mqset_count</td>
777-
<td class="confluenceTd">Shows the number of calls to MQSET.</td>
778-
<td class="confluenceTd">Yes</td>
779-
<td class="confluenceTd">Yes</td>
780-
<td class="confluenceTd">delta</td>
770+
<td>mqobject_mqset_mqset_count_totalcalls</td>
771+
<td>counter</td>
772+
<td>Shows the number of calls to MQSET.</td>
773+
<td>MQSET count</td>
781774
</tr>
782775
</tbody>
783776
</table>
784777

785778
###### MQPUT and MQPUT1
786-
<table class="wrapped confluenceTable">
779+
<table>
787780
<tbody>
788-
<tr>
789-
<td class="confluenceTd"><strong>Metric name</strong></td>
790-
<td class="confluenceTd"><strong>Short description</strong></td>
791-
<td class="confluenceTd"><strong>Requires object</strong></td>
792-
<td class="confluenceTd"><strong>Is a counter</strong></td>
793-
<td class="confluenceTd"><strong>Datatype</strong></td>
781+
<tr>
782+
<td><strong>Prometheus metric name</strong></td>
783+
<td><strong>Metric type</strong></td>
784+
<td><strong>Short description</strong></td>
785+
<td><strong>MQ metric elemen</strong></td>
794786
</tr>
795787
<tr>
796-
<td class="confluenceTd">object_mqput_mqput1_count</td>
797-
<td class="confluenceTd">Shows the number of calls to MQPUT and MQPUT1.</td>
798-
<td class="confluenceTd">Yes</td>
799-
<td class="confluenceTd">Yes</td>
800-
<td class="confluenceTd">delta</td>
788+
<td>mqobject_put_mqput_mqput1_count_totalcalls</td>
789+
<td>counter</td>
790+
<td>Shows the number of calls to MQPUT and MQPUT1.</td>
791+
<td>MQPUT/MQPUT1 count</td>
801792
</tr>
802793
<tr>
803-
<td class="confluenceTd">object_mqput_byte_count</td>
804-
<td class="confluenceTd">Shows the total bytes of data that is put by calls to MQPUT and MQPUT1.</td>
805-
<td class="confluenceTd">Yes</td>
806-
<td class="confluenceTd">Yes</td>
807-
<td class="confluenceTd">delta</td>
794+
<td>mqobject_put_mqput_byte_count_totalbytes</td>
795+
<td>counter</td>
796+
<td>Shows the total bytes of data that is put by calls to MQPUT and MQPUT1.</td>
797+
<td>MQPUT byte count</td>
808798
</tr>
809799
<tr>
810-
<td class="confluenceTd">object_mqput_non_persistent_message_count</td>
811-
<td class="confluenceTd">Shows the number of non-persistent messages that are put by MQPUT.</td>
812-
<td class="confluenceTd">Yes</td>
813-
<td class="confluenceTd">Yes</td>
814-
<td class="confluenceTd">delta</td>
800+
<td>mqobject_put_mqput_non_persistent_message_count_totalmessages</td>
801+
<td>counter</td>
802+
<td>Shows the number of non-persistent messages that are put by MQPUT.</td>
803+
<td>MQPUT non-persistent message count</td>
815804
</tr>
816805
<tr>
817-
<td class="confluenceTd">object_mqput_persistent_message_count</td>
818-
<td class="confluenceTd">Shows the number of persistent messages that are put by MQPUT.</td>
819-
<td class="confluenceTd">Yes</td>
820-
<td class="confluenceTd">Yes</td>
821-
<td class="confluenceTd">delta</td>
806+
<td>mqobject_put_mqput_persistent_message_count_totalmessages</td>
807+
<td>counter</td>
808+
<td>Shows the number of persistent messages that are put by MQPUT.</td>
809+
<td>MQPUT persistent message count</td>
822810
</tr>
823811
<tr>
824-
<td class="confluenceTd">object_mqput1_non_persistent_message_count</td>
825-
<td class="confluenceTd">Shows the number of non-persistent messages that are put by MQPUT1.</td>
826-
<td class="confluenceTd">Yes</td>
827-
<td class="confluenceTd">Yes</td>
828-
<td class="confluenceTd">delta</td>
812+
<td>mqobject_put_mqput1_non_persistent_message_count_totalmessages</td>
813+
<td>counter</td>
814+
<td>Shows the number of non-persistent messages that are put by MQPUT1.</td>
815+
<td>MQPUT1 non-persistent message count</td>
829816
</tr>
830817
<tr>
831-
<td class="confluenceTd">object_mqput1_persistent_message_count</td>
832-
<td class="confluenceTd">Shows the number of persistent messages that are put by MQPUT1.</td>
833-
<td class="confluenceTd">Yes</td>
834-
<td class="confluenceTd">Yes</td>
835-
<td class="confluenceTd">delta</td>
818+
<td>mqobject_put_mqput1_persistent_message_count_totalmessages</td>
819+
<td>counter</td>
820+
<td>Shows the number of persistent messages that are put by MQPUT1.</td>
821+
<td>MQPUT1 persistent message count</td>
836822
</tr>
837823
<tr>
838-
<td class="confluenceTd">object_non_persistent_byte_count</td>
839-
<td class="confluenceTd">Shows the number of bytes put in non-persistent messages.</td>
840-
<td class="confluenceTd">Yes</td>
841-
<td class="confluenceTd">Yes</td>
842-
<td class="confluenceTd">delta</td>
824+
<td>mqobject_put_non_persistent_byte_count_totalbytes</td>
825+
<td>counter</td>
826+
<td>Shows the number of bytes put in non-persistent messages.</td>
827+
<td>non-persistent byte count</td>
843828
</tr>
844829
<tr>
845-
<td class="confluenceTd">object_persistent_byte_count</td>
846-
<td class="confluenceTd">Shows the number of bytes put in persistent messages.</td>
847-
<td class="confluenceTd">Yes</td>
848-
<td class="confluenceTd">Yes</td>
849-
<td class="confluenceTd">delta</td>
830+
<td>mqobject_put_persistent_byte_count_totalbytes</td>
831+
<td>counter</td>
832+
<td>Shows the number of bytes put in persistent messages.</td>
833+
<td>persistent byte count</td>
850834
</tr>
851835
<tr>
852-
<td class="confluenceTd">object_queue_avoided_puts</td>
853-
<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>
854-
<td class="confluenceTd">Yes</td>
855-
<td class="confluenceTd">No</td>
856-
<td class="confluenceTd">percent</td>
836+
<td>mqobject_put_queue_avoided_puts_percentage</td>
837+
<td>gauge</td>
838+
<td>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>
839+
<td>queue avoided puts</td>
857840
</tr>
858841
<tr>
859-
<td class="confluenceTd">object_queue_avoided_bytes</td>
860-
<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>
861-
<td class="confluenceTd">Yes</td>
862-
<td class="confluenceTd">No</td>
863-
<td class="confluenceTd">percent</td>
842+
<td>mqobject_put_queue_avoided_bytes_percentage</td>
843+
<td>gauge</td>
844+
<td>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>
845+
<td>queue avoided bytes</td>
864846
</tr>
865847
<tr>
866-
<td class="confluenceTd">object_lock_contention</td>
867-
<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>
868-
<td class="confluenceTd">Yes</td>
869-
<td class="confluenceTd">No</td>
870-
<td class="confluenceTd">percent</td>
848+
<td>mqobject_put_lock_contention_percentage</td>
849+
<td>gauge</td>
850+
<td>Shows the percentage of attempts to lock the queue that resulted in waiting for another process to release the lock first.</td>
851+
<td>lock contention</td>
871852
</tr>
872853
</tbody>
873854
</table>
874855

875856
###### MQGET
876-
<table class="wrapped confluenceTable">
857+
<table>
877858
<tbody>
878-
<tr>
879-
<td class="confluenceTd"><strong>Metric name</strong></td>
880-
<td class="confluenceTd"><strong>Short description</strong></td>
881-
<td class="confluenceTd"><strong>Requires object</strong></td>
882-
<td class="confluenceTd"><strong>Is a counter</strong></td>
883-
<td class="confluenceTd"><strong>Datatype</strong></td>
859+
<tr>
860+
<td><strong>Prometheus metric name</strong></td>
861+
<td><strong>Metric type</strong></td>
862+
<td><strong>Short description</strong></td>
863+
<td><strong>MQ metric elemen</strong></td>
884864
</tr>
885865
<tr>
886-
<td class="confluenceTd">object_mqget_count</td>
887-
<td class="confluenceTd">Shows the number of calls to MQGET.</td>
888-
<td class="confluenceTd">Yes</td>
889-
<td class="confluenceTd">Yes</td>
890-
<td class="confluenceTd">delta</td>
866+
<td>mqobject_get_mqget_count_totalcalls</td>
867+
<td>counter</td>
868+
<td>Shows the number of calls to MQGET.</td>
869+
<td>MQGET count</td>
891870
</tr>
892871
<tr>
893-
<td class="confluenceTd">object_mqget_byte_count</td>
894-
<td class="confluenceTd">Shows the total bytes of data that is got by calls to MQGET.</td>
895-
<td class="confluenceTd">Yes</td>
896-
<td class="confluenceTd">Yes</td>
897-
<td class="confluenceTd">delta</td>
872+
<td>mqobject_get_mqget_byte_count_totalbytes</td>
873+
<td>counter</td>
874+
<td>Shows the total bytes of data that is got by calls to MQGET.</td>
875+
<td>MQGET byte count</td>
898876
</tr>
899877
<tr>
900-
<td class="confluenceTd">object_destructive_mqget_non_persistent_message_count</td>
901-
<td class="confluenceTd">Number of non-persistent messages that are removed from the queue by MQGET.</td>
902-
<td class="confluenceTd">Yes</td>
903-
<td class="confluenceTd">Yes</td>
904-
<td class="confluenceTd">delta</td>
878+
<td>mqobject_get_destructive_mqget_non_persistent_message_count_totalmessages</td>
879+
<td>counter</td>
880+
<td>Number of non-persistent messages that are removed from the queue by MQGET.</td>
881+
<td>destructive MQGET non-persistent message count</td>
905882
</tr>
906883
<tr>
907-
<td class="confluenceTd">object_destructive_mqget_persistent_message_count</td>
908-
<td class="confluenceTd">Number of persistent messages that are removed from the queue by MQGET.</td>
909-
<td class="confluenceTd">Yes</td>
910-
<td class="confluenceTd">Yes</td>
911-
<td class="confluenceTd">delta</td>
884+
<td>mqobject_get_destructive_mqget_persistent_message_count_totalmessages</td>
885+
<td>counter</td>
886+
<td>Number of persistent messages that are removed from the queue by MQGET.</td>
887+
<td>destructive MQGET persistent message count</td>
912888
</tr>
913889
<tr>
914-
<td class="confluenceTd">object_destructive_mqget_non_persistent_byte_count</td>
915-
<td class="confluenceTd">Shows a count of bytes of non-persistent messages that are returned to MQGET.</td>
916-
<td class="confluenceTd">Yes</td>
917-
<td class="confluenceTd">Yes</td>
918-
<td class="confluenceTd">delta</td>
890+
<td>mqobject_get_destructive_mqget_non_persistent_byte_count_totalbytes</td>
891+
<td>counter</td>
892+
<td>Shows a count of bytes of non-persistent messages that are returned to MQGET.</td>
893+
<td>destructive MQGET non-persistent byte count</td>
919894
</tr>
920895
<tr>
921-
<td class="confluenceTd">object_destructive_mqget_persistent_byte_count</td>
922-
<td class="confluenceTd">Shows a count of bytes of persistent messages that are returned to MQGET.</td>
923-
<td class="confluenceTd">Yes</td>
924-
<td class="confluenceTd">Yes</td>
925-
<td class="confluenceTd">delta</td>
896+
<td>mqobject_get_destructive_mqget_persistent_byte_count_totalbytes</td>
897+
<td>counter</td>
898+
<td>Shows a count of bytes of persistent messages that are returned to MQGET.</td>
899+
<td>destructive MQGET persistent byte count</td>
926900
</tr>
927901
<tr>
928-
<td class="confluenceTd">object_mqget_browse_non_persistent_message_count</td>
929-
<td class="confluenceTd">Shows a count of non-persistent messages that have been browsed.</td>
930-
<td class="confluenceTd">Yes</td>
931-
<td class="confluenceTd">Yes</td>
932-
<td class="confluenceTd">delta</td>
902+
<td>mqobject_get_mqget_browse_non_persistent_message_count_totalmessages</td>
903+
<td>counter</td>
904+
<td>Shows a count of non-persistent messages that have been browsed.</td>
905+
<td>MQGET browse non-persistent message count</td>
933906
</tr>
934907
<tr>
935-
<td class="confluenceTd">object_mqget_browse_persistent_message_count</td>
936-
<td class="confluenceTd">Shows a count of persistent messages that have been browsed.</td>
937-
<td class="confluenceTd">Yes</td>
938-
<td class="confluenceTd">Yes</td>
939-
<td class="confluenceTd">delta</td>
908+
<td>mqobject_get_mqget_browse_persistent_message_count_totalmessages</td>
909+
<td>counter</td>
910+
<td>Shows a count of persistent messages that have been browsed.</td>
911+
<td>MQGET browse persistent message count</td>
940912
</tr>
941913
<tr>
942-
<td class="confluenceTd">object_mqget_browse_non_persistent_byte_count</td>
943-
<td class="confluenceTd">Shows the number of bytes of non-persistent messages that have been browsed.</td>
944-
<td class="confluenceTd">Yes</td>
945-
<td class="confluenceTd">Yes</td>
946-
<td class="confluenceTd">delta</td>
914+
<td>mqobject_get_mqget_browse_non_persistent_byte_count_totalbytes</td>
915+
<td>counter</td>
916+
<td>Shows the number of bytes of non-persistent messages that have been browsed.</td>
917+
<td>MQGET browse non-persistent byte count</td>
947918
</tr>
948919
<tr>
949-
<td class="confluenceTd">object_mqget_browse_persistent_byte_count</td>
950-
<td class="confluenceTd">Shows the number of bytes of persistent messages that have been browsed.</td>
951-
<td class="confluenceTd">Yes</td>
952-
<td class="confluenceTd">Yes</td>
953-
<td class="confluenceTd">delta</td>
920+
<td>mqobject_get_mqget_browse_persistent_byte_count_totalbytes</td>
921+
<td>counter</td>
922+
<td>Shows the number of bytes of persistent messages that have been browsed.</td>
923+
<td>MQGET browse persistent byte count</td>
954924
</tr>
955925
<tr>
956-
<td class="confluenceTd">object_messages_expired</td>
957-
<td class="confluenceTd">Shows a count of expired messages.</td>
958-
<td class="confluenceTd">Yes</td>
959-
<td class="confluenceTd">Yes</td>
960-
<td class="confluenceTd">delta</td>
926+
<td>mqobject_get_messages_expired_totalmessages</td>
927+
<td>counter</td>
928+
<td>Shows a count of expired messages.</td>
929+
<td>messages expired</td>
961930
</tr>
962931
<tr>
963-
<td class="confluenceTd">object_queue_purged_count</td>
964-
<td class="confluenceTd">Shows a count of queues that have been purged.</td>
965-
<td class="confluenceTd">Yes</td>
966-
<td class="confluenceTd">Yes</td>
967-
<td class="confluenceTd">delta</td>
932+
<td>mqobject_get_queue_purged_count_totalqueues</td>
933+
<td>counter</td>
934+
<td>Shows a count of queues that have been purged.</td>
935+
<td>queue purged count</td>
968936
</tr>
969937
<tr>
970-
<td class="confluenceTd">object_average_queue_time</td>
971-
<td class="confluenceTd">Shows the average latency of messages that are retrieved from the queue.</td>
972-
<td class="confluenceTd">Yes</td>
973-
<td class="confluenceTd">No</td>
974-
<td class="confluenceTd">microseconds</td>
938+
<td>mqobject_get_average_queue_time_microseconds</td>
939+
<td>gauge</td>
940+
<td>Shows the average latency of messages that are retrieved from the queue.</td>
941+
<td>average queue time</td>
975942
</tr>
976943
<tr>
977-
<td class="confluenceTd">object_queue_depth</td>
978-
<td class="confluenceTd">Shows&nbsp;the number of messages on the&nbsp;queue.</td>
979-
<td class="confluenceTd">Yes</td>
980-
<td class="confluenceTd">No</td>
981-
<td class="confluenceTd">units</td>
944+
<td>mqobject_get_queue_depth_messages</td>
945+
<td>gauge</td>
946+
<td>Shows the number of messages on the queue.</td>
947+
<td>Queue depth</td>
982948
</tr>
983949
</tbody>
984950
</table>

0 commit comments

Comments
 (0)