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

     1  // Copyright (c) 2021 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  // NoOpProfiler is default disabled profiler.
    24  type NoOpProfiler struct{}
    25  
    26  // NewNoOpProfiler creates a new no-op profiler.
    27  func NewNoOpProfiler() *NoOpProfiler {
    28  	return &NoOpProfiler{}
    29  }
    30  
    31  // StartCPUProfile starts named cpu profile.
    32  func (f NoOpProfiler) StartCPUProfile(name string) error {
    33  	return nil
    34  }
    35  
    36  // StopCPUProfile stops started cpu profile.
    37  func (f NoOpProfiler) StopCPUProfile() error {
    38  	return nil
    39  }
    40  
    41  // WriteHeapProfile writes named heap profile.
    42  func (f NoOpProfiler) WriteHeapProfile(name string) error {
    43  	return nil
    44  }