mirror of
https://github.com/labstack/echo.git
synced 2024-12-24 20:14:31 +02:00
99 lines
2.3 KiB
Markdown
99 lines
2.3 KiB
Markdown
|
+++
|
||
|
|
title = "Customization"
|
||
|
|
description = "Customizing Echo"
|
||
|
|
[menu.side]
|
||
|
|
name = "Customization"
|
||
|
|
parent = "guide"
|
||
|
|
weight = 3
|
||
|
|
+++
|
||
|
|
|
||
|
|
## Customization
|
||
|
|
|
||
|
|
### HTTP Error Handler
|
||
|
|
|
||
|
|
`Echo#SetHTTPErrorHandler(h HTTPErrorHandler)` registers a custom `Echo#HTTPErrorHandler`.
|
||
|
|
|
||
|
|
Default HTTP error handler rules:
|
||
|
|
|
||
|
|
- If error is of type `Echo#HTTPError` it sends HTTP response with status code `HTTPError.Code`
|
||
|
|
and message `HTTPError.Message`.
|
||
|
|
- Else it sends `500 - Internal Server Error`.
|
||
|
|
- If debug mode is enabled, it uses `error.Error()` as status message.
|
||
|
|
|
||
|
|
### Debug
|
||
|
|
|
||
|
|
`Echo#SetDebug(on bool)` enable/disable debug mode.
|
||
|
|
|
||
|
|
### Logging
|
||
|
|
|
||
|
|
#### Custom Logger
|
||
|
|
|
||
|
|
`Echo#SetLogger(l log.Logger)`
|
||
|
|
|
||
|
|
SetLogger defines a custom logger.
|
||
|
|
|
||
|
|
#### Log Output
|
||
|
|
|
||
|
|
`Echo#SetLogOutput(w io.Writer)` sets the output destination for the logger. Default
|
||
|
|
value `os.Stdout`
|
||
|
|
|
||
|
|
To completely disable logs use `Echo#SetLogOutput(io.Discard)`
|
||
|
|
|
||
|
|
#### Log Level
|
||
|
|
|
||
|
|
`Echo#SetLogLevel(l log.Level)`
|
||
|
|
|
||
|
|
SetLogLevel sets the log level for the logger. Default value `5` (OFF).
|
||
|
|
Possible values:
|
||
|
|
|
||
|
|
- `0` (DEBUG)
|
||
|
|
- `1` (INFO)
|
||
|
|
- `2` (WARN)
|
||
|
|
- `3` (ERROR)
|
||
|
|
- `4` (FATAL)
|
||
|
|
- `5` (OFF)
|
||
|
|
|
||
|
|
### HTTP Engine
|
||
|
|
|
||
|
|
Echo currently supports standard and [fasthttp](https://github.com/valyala/fasthttp)
|
||
|
|
server engines. Echo utilizes interfaces to abstract the internal implementation
|
||
|
|
of these servers so you can seamlessly switch from one engine to another based on
|
||
|
|
your preference.
|
||
|
|
|
||
|
|
#### Running a standard HTTP server
|
||
|
|
|
||
|
|
`e.Run(standard.New(":1323"))`
|
||
|
|
|
||
|
|
#### Running a fasthttp server
|
||
|
|
|
||
|
|
`e.Run(fasthttp.New(":1323"))`
|
||
|
|
|
||
|
|
#### Running a server with TLS configuration
|
||
|
|
|
||
|
|
`e.Run(<engine>.WithTLS(":1323", "<certFile>", "<keyFile>"))`
|
||
|
|
|
||
|
|
#### Running a server with engine configuration
|
||
|
|
|
||
|
|
`e.Run(<engine>.WithConfig(<config>))`
|
||
|
|
|
||
|
|
##### Configuration
|
||
|
|
|
||
|
|
```go
|
||
|
|
Config struct {
|
||
|
|
Address string // TCP address to listen on.
|
||
|
|
Listener net.Listener // Custom `net.Listener`. If set, server accepts connections on it.
|
||
|
|
TLSCertFile string // TLS certificate file path.
|
||
|
|
TLSKeyFile string // TLS key file path.
|
||
|
|
ReadTimeout time.Duration // Maximum duration before timing out read of the request.
|
||
|
|
WriteTimeout time.Duration // Maximum duration before timing out write of the response.
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
#### Access internal server instance and configure its properties
|
||
|
|
|
||
|
|
```go
|
||
|
|
s := standard.New(":1323")
|
||
|
|
s.MaxHeaderBytes = 1 << 20
|
||
|
|
e.Run(s)
|
||
|
|
```
|