github.com/XiaoMi/Gaea@v1.2.5/stats/variable_interface.go (about)

     1  /*
     2  Copyright 2018 The Vitess Authors
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package stats
    18  
    19  // Variable is the minimal interface which each type in this "stats" package
    20  // must implement.
    21  // When integrating the Vitess stats types ("variables") with the different
    22  // monitoring systems, you can rely on this interface.
    23  type Variable interface {
    24  	// Help returns the description of the variable.
    25  	Help() string
    26  
    27  	// String must implement String() from the expvar.Var interface.
    28  	String() string
    29  }