docs: Mention global log stream value in README

This commit is contained in:
Vincent Ambo 2019-02-04 16:18:35 +01:00 committed by Vincent Ambo
parent 6d2a8adacc
commit 1942ec574f

View file

@ -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