Skip to content

Fix request dump debug log #259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tobio merged 3 commits into from
Feb 15, 2023
Merged

Fix request dump debug log #259

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c6b35a8
Fix request dump debug log
k-yomo Jan 24, 2023
178b497
Migrate the debug transport to a logger
tobio Feb 15, 2023
dd02d3a
Deal with nil req,resp
tobio Feb 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions internal/clients/api_client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,11 @@ func buildEsClient(d *schema.ResourceData, baseConfig BaseConfig, useEnvAsDefaul
}
}

if logging.IsDebugOrHigher() {
config.EnableDebugLogger = true
config.Logger = &debugLogger{Name: "elasticsearch"}
}

es, err := elasticsearch.NewClient(config)
if err != nil {
diags = append(diags, diag.Diagnostic{
Expand All @@ -368,9 +373,6 @@ func buildEsClient(d *schema.ResourceData, baseConfig BaseConfig, useEnvAsDefaul
})
return nil, diags
}
if logging.IsDebugOrHigher() {
es.Transport = newDebugTransport("elasticsearch", es.Transport)
}

return es, diags
}
Expand Down
41 changes: 17 additions & 24 deletions internal/clients/debug.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ import (
"net/http"
"net/http/httputil"
"strings"
"time"

"github.com/elastic/go-elasticsearch/v7/esapi"
"github.com/elastic/go-elasticsearch/v7/estransport"
"github.com/hashicorp/terraform-plugin-log/tflog"
)

Expand All @@ -22,44 +23,36 @@ const logRespMsg = `%s API Response Details:
%s
-----------------------------------------------------`

var _ esapi.Transport = &debugTransport{}
var _ estransport.Logger = &debugLogger{}

type debugTransport struct {
name string
transport esapi.Transport
type debugLogger struct {
Name string
}

func newDebugTransport(name string, transport esapi.Transport) *debugTransport {
return &debugTransport{
name: name,
transport: transport,
}
}
func (l *debugLogger) LogRoundTrip(req *http.Request, resp *http.Response, err error, start time.Time, duration time.Duration) error {
ctx := req.Context()
tflog.Debug(ctx, fmt.Sprintf("%s request [%s %s] executed. Took %s. %#v", l.Name, req.Method, req.URL, duration, err))

func (d *debugTransport) Perform(r *http.Request) (*http.Response, error) {
ctx := r.Context()
reqData, err := httputil.DumpRequestOut(r, true)
reqData, err := httputil.DumpRequestOut(req, true)
if err == nil {
tflog.Debug(ctx, fmt.Sprintf(logReqMsg, d.name, prettyPrintJsonLines(reqData)))
tflog.Debug(ctx, fmt.Sprintf(logReqMsg, l.Name, prettyPrintJsonLines(reqData)))
} else {
tflog.Debug(ctx, fmt.Sprintf("%s API request dump error: %#v", d.name, err))
}

resp, err := d.transport.Perform(r)
if err != nil {
return resp, err
tflog.Debug(ctx, fmt.Sprintf("%s API request dump error: %#v", l.Name, err))
}

respData, err := httputil.DumpResponse(resp, true)
if err == nil {
tflog.Debug(ctx, fmt.Sprintf(logRespMsg, d.name, prettyPrintJsonLines(respData)))
tflog.Debug(ctx, fmt.Sprintf(logRespMsg, l.Name, prettyPrintJsonLines(respData)))
} else {
tflog.Debug(ctx, fmt.Sprintf("%s API response dump error: %#v", d.name, err))
tflog.Debug(ctx, fmt.Sprintf("%s API response dump error: %#v", l.Name, err))
}

return resp, nil
return nil
}

func (l *debugLogger) RequestBodyEnabled() bool { return true }
func (l *debugLogger) ResponseBodyEnabled() bool { return true }

// prettyPrintJsonLines iterates through a []byte line-by-line,
// transforming any lines that are complete json into pretty-printed json.
func prettyPrintJsonLines(b []byte) string {
Expand Down