adalal/gotenberg
1
0
Fork 0
mirror of https://github.com/gotenberg/gotenberg.git synced 2026-08-08 00:22:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

improving logging

Browse Source
This commit is contained in:
Julien Neuhart
2019-07-08 11:06:26 +02:00
parent 5af01505c2
commit 70b185a37a
11 changed files with 49 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
cmd/gotenberg/main.go
View File

@@ -26,6 +26,7 @@ func main() {
systemLogger.FatalOp(op, err)
}
systemLogger.InfofOp(op, "Gotenberg %s", version)
systemLogger.DebugfOp(op, "configuration: %+v", config)
// start PM2 processes.
var processes []pm2.Process
if config.EnableChromeEndpoints() {

1
internal/app/api/pkg/handler/html.go
View File

@@ -12,6 +12,7 @@ import (
func HTML(c echo.Context) error {
const op = "handler.HTML"
ctx := context.MustCastFromEchoContext(c)
ctx.StandardLogger().DebugfOp(op, "html request")
r := ctx.Resource()
opts, err := r.ChromePrinterOptions()
if err != nil {

1
internal/app/api/pkg/handler/markdown.go
View File

@@ -12,6 +12,7 @@ import (
func Markdown(c echo.Context) error {
const op = "handler.Markdown"
ctx := context.MustCastFromEchoContext(c)
ctx.StandardLogger().DebugfOp(op, "markdown request")
r := ctx.Resource()
opts, err := r.ChromePrinterOptions()
if err != nil {

1
internal/app/api/pkg/handler/merge.go
View File

@@ -12,6 +12,7 @@ import (
func Merge(c echo.Context) error {
const op = "handler.Merge"
ctx := context.MustCastFromEchoContext(c)
ctx.StandardLogger().DebugfOp(op, "merge request")
r := ctx.Resource()
opts, err := r.MergePrinterOptions()
if err != nil {

1
internal/app/api/pkg/handler/office.go
View File

@@ -12,6 +12,7 @@ import (
func Office(c echo.Context) error {
const op = "handler.Office"
ctx := context.MustCastFromEchoContext(c)
ctx.StandardLogger().DebugfOp(op, "office request")
r := ctx.Resource()
opts, err := r.OfficePrinterOptions()
if err != nil {

1
internal/app/api/pkg/handler/url.go
View File

@@ -13,6 +13,7 @@ import (
func URL(c echo.Context) error {
const op = "handler.URL"
ctx := context.MustCastFromEchoContext(c)
ctx.StandardLogger().DebugfOp(op, "url request")
r := ctx.Resource()
opts, err := r.ChromePrinterOptions()
if err != nil {

3
internal/app/api/pkg/middleware/context.go
View File

@@ -30,8 +30,7 @@ func Context(config *config.Config) echo.MiddlewareFunc {
// if the endpoint is not for healthcheck, associate a
// resource to our custom context.
if err := ctx.WithResource(trace); err != nil {
// required to have a correct status code
// in the logs.
// required to have a correct status code.
ctx.Error(err)
return ctx.LogRequestResult(err, false)
}

3
internal/app/api/pkg/middleware/error.go
View File

@@ -35,8 +35,7 @@ func Error() echo.MiddlewareFunc {
default:
httpErr = echo.NewHTTPError(http.StatusInternalServerError, errMessage)
}
// required to have a correct status code
// in the logs.
// required to have a correct status code.
ctx.Error(httpErr)
return httpErr
}

43
internal/app/api/pkg/resource/resource.go
View File

@@ -85,19 +85,27 @@ func New(c echo.Context, logger *logger.Logger, config *config.Config, dirPath s
func formValues(c echo.Context, logger *logger.Logger) map[string]string {
const op = "resource.formValues"
v := make(map[string]string)
v[ResultFilenameFormField] = c.FormValue(ResultFilenameFormField)
v[WaitTimeoutFormField] = c.FormValue(WaitTimeoutFormField)
v[WebhookURLFormField] = c.FormValue(WebhookURLFormField)
v[RemoteURLFormField] = c.FormValue(RemoteURLFormField)
v[WaitDelayFormField] = c.FormValue(WaitDelayFormField)
v[PaperWidthFormField] = c.FormValue(PaperWidthFormField)
v[PaperHeightFormField] = c.FormValue(PaperHeightFormField)
v[MarginTopFormField] = c.FormValue(MarginTopFormField)
v[MarginBottomFormField] = c.FormValue(MarginBottomFormField)
v[MarginLeftFormField] = c.FormValue(MarginLeftFormField)
v[MarginRightFormField] = c.FormValue(MarginRightFormField)
v[LandscapeFormField] = c.FormValue(LandscapeFormField)
logger.DebugfOp(op, "%v", v)
fetch := func(formField string) string {
value := c.FormValue(formField)
if value == "" {
logger.DebugfOp(op, "'%s' is empty", formField)
return value
}
logger.DebugfOp(op, "'%s' retrieved, got '%s'", formField, value)
return value
}
v[ResultFilenameFormField] = fetch(ResultFilenameFormField)
v[WaitTimeoutFormField] = fetch(WaitTimeoutFormField)
v[WebhookURLFormField] = fetch(WebhookURLFormField)
v[RemoteURLFormField] = fetch(RemoteURLFormField)
v[WaitDelayFormField] = fetch(WaitDelayFormField)
v[PaperWidthFormField] = fetch(PaperWidthFormField)
v[PaperHeightFormField] = fetch(PaperHeightFormField)
v[MarginTopFormField] = fetch(MarginTopFormField)
v[MarginBottomFormField] = fetch(MarginBottomFormField)
v[MarginLeftFormField] = fetch(MarginLeftFormField)
v[MarginRightFormField] = fetch(MarginRightFormField)
v[LandscapeFormField] = fetch(LandscapeFormField)
return v
}
@@ -221,7 +229,7 @@ func (r *Resource) ChromePrinterOptions() (*printer.ChromeOptions, error) {
MarginRight: marginRight,
Landscape: landscape,
}
r.logger.DebugfOp(op, "%v", opts)
r.logger.DebugfOp(op, "printer options: %+v", opts)
return opts, nil
}
@@ -242,7 +250,7 @@ func (r *Resource) OfficePrinterOptions() (*printer.OfficeOptions, error) {
WaitTimeout: waitTimeout,
Landscape: landscape,
}
r.logger.DebugfOp(op, "%v", opts)
r.logger.DebugfOp(op, "printer options: %+v", opts)
return opts, nil
}
@@ -258,7 +266,7 @@ func (r *Resource) MergePrinterOptions() (*printer.MergeOptions, error) {
opts := &printer.MergeOptions{
WaitTimeout: waitTimeout,
}
r.logger.DebugfOp(op, "%v", opts)
r.logger.DebugfOp(op, "printer options: %+v", opts)
return opts, nil
}
@@ -384,13 +392,12 @@ func (r *Resource) Fpaths(exts ...string) ([]string, error) {
const op = "resource.Fpaths"
var fpaths []string
err := filepath.Walk(r.formFilesDirPath, func(path string, info os.FileInfo, _ error) error {
const walkOp = "resource.filepath.Walk"
if info.IsDir() {
return nil
}
fpath, err := r.Fpath(info.Name())
if err != nil {
return &standarderror.Error{Op: walkOp, Err: err}
return &standarderror.Error{Op: op, Err: err}
}
for _, ext := range exts {
if filepath.Ext(fpath) == ext {

10
internal/pkg/pm2/chrome.go
View File

@@ -9,7 +9,7 @@ import (
"github.com/thecodingmachine/gotenberg/internal/pkg/standarderror"
)
const warmupTime = 10 * time.Second
const chromeWarmupTime = 10 * time.Second
type chrome struct {
manager *processManager
@@ -93,13 +93,13 @@ func (p *chrome) viable() bool {
}
func (p *chrome) warmup() {
const debugOp = "pm2.chrome.warmup"
const op = "pm2.chrome.warmup"
p.manager.logger.DebugfOp(
debugOp,
op,
"allowing %v to startup",
warmupTime,
chromeWarmupTime,
)
time.Sleep(warmupTime)
time.Sleep(chromeWarmupTime)
}
// Compile-time checks to ensure type implements desired interfaces.

12
internal/pkg/pm2/unoconv.go
View File

@@ -1,10 +1,14 @@
package pm2
import (
"time"
"github.com/thecodingmachine/gotenberg/internal/pkg/logger"
"github.com/thecodingmachine/gotenberg/internal/pkg/standarderror"
)
const unoconvWarmupTime = 5 * time.Second
type unoconv struct {
manager *processManager
}
@@ -56,7 +60,13 @@ func (p *unoconv) viable() bool {
}
func (p *unoconv) warmup() {
// let's do nothing.
const op = "pm2.unoconv.warmup"
p.manager.logger.DebugfOp(
op,
"allowing %v to startup",
unoconvWarmupTime,
)
time.Sleep(unoconvWarmupTime)
}
// Compile-time checks to ensure type implements desired interfaces.