Skip to content

Commit

Permalink
builder: don't log requests/responses by default
Browse files Browse the repository at this point in the history 
The logs of the Azure builder are very verbose by default, as they log
the contents of every request/response to/from the Azure APIs.

For regular debugging of a template, this is not necessary, as just
looking at the errors returned by the calls will generally give enough
information to proceed with fixing the template.

These logs may be relevant when attempting to debug the plugin itself
however, so we add one extra environment variable to allow the plugin to
print them out, PACKER_AZURE_DEBUG_LOGS.
If it is defined, and non empty, the requests and responses will be
dumped to stderr, otherwise, they are silent.
  • Loading branch information
@lbajolet-hashicorp
lbajolet-hashicorp committed Feb 9, 2024
1 parent 10a55d5 commit 0d83598
Show file tree
Hide file tree
Showing 5 changed files with 122 additions and 66 deletions.
12 changes: 12 additions & 0 deletions .web-docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,15 @@ you should specify `subscription_id`, `client_id` and one of `client_secret`,
associated with your service principal principal. See [Azure Active
Directory docs](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-certificate-credentials)
for more information.

## Troubleshooting

As with any Packer plugin, you may produce verbose logs if you encounter a problem, and the normal logs don't help narrow down the issue.
To do so, you will need to set the `PACKER_LOG` environment variable to a non-zero value (e.g. "1", "y", or any non-empty string).
This will enable some verbose logs that can help you figure out which part of the process errors, and hopefully why.

In addition to this, you may also enable the `PACKER_AZURE_DEBUG_LOG` environment variable, in addition to `PACKER_LOG`.
Enabling this will add request/response inspection in the logs, along with the body sent with each request to the Azure APIs.

~> Warning: the `PACKER_AZURE_DEBUG_LOG` variable is very verbose, and may expose sensitive information in the logs.
For this reason, we strongly advise only enabling this in a trusted environment, and only for a temporary debugging session.
73 changes: 41 additions & 32 deletions builder/azure/arm/inspector.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
"github.com/Azure/go-autorest/autorest"
"github.com/Azure/go-autorest/autorest/azure"
"github.com/hashicorp/go-azure-sdk/sdk/client"
"github.com/hashicorp/packer-plugin-azure/builder/azure/common"
"github.com/hashicorp/packer-plugin-azure/builder/azure/common/logutil"
)

Expand Down Expand Up @@ -46,36 +47,60 @@ func handleBody(body io.ReadCloser, maxlen int64) (io.ReadCloser, string) {
func withInspection(maxlen int64) autorest.PrepareDecorator {
return func(p autorest.Preparer) autorest.Preparer {
return autorest.PreparerFunc(func(r *http.Request) (*http.Request, error) {
body, bodyString := handleBody(r.Body, maxlen)
r.Body = body

log.Print("Azure request", logutil.Fields{
"method": r.Method,
"request": r.URL.String(),
"body": bodyString,
})
if common.IsDebugEnabled() {
body, bodyString := handleBody(r.Body, maxlen)
r.Body = body

log.Print("Azure request", logutil.Fields{
"method": r.Method,
"request": r.URL.String(),
"body": bodyString,
})
}
return p.Prepare(r)
})
}
}

func withInspectionTrack2(maxlen int64) client.RequestMiddleware {
return func(r *http.Request) (*http.Request, error) {
body, bodyString := handleBody(r.Body, maxlen)
r.Body = body
if common.IsDebugEnabled() {
body, bodyString := handleBody(r.Body, maxlen)
r.Body = body

log.Print("Azure request", logutil.Fields{
"method": r.Method,
"request": r.URL.String(),
"body": bodyString,
})
log.Print("Azure request", logutil.Fields{
"method": r.Method,
"request": r.URL.String(),
"body": bodyString,
})
}
return r, nil
}
}

func byInspecting(maxlen int64) autorest.RespondDecorator {
return func(r autorest.Responder) autorest.Responder {
return autorest.ResponderFunc(func(resp *http.Response) error {
if common.IsDebugEnabled() {
body, bodyString := handleBody(resp.Body, maxlen)
resp.Body = body

log.Print("Azure response", logutil.Fields{
"status": resp.Status,
"method": resp.Request.Method,
"request": resp.Request.URL.String(),
"x-ms-request-id": azure.ExtractRequestID(resp),
"body": bodyString,
})
}
return r.Respond(resp)
})
}
}

func byInspectingTrack2(maxlen int64) client.ResponseMiddleware {
return func(req *http.Request, resp *http.Response) (*http.Response, error) {
if common.IsDebugEnabled() {
body, bodyString := handleBody(resp.Body, maxlen)
resp.Body = body

Expand All @@ -86,23 +111,7 @@ func byInspecting(maxlen int64) autorest.RespondDecorator {
"x-ms-request-id": azure.ExtractRequestID(resp),
"body": bodyString,
})
return r.Respond(resp)
})
}
}

func byInspectingTrack2(maxlen int64) client.ResponseMiddleware {
return func(req *http.Request, resp *http.Response) (*http.Response, error) {
body, bodyString := handleBody(resp.Body, maxlen)
resp.Body = body

log.Print("Azure response", logutil.Fields{
"status": resp.Status,
"method": resp.Request.Method,
"request": resp.Request.URL.String(),
"x-ms-request-id": azure.ExtractRequestID(resp),
"body": bodyString,
})
}

return resp, nil
}
Expand Down
14 changes: 14 additions & 0 deletions builder/azure/common/env.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package common

