[SERVER-35775] Unhelpful Message String in db.getFreeMonitoringStatus() Created: 25/Jun/18  Updated: 29/Oct/23  Resolved: 01/Aug/18

Status: Closed
Project: Core Server
Component/s: None
Affects Version/s: 4.0.0
Fix Version/s: 4.0.2, 4.1.2

Type: Bug Priority: Major - P3
Reporter: Matt Lord (Inactive) Assignee: Mark Benvenuto
Resolution: Fixed Votes: 0
Labels: FreeMonitoring
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Backports
Backwards Compatibility: Fully Compatible
Operating System: ALL
Backport Requested:
v4.0
Steps To Reproduce:

  

Sprint: Platforms 2018-07-30, Platforms 2018-08-13
Participants:

 Description   

When we're unable to immediately get a free monitoring URL, we continue to retry in the background. While we haven't yet completed the registration and received a valid URL endpoint for the free monitoring, we have an unhelpful message in the status output:

test@mongolord> db.enableFreeMonitoring()
Successfully initiated free monitoring. The registration is proceeding in the background. 
Run db.getFreeMonitoringStatus() at any time to check on the progress.
 
test@mongolord> db.getFreeMonitoringStatus()
{
    "state" : "pending",
    "message" : "",
    "url" : "",
    "userReminder" : "",
    "ok" : 1
}
 
test@mongolord> db.getFreeMonitoringStatus()
{
    "state" : "disabled",
    "message" : "To see your monitoring data, navigate to the unique URL below. Anyone you share the URL with will also be able to view this page. You can disable monitoring at any time by running db.disableFreeMonitoring().",
    "url" : "https://cloud.mongodb.com/freemonitoring/cluster/QJPXX5WZG6FS5NJXNU4GEZKZCEA5LLXE",
    "userReminder" : "",
    "ok" : 1
}

 

I would expect registration failures to be quite common due to firewalls, etc. We should make the error message as informative as possible. For example, when we're unable to reach the Cloud endpoint(s):

    "message" : "Unable to reach Cloud service. Please check your firewall settings to ensure that we can communicate with <Service IP/hostname>", 

Or when we're able to communicate with the Cloud endpoint but get no response back:

    "message" : "Unable to receive responses back from Cloud service. Please ensure that network ingress is allowed from <Service IP/hostname>", 

When we have no idea why we haven't yet succeeded we can default to a generic message:

    "message" : "Unable to complete registration, will continue to re-try", 

 



 Comments   
Comment by Githook User [ 07/Aug/18 ]

Author:

{'name': 'Mark Benvenuto', 'email': 'mark.benvenuto@mongodb.com', 'username': 'markbenvenuto'}

Message: SERVER-35775 Improve free-monitoring message on down cloud endpoint

(cherry picked from commit fdd8c9376683faa80eea67a7a7990bca2c8913c3)
Branch: v4.0
https://github.com/mongodb/mongo/commit/0956227759bcb530c7074b0d0599d79690fcfd37

Comment by Githook User [ 01/Aug/18 ]

Author:

{'username': 'markbenvenuto', 'name': 'Mark Benvenuto', 'email': 'mark.benvenuto@mongodb.com'}

Message: SERVER-35775 Improve free-monitoring message on down cloud endpoint
Branch: master
https://github.com/mongodb/mongo/commit/fdd8c9376683faa80eea67a7a7990bca2c8913c3

Comment by Mark Benvenuto [ 24/Jul/18 ]

matt.lord, If free monitoring does not successfully register, would you like to see the following message instead?

> db.enableFreeMonitoring()
Unable to reach Cloud service. Please check your firewall settings to ensure that we can communicate with cloud.mongodb.com/freemonitoring"

Comment by Asya Kamsky [ 03/Jul/18 ]

Maybe also helpful would be message with link to docs page for more details of different states?

Generated at Thu Feb 08 04:40:55 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.