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

     1  // Copyright (c) 2019 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
    22  
    23  import (
    24  	"errors"
    25  	"fmt"
    26  	"io"
    27  	"net/http"
    28  
    29  	"github.com/gogo/protobuf/jsonpb"
    30  
    31  	"github.com/m3db/m3/src/cluster/placementhandler"
    32  	"github.com/m3db/m3/src/cluster/placementhandler/handleroptions"
    33  	"github.com/m3db/m3/src/query/generated/proto/admin"
    34  	"github.com/m3db/m3/src/x/debug"
    35  )
    36  
    37  type placementInfoSource struct {
    38  	getHandler *placementhandler.GetHandler
    39  	service    handleroptions.ServiceNameAndDefaults
    40  }
    41  
    42  // NewPlacementInfoSource returns a Source for placement information.
    43  func NewPlacementInfoSource(
    44  	service handleroptions.ServiceNameAndDefaults,
    45  	placementOpts placementhandler.HandlerOptions,
    46  ) (debug.Source, error) {
    47  	handler := placementhandler.NewGetHandler(placementOpts)
    48  	return &placementInfoSource{
    49  		getHandler: handler,
    50  		service:    service,
    51  	}, nil
    52  }
    53  
    54  // Write fetches data about the placement and writes it in the given writer.
    55  // The data is formatted in json.
    56  func (p *placementInfoSource) Write(w io.Writer, httpReq *http.Request) error {
    57  	placement, err := p.getHandler.Get(p.service, httpReq)
    58  	if err != nil {
    59  		return err
    60  	}
    61  
    62  	if placement == nil {
    63  		return errors.New("placement does not exist")
    64  	}
    65  
    66  	placementProto, err := placement.Proto()
    67  	if err != nil {
    68  		return fmt.Errorf("unable to get placement protobuf: %v", err)
    69  	}
    70  
    71  	resp := &admin.PlacementGetResponse{
    72  		Placement: placementProto,
    73  		Version:   int32(placement.Version()),
    74  	}
    75  
    76  	marshaler := jsonpb.Marshaler{EmitDefaults: true}
    77  	return marshaler.Marshal(w, resp)
    78  }