github.com/m3db/m3@v1.5.0/src/query/api/v1/handler/prometheus/handleroptions/options.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 handleroptions
    22  
    23  import (
    24  	"time"
    25  
    26  	"github.com/m3db/m3/src/x/retry"
    27  )
    28  
    29  // PromWriteHandlerForwardingOptions is the forwarding
    30  // options for prometheus write handler.
    31  type PromWriteHandlerForwardingOptions struct {
    32  	// MaxConcurrency is the max parallel forwarding and if zero will be unlimited.
    33  	MaxConcurrency int                                    `yaml:"maxConcurrency"`
    34  	Timeout        time.Duration                          `yaml:"timeout"`
    35  	Retry          *retry.Configuration                   `yaml:"retry"`
    36  	Targets        []PromWriteHandlerForwardTargetOptions `yaml:"targets"`
    37  }
    38  
    39  // PromWriteHandlerForwardTargetOptions is a prometheus write
    40  // handler forwarder target.
    41  type PromWriteHandlerForwardTargetOptions struct {
    42  	// URL of the target to send to.
    43  	URL string `yaml:"url"`
    44  	// Method defaults to POST if not set.
    45  	Method string `yaml:"method"`
    46  	// Headers to send along with requests to the target.
    47  	Headers map[string]string `yaml:"headers"`
    48  }