635254 - Provide the __heartbeat__ and __debug__ screen [identity]

Status: RESOLVED FIXED

(Cloud Services :: Server: Identity, defect)

Description

[Tarek Ziadé (:tarek)]

Those are the standard views for displaying debug info + heartbeating

Comment 1

[JR Conlin [:jrconlin,:jconlin]]

Committed as part of 635294

Comment 2

[Tarek Ziadé (:tarek)]

Sorry I am kind of lost in the commit that contains many other stuff. Could you point me to the relevant part I should review ? thanks !

Comment 3

[JR Conlin [:jrconlin,:jconlin]]

Sure.

For the __debug__ page, I added the following lines to oidserver/wsgapi.py:

 class OIDApp(SyncServerApp):
     """OID application"""
     def __init__(self, urls, controllers, config, auth_class):
         """ Main storage """
         self.storage = get_storage(config, 'oidstorage')
         super(OIDApp, self).__init__(urls, controllers, config, auth_class)
+        self.debug_page = '__debug__'

For the __heartbeat__ page, I'm using the default heartbeat page defined in SyncServerApp.

Comment 4

[Tarek Ziadé (:tarek)]

You don't have to do this, as SyncServerApp looks for global.debug_page in the config. 

In fact it's even a security issue because with this change anyone that runs your server will get the debug page without a way to deactivate it. The idea is that is deactivated by default and activated only via an explicit configuration.

See: http://docs.services.mozilla.com/server-devguide/configuration.html#global

So IOW your app code already has what was required, and you just need to provide the config for Ops in the cfg file

Comment 5

[JR Conlin [:jrconlin,:jconlin]]

Attachment: removed __debug__ hardcode

Per Tarek's comment, removing the hardcoded __debug__. Also including doc pointer to config information. 

(Note: diff includes patch for 654730)

Comment 6

[JR Conlin [:jrconlin,:jconlin]]

one line fix committed to 67:4d973a53a5be

Comment 7

[Tarek Ziadé (:tarek)]

(In reply to comment #5)
> Created attachment 530110 [details] [diff] [review] [review]
> removed __debug__ hardcode
> 
> Per Tarek's comment, removing the hardcoded __debug__. Also including doc
> pointer to config information. 
> 
> (Note: diff includes patch for 654730)

The patch for bug 654730 is still being discussed. I guess it's simpler not to have a diff covering several bugs/issues