From 3da2dcb1323a34a9fde354e4c6ead648ce503043 Mon Sep 17 00:00:00 2001 From: azhebel Date: Fri, 17 Feb 2017 22:25:06 +0300 Subject: [PATCH] Add info about lack of SSL support in mongo tools and requirement for running mongo-summary as root --- docs/pt-mongodb-query-digest.rst | 4 ++++ docs/pt-mongodb-summary.rst | 7 +++++++ 2 files changed, 11 insertions(+) diff --git a/docs/pt-mongodb-query-digest.rst b/docs/pt-mongodb-query-digest.rst index abc3a0be..36edcf7c 100644 --- a/docs/pt-mongodb-query-digest.rst +++ b/docs/pt-mongodb-query-digest.rst @@ -24,6 +24,10 @@ The fingerprint is calculated as a sorted list of keys in the document with a maximum depth level of 10. By default, the results are sorted by ascending query count. +.. note:: ``pt-mongodb-query-digest`` cannot collect statistics + from MongoDB instances that require connection via SSL. + Support for SSL will be added in the future. + Options ------- diff --git a/docs/pt-mongodb-summary.rst b/docs/pt-mongodb-summary.rst index 9267a0e9..e5b0b074 100644 --- a/docs/pt-mongodb-summary.rst +++ b/docs/pt-mongodb-summary.rst @@ -20,6 +20,13 @@ it will try to connect to ``localhost`` on port ``27017``. The program collects information about MongoDB instances by running administration commands and formatting the output. +.. note:: ``pt-mongodb-summary`` requires to be run by user + with the ``clusterAdmin`` or ``root`` built-in roles. + +.. note:: ``pt-mongodb-summary`` cannot collect statistics + from MongoDB instances that require connection via SSL. + Support for SSL will be added in the future. + Options -------