Documentation
¶
Overview ¶
@title SYNAPSE @version 0.0.1 @description this is a synapse manager. @contact.url https://github.com/jaehoonkim/synapse @contact.email jaehoon@gmail.io @securityDefinitions.apikey ClientAuth @in header @name x-synapse-agent-token @description token for client api @securityDefinitions.apikey XAuthToken @in header @name x_auth_token @description limit for access synapse api
Index ¶
- Variables
- func AgentSessionToken(db *sql.DB, dialect excute.SqlExcutor) echo.MiddlewareFunc
- func Logger() echo.MiddlewareFunc
- func LoggerWithConfig(config LoggerConfig) echo.MiddlewareFunc
- func ParseTemplate(template, starttag, endtag string) (texts [][]byte, tags []string, err error)
- func ServiceAuthorizationBearerToken() echo.MiddlewareFunc
- func Start(e *echo.Echo, port int32) error
- func StartTLS(e *echo.Echo, port int32, crt, key []byte) error
- func XAuthToken(cfg *config.Config) echo.MiddlewareFunc
- type LoggerConfig
- type Route
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // DefaultLoggerConfig is the default Logger middleware config. DefaultLoggerConfig = LoggerConfig{ Skipper: middleware.DefaultSkipper, Format: `{"time":"${time_rfc3339_nano}","id":"${id}","remote_ip":"${remote_ip}",` + `"host":"${host}","method":"${method}","uri":"${uri}","user_agent":"${user_agent}",` + `"status":${status},"error":"${error}","latency":${latency},"latency_human":"${latency_human}"` + `,"bytes_in":${bytes_in},"bytes_out":${bytes_out}}` + "\n", CustomTimeFormat: "2006-01-02 15:04:05.00000", // contains filtered or unexported fields } )
Functions ¶
func AgentSessionToken ¶
func AgentSessionToken(db *sql.DB, dialect excute.SqlExcutor) echo.MiddlewareFunc
func Logger ¶
func Logger() echo.MiddlewareFunc
Logger returns a middleware that logs HTTP requests.
func LoggerWithConfig ¶
func LoggerWithConfig(config LoggerConfig) echo.MiddlewareFunc
LoggerWithConfig returns a Logger middleware with config. See: `Logger()`.
func ParseTemplate ¶
func ServiceAuthorizationBearerToken ¶
func ServiceAuthorizationBearerToken() echo.MiddlewareFunc
func XAuthToken ¶
func XAuthToken(cfg *config.Config) echo.MiddlewareFunc
Types ¶
type LoggerConfig ¶
type LoggerConfig struct {
// Skipper defines a function to skip middleware.
Skipper middleware.Skipper
// Tags to construct the logger format.
//
// - time_unix
// - time_unix_nano
// - time_rfc3339
// - time_rfc3339_nano
// - time_custom
// - id (Request ID)
// - remote_ip
// - uri
// - host
// - method
// - path
// - protocol
// - referer
// - user_agent
// - status
// - error
// - latency (In nanoseconds)
// - latency_human (Human readable)
// - bytes_in (Bytes received)
// - bytes_out (Bytes sent)
// - header:<NAME>
// - query:<NAME>
// - form:<NAME>
//
// Example "${remote_ip} ${status}"
//
// Optional. Default value DefaultLoggerConfig.Format.
Format string `yaml:"format"`
// Optional. Default value DefaultLoggerConfig.CustomTimeFormat.
CustomTimeFormat string `yaml:"custom_time_format"`
// Output is a writer where logs in JSON format are written.
// Optional. Default value os.Stdout.
Output io.Writer
// contains filtered or unexported fields
}
LoggerConfig defines the config for Logger middleware.
Source Files
¶
Click to show internal directories.
Click to hide internal directories.