open-im-server/pkg/common/prommetrics/gin_api.go

// Copyright © 2023 OpenIM. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package prommetrics

import ginProm "github.com/openimsdk/open-im-server/v3/pkg/common/ginprometheus"

/*
labels := prometheus.Labels{"label_one": "any", "label_two": "value"}
ApiCustomCnt.MetricCollector.(*prometheus.CounterVec).With(labels).Inc().
*/
var (
	ApiCustomCnt = &ginProm.Metric{
		Name:        "custom_total",
		Description: "Custom counter events.",
		Type:        "counter_vec",
		Args:        []string{"label_one", "label_two"},
	}
)