From 4dc7e083efd46ac2a227389106ca9350aac60539 Mon Sep 17 00:00:00 2001 From: Travis Truman Date: Tue, 28 Apr 2015 09:43:39 -0400 Subject: [PATCH] Adding doc that explains how to configure/use logging --- website/source/docs/internals/debugging.html.md | 15 +++++++++++++++ website/source/layouts/docs.erb | 4 ++++ 2 files changed, 19 insertions(+) create mode 100644 website/source/docs/internals/debugging.html.md diff --git a/website/source/docs/internals/debugging.html.md b/website/source/docs/internals/debugging.html.md new file mode 100644 index 000000000..e10a21880 --- /dev/null +++ b/website/source/docs/internals/debugging.html.md @@ -0,0 +1,15 @@ +--- +layout: "docs" +page_title: "Debugging" +sidebar_current: "docs-internals-debug" +description: |- + Terraform has detailed logs which can be enabled by setting the TF_LOG environmental variable to any value. This will cause detailed logs to appear on stderr +--- + +# Debugging Terraform + +Terraform has detailed logs which can be enabled by setting the TF_LOG environmental variable to any value. This will cause detailed logs to appear on stderr. + +To persist logged output you can set TF_LOG_PATH in order to force the log to always go to a specific file when logging is enabled. Note that even when TF_LOG_PATH is set, TF_LOG must be set in order for any logging to be enabled. + +If you find a bug with Terraform, please include the detailed log by using a service such as gist. \ No newline at end of file diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index a065d26a6..c60416394 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -216,6 +216,10 @@ > Internals