devserver

Documentation

Index

• func StartAgent(c Config)
• type Config
• type Server
  • func NewServer(config Config) *Server
  • func (s *Server) StartAsync(c Config)

Functions

func StartAgent

func StartAgent(c Config)

StartAgent start inner http server by config.

Types

type Config

type Config struct {
	Enabled        bool   `json:",default=true"`
	Host           string `json:",optional"`
	Port           int    `json:",default=6060"`
	MetricsPath    string `json:",default=/metrics"`
	HealthPath     string `json:",default=/healthz"`
	EnableMetrics  bool   `json:",default=true"`
	EnablePprof    bool   `json:",default=true"`
	HealthResponse string `json:",default=OK"`
}

Config is config for inner http server.

type Server

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

Server is an inner http server, expose some useful observability information of app. For example, health check, metrics and pprof.

func NewServer

func NewServer(config Config) *Server

NewServer returns a new inner http Server.

func (*Server) StartAsync

func (s *Server) StartAsync(c Config)

StartAsync start inner http server background.