Skip to content

Commit

Permalink
Adds documentation about environments that limit background activities.
Browse files Browse the repository at this point in the history
Closes #5275
  • Loading branch information
amanda-tarafa committed Sep 28, 2020
1 parent f46b1c6 commit 924c503
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions apis/Google.Cloud.Diagnostics.AspNetCore/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,15 @@ The Google.Cloud.Diagnostics.AspNetCore package attempts to collect the filename
entries are collected. However, to be able to collect this information PDBs must be included with
the deployed code.

# Note
When running on environments that limit or disable CPU usage for background activities, for instance
[Google Cloud Run](https://cloud.google.com/run/docs/tips/general#avoiding_background_activities), take care
not to use the timed buffer options for any of Logging, Tracing or Error Reporting. Take into account
that the timed buffer is used for all of these components by default so you will need to explicitly
configure the buffers by using the `Google.Cloud.Diagnostics.AspNetCore.LoggerOptions`,
`Google.Cloud.Diagnostics.Common.TraceOptions` and `Google.Cloud.Diagnostics.Common.ErrorReportingOptions` classes.
Below you'll find examples of how to configure the buffers.

# Getting started

## Initializing Google Diagnostics
Expand Down

0 comments on commit 924c503

Please sign in to comment.