From 8c7f244faa2173e6492c108a100276a28bc29603 Mon Sep 17 00:00:00 2001
From: Matthew Loring <matthewloring@users.noreply.github.com>
Date: Fri, 9 Sep 2016 02:51:28 -0400
Subject: [PATCH] Document ignoreContextHeader configuration (#296)

PR-URL: https://github.com/GoogleCloudPlatform/cloud-trace-nodejs/pull/296
---
 config.js | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/config.js b/config.js
index e0463a0fc..8f52b188d 100644
--- a/config.js
+++ b/config.js
@@ -81,7 +81,13 @@ module.exports = {
     //            the network.
     onUncaughtException: 'ignore',
 
-    // Allows to ignore the requests X-Cloud-Trace-Context -header if set
+    // EXPERIMENTAL:
+    // Allows to ignore the requests X-Cloud-Trace-Context -header if set. Setting this
+    // to true will cause traces generated by this module to appear separately from other
+    // distributed work done by other services on behalf of the same income request. Setting
+    // this will also cause sampling decisions made by other distributed components to be
+    // ignored. This is useful for aggregating traces generated by different cloud platform
+    // projects.
     ignoreContextHeader: false
   }
 };