dubbo.apache.org/dubbo-go/v3@v3.1.1/cluster/metrics/metrics.go (about)

     1  /*
     2   * Licensed to the Apache Software Foundation (ASF) under one or more
     3   * contributor license agreements.  See the NOTICE file distributed with
     4   * this work for additional information regarding copyright ownership.
     5   * The ASF licenses this file to You under the Apache License, Version 2.0
     6   * (the "License"); you may not use this file except in compliance with
     7   * the License.  You may obtain a copy of the License at
     8   *
     9   *     http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   */
    17  
    18  package metrics
    19  
    20  import (
    21  	"github.com/pkg/errors"
    22  )
    23  
    24  import (
    25  	"dubbo.apache.org/dubbo-go/v3/common"
    26  )
    27  
    28  var (
    29  	ErrMetricsNotFound = errors.New("metrics not found")
    30  )
    31  
    32  type Metrics interface {
    33  	// GetMethodMetrics returns method-level metrics, the format of key is "{instance key}.{invoker key}.{method key}.{key}"
    34  	// url is invoker's url, which contains information about instance and invoker.
    35  	// methodName is the method name.
    36  	// key is the key of the metrics.
    37  	GetMethodMetrics(url *common.URL, methodName, key string) (interface{}, error)
    38  	SetMethodMetrics(url *common.URL, methodName, key string, value interface{}) error
    39  
    40  	// GetInvokerMetrics returns invoker-level metrics, the format of key is "{instance key}.{invoker key}.{key}"
    41  	// DO NOT IMPLEMENT FOR EARLIER VERSION
    42  	GetInvokerMetrics(url *common.URL, key string) (interface{}, error)
    43  	SetInvokerMetrics(url *common.URL, key string, value interface{}) error
    44  
    45  	// GetInstanceMetrics returns instance-level metrics, the format of key is "{instance key}.{key}"
    46  	// DO NOT IMPLEMENT FOR EARLIER VERSION
    47  	GetInstanceMetrics(url *common.URL, key string) (interface{}, error)
    48  	SetInstanceMetrics(url *common.URL, key string, value interface{}) error
    49  }