about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorVincent Ambo <mail@tazj.in>2018-06-17T20·36+0200
committerVincent Ambo <mail@tazj.in>2018-06-17T20·36+0200
commit9f29992d03d6bb941a8bfc16a29c4a72a72fc34a (patch)
tree384ad1c9d5353369fcd94834c28158113ab937c8 /README.md
parent208b5dec2cad72f752c091c349a5e954047b74ff (diff)
refactor(main): Split LOG_NAME & LOG_STREAM variables
Splitting these in two lets users better configure how the logs show
up in Stackdriver Logging.
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/README.md b/README.md
index 28b72b9872..da55d741af 100644
--- a/README.md
+++ b/README.md
@@ -41,7 +41,6 @@ instances.
 
 3. Start `journaldriver`, for example via `systemd`.
 
-
 ## Usage outside of Google Cloud Platform
 
 When running outside of GCP, the following extra steps need to be
@@ -56,8 +55,11 @@ performed:
      should be written.
    * `GOOGLE_APPLICATION_CREDENTIALS`: Filesystem path to the
      JSON-file containing the service account's private key.
-   * `LOG_NAME`: Name of the target log stream in Stackdriver Logging.
+   * `LOG_STREAM`: Name of the target log stream in Stackdriver Logging.
      This will be automatically created if it does not yet exist.
+   * `LOG_NAME`: Name of the target log to write to. This defaults to
+     `journaldriver` if unset, but it is recommended to - for
+     example - set it to the machine hostname.
 
 ## Upcoming features: