From 311998352bbd829eb455549954c8d1f1a20b6c38 Mon Sep 17 00:00:00 2001 From: Matt Loring Date: Thu, 9 Jun 2016 11:46:41 -0700 Subject: [PATCH] Specify disabling options in README --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index ec3b9d7a2..f23b0a078 100644 --- a/README.md +++ b/README.md @@ -120,6 +120,10 @@ The trace agent can be configured by passing a configurations object to the agen One configuration option of note is `enhancedDatabaseReporting`. Setting this option to `true` will cause database operations for redis and MongoDB to record query summaries and results as labels on reported trace spans. +## Disabling the trace agent + +The trace agent can be turned off by either setting the `GCLOUD_TRACE_DISABLE` environment variable or specifying `enabled: false` in your configuration file. + ## Trace batching and sampling The aggregation of trace spans before publishing can be configured using the `flushDelaySeconds` and `bufferSize` [options](config.js). The spans recorded for each incoming requests are placed in a buffer after the request has completed. Spans will be published to the UI in batch when the spans from `bufferSize` requests have been queued in the buffer or after `flushDelaySeconds` have passed since the last publish, whichever comes first.