github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/cdc/processor/sinkmanager/metrics.go (about)

     1  // Copyright 2022 PingCAP, Inc.
     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  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package sinkmanager
    15  
    16  import (
    17  	"github.com/prometheus/client_golang/prometheus"
    18  )
    19  
    20  var (
    21  	// RedoEventCache indicates redo event memory usage of a changefeed.
    22  	RedoEventCache = prometheus.NewGaugeVec(
    23  		prometheus.GaugeOpts{
    24  			Namespace: "ticdc",
    25  			Subsystem: "sinkmanager",
    26  			Name:      "redo_event_cache",
    27  			Help:      "redo event cache of the changefeed",
    28  		},
    29  		[]string{"namespace", "changefeed"})
    30  
    31  	// RedoEventCacheAccess indicates redo event cache hit ratio of a changefeed.
    32  	RedoEventCacheAccess = prometheus.NewCounterVec(
    33  		prometheus.CounterOpts{
    34  			Namespace: "ticdc",
    35  			Subsystem: "sinkmanager",
    36  			Name:      "redo_event_cache_access",
    37  			Help:      "redo event cache access, including hit and miss",
    38  		},
    39  		// type includes hit and miss.
    40  		[]string{"namespace", "changefeed", "type"})
    41  
    42  	// outputEventCount is the metric that counts events output by the sorter.
    43  	outputEventCount = prometheus.NewCounterVec(prometheus.CounterOpts{
    44  		Namespace: "ticdc",
    45  		Subsystem: "sorter",
    46  		Name:      "output_event_count",
    47  		Help:      "The number of events output by the sorter",
    48  	}, []string{"namespace", "changefeed", "type"})
    49  )
    50  
    51  // InitMetrics registers all metrics in this file.
    52  func InitMetrics(registry *prometheus.Registry) {
    53  	registry.MustRegister(RedoEventCache)
    54  	registry.MustRegister(RedoEventCacheAccess)
    55  	registry.MustRegister(outputEventCount)
    56  }