diff --git a/README.rst b/README.rst index 146efa2..447e2f1 100644 --- a/README.rst +++ b/README.rst @@ -39,6 +39,19 @@ Note that the DCOS CLI has tight integration with DCOS and certain functionality may not work as expected or at all when using it directly with Mesos and Marathon. +Controlling Analytics Reporting +------------------------------- + +The CLI reports usage and exception information to Segment.io. If you're +developing against the CLI or running the current master, please set +the :code:`DCOS_PRODUCTION` environment variable to false. This will +ensure analytics are sent to the correct environment:: + export DCOS_PRODUCTION=false + +Alternatively, if you wish to turn reporting of analytics off entirely, +you can set the :code:`core.reporting` property to false:: + dcos config set core.reporting false + Dependencies ------------