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

     1  // Copyright (c) 2016 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 instrument
    22  
    23  import (
    24  	"os"
    25  	"time"
    26  
    27  	"github.com/m3db/m3/src/x/process"
    28  
    29  	"github.com/uber-go/tally"
    30  )
    31  
    32  type processReporter struct {
    33  	baseReporter
    34  
    35  	metrics processMetrics
    36  }
    37  
    38  type processMetrics struct {
    39  	NumFDs      tally.Gauge
    40  	NumFDErrors tally.Counter
    41  	pid         int
    42  }
    43  
    44  func (r *processMetrics) report() {
    45  	numFDs, err := process.NumFDsWithDefaultBatchSleep(r.pid)
    46  	if err == nil {
    47  		r.NumFDs.Update(float64(numFDs))
    48  	} else {
    49  		r.NumFDErrors.Inc(1)
    50  	}
    51  }
    52  
    53  // NewProcessReporter returns a new reporter that reports process
    54  // metrics, currently just the process file descriptor count.
    55  func NewProcessReporter(
    56  	scope tally.Scope,
    57  	reportInterval time.Duration,
    58  ) Reporter {
    59  	r := new(processReporter)
    60  	r.init(reportInterval, r.metrics.report)
    61  
    62  	processScope := scope.SubScope("process")
    63  	r.metrics.NumFDs = processScope.Gauge("num-fds")
    64  	r.metrics.NumFDErrors = processScope.Counter("num-fd-errors")
    65  	r.metrics.pid = os.Getpid()
    66  
    67  	return r
    68  }