github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/server/limits.go (about)

     1  // Copyright (c) 2018 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 server
    22  
    23  import (
    24  	"fmt"
    25  
    26  	xerror "github.com/m3db/m3/src/x/errors"
    27  	xos "github.com/m3db/m3/src/x/os"
    28  )
    29  
    30  const (
    31  	// TODO: determine these values based on topology/namespace configuration.
    32  	minNoFile = 3000000
    33  	// NB(schallert): If updating these values, be sure to update the associated
    34  	// Dockerfile and kube daemonset (see https://github.com/m3db/m3/pull/1436 for
    35  	// example).
    36  	minVMMapCount = 3000000
    37  	maxSwappiness = 1
    38  )
    39  
    40  func canValidateProcessLimits() (bool, string) {
    41  	return xos.CanGetProcessLimits()
    42  }
    43  
    44  func validateProcessLimits() error {
    45  	limits, err := xos.GetProcessLimits()
    46  	if err != nil {
    47  		return fmt.Errorf("unable to determine process limits: %v", err)
    48  	}
    49  
    50  	var multiErr xerror.MultiError
    51  	if limits.NoFileCurr < minNoFile {
    52  		multiErr = multiErr.Add(fmt.Errorf(
    53  			"current value for RLIMIT_NOFILE(%d) is below recommended threshold(%d)",
    54  			limits.NoFileCurr, minNoFile,
    55  		))
    56  	}
    57  
    58  	if limits.NoFileMax < minNoFile {
    59  		multiErr = multiErr.Add(fmt.Errorf(
    60  			"max value for RLIMIT_NOFILE(%d) is below recommended threshold(%d)",
    61  			limits.NoFileMax, minNoFile,
    62  		))
    63  	}
    64  
    65  	if limits.VMMaxMapCount < minVMMapCount {
    66  		multiErr = multiErr.Add(fmt.Errorf(
    67  			"current value for vm.max_map_count(%d) is below recommended threshold(%d)",
    68  			limits.VMMaxMapCount, minVMMapCount,
    69  		))
    70  	}
    71  
    72  	if limits.VMSwappiness > maxSwappiness {
    73  		multiErr = multiErr.Add(fmt.Errorf(
    74  			"current value for vm.swappiness(%d) is above recommended threshold(%d)",
    75  			limits.VMSwappiness, maxSwappiness,
    76  		))
    77  	}
    78  
    79  	return multiErr.FinalError()
    80  }