github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/x/debug/config/config.go (about)

     1  // Copyright (c) 2020 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package config
    22  
    23  import (
    24  	"fmt"
    25  	"runtime"
    26  
    27  	"go.uber.org/zap"
    28  )
    29  
    30  // DebugConfiguration for the debug package.
    31  type DebugConfiguration struct {
    32  
    33  	// MutexProfileFraction is used to set the runtime.SetMutexProfileFraction to report mutex contention events.
    34  	// See https://tip.golang.org/pkg/runtime/#SetMutexProfileFraction for more details about the value.
    35  	MutexProfileFraction int `yaml:"mutexProfileFraction"`
    36  
    37  	// BlockProfileRate is used to set the runtime.BlockProfileRate to report blocking events
    38  	// See https://golang.org/pkg/runtime/#SetBlockProfileRate for more details about the value.
    39  	BlockProfileRate int `yaml:"blockProfileRate"`
    40  }
    41  
    42  // SetRuntimeValues sets the configured pprof runtime values.
    43  func (c DebugConfiguration) SetRuntimeValues(logger *zap.Logger) {
    44  	logger.Info(fmt.Sprintf("setting MutexProfileFraction: %v", c.MutexProfileFraction))
    45  	runtime.SetMutexProfileFraction(c.MutexProfileFraction)
    46  	logger.Info(fmt.Sprintf("setting BlockProfileRate: %v", c.BlockProfileRate))
    47  	runtime.SetBlockProfileRate(c.BlockProfileRate)
    48  }