promread

README

promread

---

The promread command provides cli interfaces to Prometheus's Remote Read server. The tool was created to aid debugging servers that implement remote_read api.

Installation

From releases:

sudo curl -sSL https://github.com/rjeczalik/promread/releases/download/v1.0.0/promread-v1-linux -o /usr/local/bin/promread
sudo chmod +x /usr/local/bin/promread

From source code:

go get github.com/rjeczalik/promread/cmd/promread

Usage

promread --url http://127.0.0.1:1234/api/v1/read --token bearertoken --input /tmp/request.json

Debug

The promread debug can be used to digest and display as json recorder http request/response pairs.

promread debug -i /tmp/service/service_namespace/trace_id.json

Documentation

Index

• type Client
  • func (c *Client) MakeRequest(r *prompb.ReadRequest) (*http.Request, error)
  • func (c *Client) Read(r *prompb.ReadRequest) (*prompb.ReadResponse, error)
  • func (c *Client) RegisterFlags(f *pflag.FlagSet)
• type URL
  • func (u *URL) Set(s string) error
  • func (u URL) String() string
  • func (u URL) Type() string

Types

type Client

type Client struct {
	Token string       // optional
	URL   URL          // required
	HTTP  *http.Client // http.DefaultClient if nil
}

func (*Client) MakeRequest

func (c *Client) MakeRequest(r *prompb.ReadRequest) (*http.Request, error)

func (*Client) Read

func (c *Client) Read(r *prompb.ReadRequest) (*prompb.ReadResponse, error)

func (*Client) RegisterFlags

func (c *Client) RegisterFlags(f *pflag.FlagSet)

type URL

type URL string

func (*URL) Set

func (u *URL) Set(s string) error

func (URL) String

func (u URL) String() string

func (URL) Type

func (u URL) Type() string