import "os"

const AzureDebugLogsEnvVar string = "PACKER_AZURE_DEBUG_LOG"

func IsDebugEnabled() bool {
debug, defined := os.LookupEnv(AzureDebugLogsEnvVar)
if !defined {
return false
}

return debug != ""
}
79 changes: 45 additions & 34 deletions builder/azure/dtl/inspector.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (
"github.com/Azure/go-autorest/autorest"
"github.com/Azure/go-autorest/autorest/azure"
"github.com/hashicorp/go-azure-sdk/sdk/client"
"github.com/hashicorp/packer-plugin-azure/builder/azure/common"
"github.com/hashicorp/packer-plugin-azure/builder/azure/common/logutil"
)

Expand Down Expand Up @@ -41,14 +42,16 @@ func handleBody(body io.ReadCloser, maxlen int64) (io.ReadCloser, string) {
func withInspection(maxlen int64) autorest.PrepareDecorator {
return func(p autorest.Preparer) autorest.Preparer {
return autorest.PreparerFunc(func(r *http.Request) (*http.Request, error) {
body, bodyString := handleBody(r.Body, maxlen)
r.Body = body

log.Print("Azure request", logutil.Fields{
"method": r.Method,
"request": r.URL.String(),
"body": bodyString,
})
if common.IsDebugEnabled() {
body, bodyString := handleBody(r.Body, maxlen)
r.Body = body

log.Print("Azure request", logutil.Fields{
"method": r.Method,
"request": r.URL.String(),
"body": bodyString,
})
}
return p.Prepare(r)
})
}
Expand All @@ -57,47 +60,55 @@ func withInspection(maxlen int64) autorest.PrepareDecorator {
func byInspecting(maxlen int64) autorest.RespondDecorator {
return func(r autorest.Responder) autorest.Responder {
return autorest.ResponderFunc(func(resp *http.Response) error {
body, bodyString := handleBody(resp.Body, maxlen)
resp.Body = body
if common.IsDebugEnabled() {
body, bodyString := handleBody(resp.Body, maxlen)
resp.Body = body

log.Print("Azure response", logutil.Fields{
"status": resp.Status,
"method": resp.Request.Method,
"request": resp.Request.URL.String(),
"x-ms-request-id": azure.ExtractRequestID(resp),
"body": bodyString,
})
}

log.Print("Azure response", logutil.Fields{
"status": resp.Status,
"method": resp.Request.Method,
"request": resp.Request.URL.String(),
"x-ms-request-id": azure.ExtractRequestID(resp),
"body": bodyString,
})
return r.Respond(resp)
})
}
}

func withInspectionTrack2(maxlen int64) client.RequestMiddleware {
return func(r *http.Request) (*http.Request, error) {
body, bodyString := handleBody(r.Body, maxlen)
r.Body = body
if common.IsDebugEnabled() {
body, bodyString := handleBody(r.Body, maxlen)
r.Body = body

log.Print("Azure request", logutil.Fields{
"method": r.Method,
"request": r.URL.String(),
"body": bodyString,
})
}

log.Print("Azure request", logutil.Fields{
"method": r.Method,
"request": r.URL.String(),
"body": bodyString,
})
return r, nil
}
}

func byInspectingTrack2(maxlen int64) client.ResponseMiddleware {
return func(req *http.Request, resp *http.Response) (*http.Response, error) {
body, bodyString := handleBody(resp.Body, maxlen)
resp.Body = body

log.Print("Azure response", logutil.Fields{
"status": resp.Status,
"method": resp.Request.Method,
"request": resp.Request.URL.String(),
"x-ms-request-id": azure.ExtractRequestID(resp),
"body": bodyString,
})
if common.IsDebugEnabled() {
body, bodyString := handleBody(resp.Body, maxlen)
resp.Body = body

log.Print("Azure response", logutil.Fields{
"status": resp.Status,
"method": resp.Request.Method,
"request": resp.Request.URL.String(),
"x-ms-request-id": azure.ExtractRequestID(resp),
"body": bodyString,
})
}

return resp, nil
}
Expand Down
10 changes: 10 additions & 0 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,3 +87,13 @@ you should specify `subscription_id`, `client_id` and one of `client_secret`,
associated with your service principal principal. See [Azure Active
Directory docs](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-certificate-credentials)
for more information.

## Troubleshooting

As with any Packer plugin, you may produce verbose logs to troubleshoot if the default output does not help narrow down the issue.
To do so, you can set the `PACKER_LOG` environment variable to a non-zero value (e.g. "1" or any non-empty string) to enable verbose logs that can help you figure out which part of the process errors, and hopefully why.

In addition to this, you may also enable the `PACKER_AZURE_DEBUG_LOG` environment variable alongside `PACKER_LOG` for visibility into the API calls being made to the Azure platform.
Enabling this will add HTTP response inspection in the logs and the body sent with each request to the Azure APIs.

~> Warning: the `PACKER_AZURE_DEBUG_LOG` variable contains a high degree of verbosity and may expose sensitive information in the logs. For this reason, we strongly advise only enabling this in a trusted environment and only for a temporary debugging session.

0 comments on commit 0d83598

Please sign in to comment.