diago

README

Diago

Diago: the addictive tool. Friendly design, logging

Versions

How it looks ?

Introduction

Diago is diagnostic panel wrote in go for websites. It should help you improve, debug your application.

Latency Extension

⚠️ If you want use Latency Extension than You must register it as first!

Route Extension

Route extension was moved to gouef/router

Custom Extension

You can write your own extension, Diago is ready for it!

You must use interface DiagoExtension.

For inspiration I recommend look to exists extensions.

Contributors

Documentation

Index

• Constants
• Variables
• func GetDiagoLatencyPanelTemplate() string
• func GetDiagoPanelTemplate() string
• func Middleware(r *router.Router, d *Diago) gin.HandlerFunc
• type ContentType
• type Data
• type DefaultPanelGenerator
  • func NewDefaultPanelGenerator() *DefaultPanelGenerator
  • func (d *DefaultPanelGenerator) GenerateHTML(name string, templateProvider TemplateProvider, data interface{}) (string, error)
• type DefaultTemplateProvider
  • func NewDefaultTemplateProvider() *DefaultTemplateProvider
  • func (p DefaultTemplateProvider) GetTemplate() string
• type Diago
  • func NewDiago() *Diago
  • func (d *Diago) AddContentCharset(charset string) *Diago
  • func (d *Diago) AddContentType(typeString string) *Diago
  • func (d *Diago) AddExtension(extension Extension) *Diago
  • func (d *Diago) ContainsMIME(header string) bool
  • func (d *Diago) GetExtensions() []Extension
  • func (d *Diago) SetAllowedContentTypes(contentType ContentType) *Diago
• type Extension
• type PanelGenerator
• type TemplateProvider

Constants

const (
	ContentType_HTML  = "text/html"
	ContentType_PLAIN = "text/plain"

	Charset_UTF8 = "utf-8"
	Charset_ALL  = "*"
)

Variables

var DiagoLatencyPanelTemplate string

var DiagoPanelTemplate string

Functions

func GetDiagoLatencyPanelTemplate

func GetDiagoLatencyPanelTemplate() string

func GetDiagoPanelTemplate

func GetDiagoPanelTemplate() string

func Middleware

func Middleware(r *router.Router, d *Diago) gin.HandlerFunc

Types

type ContentType

type ContentType struct {
	Types    []string
	Charsets []string
}

type Data

type Data struct {
	ExtensionsPanelHtml []template.HTML
	ExtensionsJSHtml    []template.HTML
	ExtensionsHtml      []template.HTML
}

type DefaultPanelGenerator

type DefaultPanelGenerator struct{}

func NewDefaultPanelGenerator

func NewDefaultPanelGenerator() *DefaultPanelGenerator

func (*DefaultPanelGenerator) GenerateHTML

func (d *DefaultPanelGenerator) GenerateHTML(name string, templateProvider TemplateProvider, data interface{}) (string, error)

type DefaultTemplateProvider

type DefaultTemplateProvider struct{}

func NewDefaultTemplateProvider

func NewDefaultTemplateProvider() *DefaultTemplateProvider

func (DefaultTemplateProvider) GetTemplate

func (p DefaultTemplateProvider) GetTemplate() string

type Diago

type Diago struct {
	Extensions          []Extension
	TemplateProvider    TemplateProvider
	PanelGenerator      PanelGenerator
	AllowedContentTypes ContentType
}

func NewDiago

func NewDiago() *Diago

func (*Diago) AddContentCharset

func (d *Diago) AddContentCharset(charset string) *Diago

func (*Diago) AddContentType

func (d *Diago) AddContentType(typeString string) *Diago

func (*Diago) AddExtension

func (d *Diago) AddExtension(extension Extension) *Diago

func (*Diago) ContainsMIME

func (d *Diago) ContainsMIME(header string) bool

func (*Diago) GetExtensions

func (d *Diago) GetExtensions() []Extension

func (*Diago) SetAllowedContentTypes

func (d *Diago) SetAllowedContentTypes(contentType ContentType) *Diago

type Extension

type Extension interface {
	GetPanelHtml(c *gin.Context) string
	GetHtml(c *gin.Context) string
	GetJSHtml(c *gin.Context) string
	BeforeNext(c *gin.Context)
	AfterNext(c *gin.Context)
	SetTemplateProvider(provider TemplateProvider)
	GetTemplateProvider() TemplateProvider
	SetPanelGenerator(generator PanelGenerator)
	GetPanelGenerator() PanelGenerator
}

type PanelGenerator

type PanelGenerator interface {
	GenerateHTML(name string, templateProvider TemplateProvider, data interface{}) (string, error)
}

type TemplateProvider

type TemplateProvider interface {
	GetTemplate() string
}