stats

Documentation

Overview

Package stats wraps Geni's /stats endpoint — the platform-wide statistics list.

Index

• type Client
  • func NewClient(t *transport.Client) *Client
  • func (c *Client) Get(ctx context.Context) (*Response, error)
• type Response

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client wraps a transport.Client with the /stats endpoint.

func NewClient

func NewClient(t *transport.Client) *Client

NewClient returns a stats Client that uses the supplied transport.

func (*Client) Get

func (c *Client) Get(ctx context.Context) (*Response, error)

Get fetches the platform-wide statistics list. The shape of individual entries is opaque to the client — see Response.Stats.

type Response

type Response struct {
	Stats []json.RawMessage `json:"stats,omitempty"`
}

Response is Geni's /stats response — an opaque list of "available statistics". The public docs describe the response as an array of hashes without enumerating fields, so each entry is kept as a raw JSON message; callers decode the specific stats they care about.