endpoints

Documentation

Overview

Wrappers for receivers from the common/stats package and setting up an HTTP server with endpoints to make the stats data accessible.

Index

• func MakeStatsReceiver(scope StatScope) stats.StatsReceiver
• func Module() ice.Module
• func RunServer(bag *ice.MagicBag, schema jsonconfig.Schema, config []byte)
• type Addr
• type StatScope
• type TwitterServer
  • func NewTwitterServer(addr Addr, stats stats.StatsReceiver, handlers map[string]http.Handler) *TwitterServer
  • func (s *TwitterServer) Serve() error

Functions

func MakeStatsReceiver

func MakeStatsReceiver(scope StatScope) stats.StatsReceiver

Create a finagle-style stats receiver with a reasonable latch default, minutely.

func Module

func Module() ice.Module

Module returns a module that supports serving HTTP Important to also install a function that returns map[string]http.Handler

func RunServer

func RunServer(bag *ice.MagicBag, schema jsonconfig.Schema, config []byte)

Starts the Server based on the MagicBag and config schema provided this method blocks until the server completes running or an error occurs.

Types

type Addr

type Addr string

type StatScope

type StatScope string

type TwitterServer

type TwitterServer struct {
	Addr     string
	Stats    stats.StatsReceiver
	Handlers map[string]http.Handler
}

TODO(dbentley): rename to ObservableServer(?) A stats receiver that provides HTTP access for metric scraping with Twitter-style endpoints.

func NewTwitterServer

func NewTwitterServer(addr Addr, stats stats.StatsReceiver, handlers map[string]http.Handler) *TwitterServer

Returns an http handler at 'addr'

func (*TwitterServer) Serve

func (s *TwitterServer) Serve() error