about summary refs log tree commit diff
diff options
context:
space:
mode:
authorVincent Ambo <mail@tazj.in>2019-02-04T15·18+0100
committerVincent Ambo <github@tazj.in>2019-02-04T15·31+0100
commit1942ec574fe298e62f853955f2b4e5e89dc7de06 (patch)
treee2efd596efb5085b2276d7c871d197b2cbfe9bab
parent6d2a8adacc223f9eb7c607b5b0408fd5e8a60e7f (diff)
docs: Mention `global` log stream value in README
-rw-r--r--README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/README.md b/README.md
index 975406d4c9da..4dc9de0f617b 100644
--- a/README.md
+++ b/README.md
@@ -129,9 +129,15 @@ log entries.
 To use this functionality log messages must be logged in the expected
 [log format][].
 
-*Note*: Currently errors logged from non-GCP instances are not
-ingested into Error Reporting. Please see [issue #4][] for more
-information about this.
+*Note*: Reporting errors from non-GCP instances requires that the
+`LOG_STREAM` environment variable is set to the special value
+`global`.
+
+This value changes the monitored resource descriptor from a log stream
+to the project-global stream. Due to a limitation in Stackdriver Error
+Reporting, this is the only way to correctly ingest errors from
+non-GCP machines. Please see [issue #4][] for more information about
+this.
 
 [Stackdriver Logging]: https://cloud.google.com/logging/
 [metadata server]: https://cloud.google.com/compute/docs/storing-retrieving-metadata