github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/pkg/sink/codec/common/metrics.go (about)

     1  // Copyright 2023 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 common
    15  
    16  import (
    17  	"github.com/pingcap/tiflow/cdc/model"
    18  	"github.com/prometheus/client_golang/prometheus"
    19  )
    20  
    21  var compressionRatio = prometheus.NewHistogramVec(
    22  	prometheus.HistogramOpts{
    23  		Namespace: "ticdc",
    24  		Subsystem: "kafka_sink",
    25  		Name:      "codec_compression_ratio",
    26  		Help:      "The TiCDC kafka sink codec compression ratio",
    27  		Buckets:   prometheus.LinearBuckets(0, 1, 20),
    28  	}, []string{"namespace", "changefeed"})
    29  
    30  // InitMetrics registers all metrics in this file
    31  func InitMetrics(registry *prometheus.Registry) {
    32  	registry.MustRegister(compressionRatio)
    33  }
    34  
    35  // CleanMetrics remove metrics belong to the given changefeed.
    36  func CleanMetrics(changefeedID model.ChangeFeedID) {
    37  	compressionRatio.DeleteLabelValues(changefeedID.Namespace, changefeedID.ID)
    38  }