github.com/KinWaiYuen/client-go/v2@v2.5.4/metrics/shortcuts.go (about)

     1  // Copyright 2021 TiKV Authors
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // NOTE: The code in this file is based on code from the
    16  // TiDB project, licensed under the Apache License v 2.0
    17  //
    18  // https://github.com/pingcap/tidb/tree/cc5e161ac06827589c4966674597c137cc9e809c/store/tikv/metrics/shortcuts.go
    19  //
    20  
    21  // Copyright 2021 PingCAP, Inc.
    22  //
    23  // Licensed under the Apache License, Version 2.0 (the "License");
    24  // you may not use this file except in compliance with the License.
    25  // You may obtain a copy of the License at
    26  //
    27  //     http://www.apache.org/licenses/LICENSE-2.0
    28  //
    29  // Unless required by applicable law or agreed to in writing, software
    30  // distributed under the License is distributed on an "AS IS" BASIS,
    31  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    32  // See the License for the specific language governing permissions and
    33  // limitations under the License.
    34  
    35  package metrics
    36  
    37  import "github.com/prometheus/client_golang/prometheus"
    38  
    39  // Shortcuts for performance improvement.
    40  var (
    41  	TxnCmdHistogramWithCommit   prometheus.Observer
    42  	TxnCmdHistogramWithRollback prometheus.Observer
    43  	TxnCmdHistogramWithBatchGet prometheus.Observer
    44  	TxnCmdHistogramWithGet      prometheus.Observer
    45  	TxnCmdHistogramWithLockKeys prometheus.Observer
    46  
    47  	RawkvCmdHistogramWithGet           prometheus.Observer
    48  	RawkvCmdHistogramWithBatchGet      prometheus.Observer
    49  	RawkvCmdHistogramWithBatchPut      prometheus.Observer
    50  	RawkvCmdHistogramWithDelete        prometheus.Observer
    51  	RawkvCmdHistogramWithBatchDelete   prometheus.Observer
    52  	RawkvCmdHistogramWithRawScan       prometheus.Observer
    53  	RawkvCmdHistogramWithRawReversScan prometheus.Observer
    54  	RawkvSizeHistogramWithKey          prometheus.Observer
    55  	RawkvSizeHistogramWithValue        prometheus.Observer
    56  
    57  	BackoffHistogramRPC              prometheus.Observer
    58  	BackoffHistogramLock             prometheus.Observer
    59  	BackoffHistogramLockFast         prometheus.Observer
    60  	BackoffHistogramPD               prometheus.Observer
    61  	BackoffHistogramRegionMiss       prometheus.Observer
    62  	BackoffHistogramRegionScheduling prometheus.Observer
    63  	BackoffHistogramServerBusy       prometheus.Observer
    64  	BackoffHistogramTiKVDiskFull     prometheus.Observer
    65  	BackoffHistogramStaleCmd         prometheus.Observer
    66  	BackoffHistogramDataNotReady     prometheus.Observer
    67  	BackoffHistogramEmpty            prometheus.Observer
    68  
    69  	TxnRegionsNumHistogramWithSnapshot         prometheus.Observer
    70  	TxnRegionsNumHistogramPrewrite             prometheus.Observer
    71  	TxnRegionsNumHistogramCommit               prometheus.Observer
    72  	TxnRegionsNumHistogramCleanup              prometheus.Observer
    73  	TxnRegionsNumHistogramPessimisticLock      prometheus.Observer
    74  	TxnRegionsNumHistogramPessimisticRollback  prometheus.Observer
    75  	TxnRegionsNumHistogramWithCoprocessor      prometheus.Observer
    76  	TxnRegionsNumHistogramWithBatchCoprocessor prometheus.Observer
    77  
    78  	LockResolverCountWithBatchResolve             prometheus.Counter
    79  	LockResolverCountWithExpired                  prometheus.Counter
    80  	LockResolverCountWithNotExpired               prometheus.Counter
    81  	LockResolverCountWithWaitExpired              prometheus.Counter
    82  	LockResolverCountWithResolve                  prometheus.Counter
    83  	LockResolverCountWithResolveForWrite          prometheus.Counter
    84  	LockResolverCountWithResolveAsync             prometheus.Counter
    85  	LockResolverCountWithWriteConflict            prometheus.Counter
    86  	LockResolverCountWithQueryTxnStatus           prometheus.Counter
    87  	LockResolverCountWithQueryTxnStatusCommitted  prometheus.Counter
    88  	LockResolverCountWithQueryTxnStatusRolledBack prometheus.Counter
    89  	LockResolverCountWithQueryCheckSecondaryLocks prometheus.Counter
    90  	LockResolverCountWithResolveLocks             prometheus.Counter
    91  	LockResolverCountWithResolveLockLite          prometheus.Counter
    92  
    93  	RegionCacheCounterWithInvalidateRegionFromCacheOK prometheus.Counter
    94  	RegionCacheCounterWithSendFail                    prometheus.Counter
    95  	RegionCacheCounterWithGetRegionByIDOK             prometheus.Counter
    96  	RegionCacheCounterWithGetRegionByIDError          prometheus.Counter
    97  	RegionCacheCounterWithGetRegionOK                 prometheus.Counter
    98  	RegionCacheCounterWithGetRegionError              prometheus.Counter
    99  	RegionCacheCounterWithScanRegionsOK               prometheus.Counter
   100  	RegionCacheCounterWithScanRegionsError            prometheus.Counter
   101  	RegionCacheCounterWithGetStoreOK                  prometheus.Counter
   102  	RegionCacheCounterWithGetStoreError               prometheus.Counter
   103  	RegionCacheCounterWithInvalidateStoreRegionsOK    prometheus.Counter
   104  
   105  	TxnHeartBeatHistogramOK    prometheus.Observer
   106  	TxnHeartBeatHistogramError prometheus.Observer
   107  
   108  	StatusCountWithOK    prometheus.Counter
   109  	StatusCountWithError prometheus.Counter
   110  
   111  	SecondaryLockCleanupFailureCounterCommit   prometheus.Counter
   112  	SecondaryLockCleanupFailureCounterRollback prometheus.Counter
   113  
   114  	TwoPCTxnCounterOk    prometheus.Counter
   115  	TwoPCTxnCounterError prometheus.Counter
   116  
   117  	AsyncCommitTxnCounterOk    prometheus.Counter
   118  	AsyncCommitTxnCounterError prometheus.Counter
   119  
   120  	OnePCTxnCounterOk       prometheus.Counter
   121  	OnePCTxnCounterError    prometheus.Counter
   122  	OnePCTxnCounterFallback prometheus.Counter
   123  
   124  	BatchRecvHistogramOK    prometheus.Observer
   125  	BatchRecvHistogramError prometheus.Observer
   126  )
   127  
   128  func initShortcuts() {
   129  	TxnCmdHistogramWithCommit = TiKVTxnCmdHistogram.WithLabelValues(LblCommit)
   130  	TxnCmdHistogramWithRollback = TiKVTxnCmdHistogram.WithLabelValues(LblRollback)
   131  	TxnCmdHistogramWithBatchGet = TiKVTxnCmdHistogram.WithLabelValues(LblBatchGet)
   132  	TxnCmdHistogramWithGet = TiKVTxnCmdHistogram.WithLabelValues(LblGet)
   133  	TxnCmdHistogramWithLockKeys = TiKVTxnCmdHistogram.WithLabelValues(LblLockKeys)
   134  
   135  	RawkvCmdHistogramWithGet = TiKVRawkvCmdHistogram.WithLabelValues("get")
   136  	RawkvCmdHistogramWithBatchGet = TiKVRawkvCmdHistogram.WithLabelValues("batch_get")
   137  	RawkvCmdHistogramWithBatchPut = TiKVRawkvCmdHistogram.WithLabelValues("batch_put")
   138  	RawkvCmdHistogramWithDelete = TiKVRawkvCmdHistogram.WithLabelValues("delete")
   139  	RawkvCmdHistogramWithBatchDelete = TiKVRawkvCmdHistogram.WithLabelValues("batch_delete")
   140  	RawkvCmdHistogramWithRawScan = TiKVRawkvCmdHistogram.WithLabelValues("raw_scan")
   141  	RawkvCmdHistogramWithRawReversScan = TiKVRawkvCmdHistogram.WithLabelValues("raw_reverse_scan")
   142  	RawkvSizeHistogramWithKey = TiKVRawkvSizeHistogram.WithLabelValues("key")
   143  	RawkvSizeHistogramWithValue = TiKVRawkvSizeHistogram.WithLabelValues("value")
   144  
   145  	BackoffHistogramRPC = TiKVBackoffHistogram.WithLabelValues("tikvRPC")
   146  	BackoffHistogramLock = TiKVBackoffHistogram.WithLabelValues("txnLock")
   147  	BackoffHistogramLockFast = TiKVBackoffHistogram.WithLabelValues("tikvLockFast")
   148  	BackoffHistogramPD = TiKVBackoffHistogram.WithLabelValues("pdRPC")
   149  	BackoffHistogramRegionMiss = TiKVBackoffHistogram.WithLabelValues("regionMiss")
   150  	BackoffHistogramRegionScheduling = TiKVBackoffHistogram.WithLabelValues("regionScheduling")
   151  	BackoffHistogramServerBusy = TiKVBackoffHistogram.WithLabelValues("serverBusy")
   152  	BackoffHistogramTiKVDiskFull = TiKVBackoffHistogram.WithLabelValues("tikvDiskFull")
   153  	BackoffHistogramStaleCmd = TiKVBackoffHistogram.WithLabelValues("staleCommand")
   154  	BackoffHistogramDataNotReady = TiKVBackoffHistogram.WithLabelValues("dataNotReady")
   155  	BackoffHistogramEmpty = TiKVBackoffHistogram.WithLabelValues("")
   156  
   157  	TxnRegionsNumHistogramWithSnapshot = TiKVTxnRegionsNumHistogram.WithLabelValues("snapshot")
   158  	TxnRegionsNumHistogramPrewrite = TiKVTxnRegionsNumHistogram.WithLabelValues("2pc_prewrite")
   159  	TxnRegionsNumHistogramCommit = TiKVTxnRegionsNumHistogram.WithLabelValues("2pc_commit")
   160  	TxnRegionsNumHistogramCleanup = TiKVTxnRegionsNumHistogram.WithLabelValues("2pc_cleanup")
   161  	TxnRegionsNumHistogramPessimisticLock = TiKVTxnRegionsNumHistogram.WithLabelValues("2pc_pessimistic_lock")
   162  	TxnRegionsNumHistogramPessimisticRollback = TiKVTxnRegionsNumHistogram.WithLabelValues("2pc_pessimistic_rollback")
   163  	TxnRegionsNumHistogramWithCoprocessor = TiKVTxnRegionsNumHistogram.WithLabelValues("coprocessor")
   164  	TxnRegionsNumHistogramWithBatchCoprocessor = TiKVTxnRegionsNumHistogram.WithLabelValues("batch_coprocessor")
   165  
   166  	LockResolverCountWithBatchResolve = TiKVLockResolverCounter.WithLabelValues("batch_resolve")
   167  	LockResolverCountWithExpired = TiKVLockResolverCounter.WithLabelValues("expired")
   168  	LockResolverCountWithNotExpired = TiKVLockResolverCounter.WithLabelValues("not_expired")
   169  	LockResolverCountWithWaitExpired = TiKVLockResolverCounter.WithLabelValues("wait_expired")
   170  	LockResolverCountWithResolve = TiKVLockResolverCounter.WithLabelValues("resolve")
   171  	LockResolverCountWithResolveForWrite = TiKVLockResolverCounter.WithLabelValues("resolve_for_write")
   172  	LockResolverCountWithResolveAsync = TiKVLockResolverCounter.WithLabelValues("resolve_async_commit")
   173  	LockResolverCountWithWriteConflict = TiKVLockResolverCounter.WithLabelValues("write_conflict")
   174  	LockResolverCountWithQueryTxnStatus = TiKVLockResolverCounter.WithLabelValues("query_txn_status")
   175  	LockResolverCountWithQueryTxnStatusCommitted = TiKVLockResolverCounter.WithLabelValues("query_txn_status_committed")
   176  	LockResolverCountWithQueryTxnStatusRolledBack = TiKVLockResolverCounter.WithLabelValues("query_txn_status_rolled_back")
   177  	LockResolverCountWithQueryCheckSecondaryLocks = TiKVLockResolverCounter.WithLabelValues("query_check_secondary_locks")
   178  	LockResolverCountWithResolveLocks = TiKVLockResolverCounter.WithLabelValues("query_resolve_locks")
   179  	LockResolverCountWithResolveLockLite = TiKVLockResolverCounter.WithLabelValues("query_resolve_lock_lite")
   180  
   181  	RegionCacheCounterWithInvalidateRegionFromCacheOK = TiKVRegionCacheCounter.WithLabelValues("invalidate_region_from_cache", "ok")
   182  	RegionCacheCounterWithSendFail = TiKVRegionCacheCounter.WithLabelValues("send_fail", "ok")
   183  	RegionCacheCounterWithGetRegionByIDOK = TiKVRegionCacheCounter.WithLabelValues("get_region_by_id", "ok")
   184  	RegionCacheCounterWithGetRegionByIDError = TiKVRegionCacheCounter.WithLabelValues("get_region_by_id", "err")
   185  	RegionCacheCounterWithGetRegionOK = TiKVRegionCacheCounter.WithLabelValues("get_region", "ok")
   186  	RegionCacheCounterWithGetRegionError = TiKVRegionCacheCounter.WithLabelValues("get_region", "err")
   187  	RegionCacheCounterWithScanRegionsOK = TiKVRegionCacheCounter.WithLabelValues("scan_regions", "ok")
   188  	RegionCacheCounterWithScanRegionsError = TiKVRegionCacheCounter.WithLabelValues("scan_regions", "err")
   189  	RegionCacheCounterWithGetStoreOK = TiKVRegionCacheCounter.WithLabelValues("get_store", "ok")
   190  	RegionCacheCounterWithGetStoreError = TiKVRegionCacheCounter.WithLabelValues("get_store", "err")
   191  	RegionCacheCounterWithInvalidateStoreRegionsOK = TiKVRegionCacheCounter.WithLabelValues("invalidate_store_regions", "ok")
   192  
   193  	TxnHeartBeatHistogramOK = TiKVTxnHeartBeatHistogram.WithLabelValues("ok")
   194  	TxnHeartBeatHistogramError = TiKVTxnHeartBeatHistogram.WithLabelValues("err")
   195  
   196  	StatusCountWithOK = TiKVStatusCounter.WithLabelValues("ok")
   197  	StatusCountWithError = TiKVStatusCounter.WithLabelValues("err")
   198  
   199  	SecondaryLockCleanupFailureCounterCommit = TiKVSecondaryLockCleanupFailureCounter.WithLabelValues("commit")
   200  	SecondaryLockCleanupFailureCounterRollback = TiKVSecondaryLockCleanupFailureCounter.WithLabelValues("rollback")
   201  
   202  	TwoPCTxnCounterOk = TiKVTwoPCTxnCounter.WithLabelValues("ok")
   203  	TwoPCTxnCounterError = TiKVTwoPCTxnCounter.WithLabelValues("err")
   204  
   205  	AsyncCommitTxnCounterOk = TiKVAsyncCommitTxnCounter.WithLabelValues("ok")
   206  	AsyncCommitTxnCounterError = TiKVAsyncCommitTxnCounter.WithLabelValues("err")
   207  
   208  	OnePCTxnCounterOk = TiKVOnePCTxnCounter.WithLabelValues("ok")
   209  	OnePCTxnCounterError = TiKVOnePCTxnCounter.WithLabelValues("err")
   210  	OnePCTxnCounterFallback = TiKVOnePCTxnCounter.WithLabelValues("fallback")
   211  
   212  	BatchRecvHistogramOK = TiKVBatchRecvLatency.WithLabelValues("ok")
   213  	BatchRecvHistogramError = TiKVBatchRecvLatency.WithLabelValues("err")
   214  }