From 1942ec574fe298e62f853955f2b4e5e89dc7de06 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Mon, 4 Feb 2019 16:18:35 +0100 Subject: docs: Mention `global` log stream value in README --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 975406d4c9..4dc9de0f61 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 -- cgit 1.4.1