profiler

README

Synopsis

1. Call NewProfiler to create a profiler instance. At this time, specify the directory to store the result of pprof.

2. Start webui with the port to see the profile results: go profiler.ListenAndServe(8080)

3. Start profiling by profiler.Start()

4. Stop profiling by profiler.Stop()

You can see the profiling results by accessing http://localhost:8080 in your browser. If you profile again, the latest results will be automatically reflected. If you want to see the previous result, you can also refer to the past result by specifying the number in the profiling order like http://localhost:8080/1/ .

package main

import (
  middlewaretools "github.com/goccy/echo-tools/middleware"
  profilertools "github.com/goccy/echo-tools/profiler"
  "github.com/labstack/echo/v4"
)

var (
  notifier = middlewaretools.NewBenchmarkFinishEventNotifier(onBenchmarkFinished)
  profiler = profilertools.NewProfiler("profile")
)

func startBenchmark(c echo.Context) error {
  notifier.Start()
  profiler.Start()
  return c.JSON(http.StatusOK, struct{}{})
}

func onBenchmarkFinished() {
  profiler.Stop()
}

func main() {
  go profiler.ListenAndServe(8080)
  e := echo.New()
  e.Use(notifier.Middleware())
}

Documentation

Index

• type AccessLogHandler
  • func (h *AccessLogHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type AccessLogProfiler
  • func NewAccessLogProfiler(e *echo.Echo, hostAddr string, opts ...AccessLogProfilerOption) *AccessLogProfiler
  • func (p *AccessLogProfiler) Start() error
  • func (p *AccessLogProfiler) Stop() error
• type AccessLogProfilerOption
  • func AccessLogDiscordNotifierOption(kataribeFile, botName, webhookURL, githubToken string) AccessLogProfilerOption
• type AccessLogRequest
• type MySQLSlowQueryLogHandler
  • func (h *MySQLSlowQueryLogHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type MySQLSlowQueryLogProfiler
  • func NewMySQLSlowQueryLogProfiler(e *echo.Echo, hostAddr string, db *sql.DB, ...) *MySQLSlowQueryLogProfiler
  • func (p *MySQLSlowQueryLogProfiler) Start() error
  • func (p *MySQLSlowQueryLogProfiler) Stop() error
• type MySQLSlowQueryLogProfilerOption
  • func MySQLSlowQueryLogDiscordNotifierOption(botName, webhookURL, githubToken string) MySQLSlowQueryLogProfilerOption
• type MySQLSlowQueryLogRequest
• type Profiler
  • func NewProfiler(baseDir string) *Profiler
  • func (p *Profiler) AddProfiler(profiler SubProfiler)
  • func (p *Profiler) ListenAndServe(port uint16) error
  • func (p *Profiler) Start() error
  • func (p *Profiler) Stop() error
• type SubProfiler

Types

type AccessLogHandler

type AccessLogHandler struct{}

func (*AccessLogHandler) ServeHTTP

func (h *AccessLogHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type AccessLogProfiler

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

func NewAccessLogProfiler

func NewAccessLogProfiler(e *echo.Echo, hostAddr string, opts ...AccessLogProfilerOption) *AccessLogProfiler

func (*AccessLogProfiler) Start

func (p *AccessLogProfiler) Start() error

func (*AccessLogProfiler) Stop

func (p *AccessLogProfiler) Stop() error

type AccessLogProfilerOption

type AccessLogProfilerOption func(*AccessLogProfiler)

func AccessLogDiscordNotifierOption

func AccessLogDiscordNotifierOption(kataribeFile, botName, webhookURL, githubToken string) AccessLogProfilerOption

type AccessLogRequest

type AccessLogRequest struct {
	FileName          string `json:"filename"`
	KataribeConfPath  string `json:"kataribeConfPath"`
	BotName           string `json:"botName"`
	GitHubToken       string `json:"githubToken"`
	DiscordWebhookURL string `json:"discordWebhookURL"`
}

type MySQLSlowQueryLogHandler

type MySQLSlowQueryLogHandler struct{}

func (*MySQLSlowQueryLogHandler) ServeHTTP

func (h *MySQLSlowQueryLogHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type MySQLSlowQueryLogProfiler

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

func NewMySQLSlowQueryLogProfiler

func NewMySQLSlowQueryLogProfiler(e *echo.Echo, hostAddr string, db *sql.DB, opts ...MySQLSlowQueryLogProfilerOption) *MySQLSlowQueryLogProfiler

func (*MySQLSlowQueryLogProfiler) Start

func (p *MySQLSlowQueryLogProfiler) Start() error

func (*MySQLSlowQueryLogProfiler) Stop

func (p *MySQLSlowQueryLogProfiler) Stop() error

type MySQLSlowQueryLogProfilerOption

type MySQLSlowQueryLogProfilerOption func(*MySQLSlowQueryLogProfiler)

func MySQLSlowQueryLogDiscordNotifierOption

func MySQLSlowQueryLogDiscordNotifierOption(botName, webhookURL, githubToken string) MySQLSlowQueryLogProfilerOption

type MySQLSlowQueryLogRequest

type MySQLSlowQueryLogRequest struct {
	FileName          string `json:"filename"`
	BotName           string `json:"botName"`
	GitHubToken       string `json:"githubToken"`
	DiscordWebhookURL string `json:"discordWebhookURL"`
}

type Profiler

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

func NewProfiler

func NewProfiler(baseDir string) *Profiler

func (*Profiler) AddProfiler

func (p *Profiler) AddProfiler(profiler SubProfiler)

func (*Profiler) ListenAndServe

func (p *Profiler) ListenAndServe(port uint16) error

func (*Profiler) Start

func (p *Profiler) Start() error

func (*Profiler) Stop

func (p *Profiler) Stop() error

type SubProfiler

type SubProfiler interface {
	Start() error
	Stop() error
}