github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/x/debug/ext/ext.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 extdebug contains helpers for more detailed debug information
    22  package extdebug
    23  
    24  import (
    25  	"fmt"
    26  	"time"
    27  
    28  	clusterclient "github.com/m3db/m3/src/cluster/client"
    29  	"github.com/m3db/m3/src/cluster/placementhandler"
    30  	"github.com/m3db/m3/src/cluster/placementhandler/handleroptions"
    31  	"github.com/m3db/m3/src/x/debug"
    32  	"github.com/m3db/m3/src/x/instrument"
    33  )
    34  
    35  // NewPlacementAndNamespaceZipWriterWithDefaultSources returns a zipWriter with the following
    36  // debug sources already registered: CPU, heap, host, goroutines, namespace and placement info.
    37  func NewPlacementAndNamespaceZipWriterWithDefaultSources(
    38  	cpuProfileDuration time.Duration,
    39  	clusterClient clusterclient.Client,
    40  	placementsOpts placementhandler.HandlerOptions,
    41  	services []handleroptions.ServiceNameAndDefaults,
    42  	instrumentOpts instrument.Options,
    43  ) (debug.ZipWriter, error) {
    44  	zw, err := debug.NewZipWriterWithDefaultSources(cpuProfileDuration,
    45  		instrumentOpts)
    46  	if err != nil {
    47  		return nil, err
    48  	}
    49  
    50  	if clusterClient != nil {
    51  		nsSource, err := NewNamespaceInfoSource(clusterClient, services, instrumentOpts)
    52  		if err != nil {
    53  			return nil, fmt.Errorf("could not create namespace info source: %w", err)
    54  		}
    55  
    56  		err = zw.RegisterSource("namespace.json", nsSource)
    57  		if err != nil {
    58  			return nil, fmt.Errorf("unable to register namespaceSource: %w", err)
    59  		}
    60  
    61  		for _, service := range services {
    62  			placementInfoSource, err := NewPlacementInfoSource(service, placementsOpts)
    63  			if err != nil {
    64  				return nil, fmt.Errorf("unable to create placementInfoSource: %w", err)
    65  			}
    66  			fileName := fmt.Sprintf("placement-%s.json", service.ServiceName)
    67  			err = zw.RegisterSource(fileName, placementInfoSource)
    68  			if err != nil {
    69  				return nil, fmt.Errorf("unable to register placementSource: %w", err)
    70  			}
    71  		}
    72  	}
    73  
    74  	return zw, nil
    75  }