[mapguide-internals] RFC91 Mapguide Error Codes

Thu Apr 8 21:32:32 EDT 2010

I have posted a brief draft RFC 91 for introducing Error Codes

http://trac.osgeo.org/mapguide/wiki/MapGuideRfc91

z

On 9 April 2010 11:07, Zac Spitzer <zac.spitzer at gmail.com> wrote:
> I'd lean towards making the error codes a little more descriptive
>
> rather than a numerical prefix, why not use a character prefix
> which is more informative?
>
> MG-S-001 (Server)
> MG-WT-001 (webtier)
> MG-FDO-001
> MG-CS-001
> MG-WMS-001
>
> Warning or Critical i don't think is so critical, we can leave that in
> the text string for the error message
>
> This is definately a RFC :)
>
> Would it make sense to re-order the resources file into such
> categories for ease of maintence?
>
> z
>
> On 9 April 2010 01:15, Dave Wilson <dave.wilson at autodesk.com> wrote:
>> This kind of approach makes sense. I've asked about this several times. For custom user error messages I'd suggest MG9xxx or something which is nowhere near the range of standard application errors.
>>
>> When considering this kind of approach do we duplicate errors but provide a different range if it's coming from the web tier vs the server (so that you can distinguish them) or do we use the same values? Although we don't exactly have web side logging if we ever add it since it's in the web log do we now it's strictly web side or passed from the server or that won't matter because it may be logged in both places?
>>
>> Since we don't have any categories of errors do we separate more warning type errors from more fatal errors? If we don't separate server or web then we should create one category for the more fatal errors.
>>
>> I'd be tempted to add another placeholder MGxxxxx
>>
>> Then we can create nice looking ranges with room for 9999 messages in each grouping:
>>
>> 0xxxx Maestro/Studio errors
>> 1xxxx warnings
>> 2xxxx serious
>> 3xxxx FDO
>> 9xxxx custom
>>
>> We might want to further classify things such as coordinate system, wms, wfs, geometry, but if that's the case then we might need more room for future categories so we'd have to extend:
>>
>> 0xxxxx Maestro/Studio errors
>> 1xxxxx Server warnings
>> 2xxxxx Server serious
>> 31xxxx Server FDO
>> 32xxxx Coordinate System
>> 33xxxx Geometry
>> 34xxxx WMS
>> 35xxxx WFS
>> 36xxxx WMS
>> and so on?
>> 9xxxxx custom
>>
>> I'm not trying to make it complicated, just trying to make it useful and not run out of place holders in the future.
>>
>> Dave
>>
>> -----Original Message-----
>> From: mapguide-internals-bounces at lists.osgeo.org [mailto:mapguide-internals-bounces at lists.osgeo.org] On Behalf Of Walt Welton-Lair
>> Sent: Thursday, April 08, 2010 8:29 AM
>> To: MapGuide Internals Mail List
>> Subject: RE: [mapguide-internals] RE: Documenting
>>
>> Codewise that's probably all that's involved.  The MG0001 format seems reasonable to me.
>>
>> But should there be some classification scheme to the numbering?  E.g. generic error messages start with MG0xxx, server-specific ones start with MG1xxx, web-specific ones start with MG2xxx?  For third parties built on top of MG who need to add their own error messages, what MGxxxx values should they use?  This information should then be documented somewhere.
>>
>> Walt
>>
>>
>> -----Original Message-----
>> From: mapguide-internals-bounces at lists.osgeo.org [mailto:mapguide-internals-bounces at lists.osgeo.org] On Behalf Of Zac Spitzer
>> Sent: Wednesday, April 07, 2010 8:56 PM
>> To: MapGuide Internals Mail List
>> Subject: Re: [mapguide-internals] RE: Documenting
>>
>> ok :)
>>
>> I could write a quick script to enumerate through and assign error numbers?
>>
>> http://trac.osgeo.org/mapguide/browser/trunk/MgDev/Common/MapGuideCommon/Resources/mapguide_en.res
>>
>> how does everyone feel about the MG0001 format?
>>
>> as for where we put the information about the errors, putting the info
>> on stackoverflow would be good as there are comments and moderation
>> of answers, as I think trac fails us terribly here
>>
>> z
>>
>> On 8 April 2010 10:46, Walt Welton-Lair <walt.welton-lair at autodesk.com> wrote:
>>> This sounds like a good starter project for Zac :-).
>>> ________________________________________
>>> From: mapguide-internals-bounces at lists.osgeo.org [mapguide-internals-bounces at lists.osgeo.org] On Behalf Of Tom Fukushima
>>> Sent: Wednesday, April 07, 2010 7:50 PM
>>> To: MapGuide Internals Mail List
>>> Subject: RE: [mapguide-internals] RE: Documenting
>>>
>>> Can someone quickly describe the approximate amount of effort it would take to do something like this? Bruce and Trevor, you've both worked pretty closely with the error logging system, perhaps you have some idea.
>>>
>>> Thanks
>>> Tom
>>>
>>> -----Original Message-----
>>> From: mapguide-internals-bounces at lists.osgeo.org [mailto:mapguide-internals-bounces at lists.osgeo.org] On Behalf Of Zac Spitzer
>>> Sent: Wednesday, April 07, 2010 5:42 PM
>>> To: MapGuide Internals Mail List
>>> Subject: Re: [mapguide-internals] RE: Documenting
>>>
>>> It makes the documentation much easier to access via search engines
>>>
>>> for example, the updated error about can't connecting shows this
>>> message via the mapagent tests
>>>
>>> Problem:\nCannot establish connection to the MapGuide
>>> Server.\n\nPossible Causes:\n-Your session has been idle for too
>>> long;\n-MapGuide Server is no longer responding;\n-Internet connection
>>> problems.\n\nSolution:\nRestart your application / session, restart
>>> the MapGuide Server service, or contact with the server administrator.
>>> Problem:\nCannot establish connection to the MapGuide
>>> Server.\n\nPossible Causes:\n-Your session has been idle for too
>>> long;\n-MapGuide Server is no longer responding;\n-Internet connection
>>> problems.\n\nSolution:\nRestart your application / session, restart
>>> the MapGuide Server service, or contact with the server administrator.
>>>
>>> Ignoring the \n issue, this is a rather verbose error message
>>>
>>> If there was a error code MG001, the user could then simply google it and
>>> find (any) related documentation, mailing list posts or blog entries
>>> which relate
>>> to this error.
>>>
>>> Error: MG001 Cannot establish connection to the MapGuide Server
>>>
>>> Is much clearer and provides the user with a simple action path if
>>> they don't know
>>> what has happened. search for MG001 which would then bring the user to
>>> a trouble shooting page on the wiki.
>>>
>>> z
>>> _______________________________________________
>>> mapguide-internals mailing list
>>> mapguide-internals at lists.osgeo.org
>>> http://lists.osgeo.org/mailman/listinfo/mapguide-internals
>>> _______________________________________________
>>> mapguide-internals mailing list
>>> mapguide-internals at lists.osgeo.org
>>> http://lists.osgeo.org/mailman/listinfo/mapguide-internals
>>>
>>
>>
>>
>> --
>> Zac Spitzer
>> Solution Architect / Director
>> Ennoble Consultancy Australia
>> http://www.ennoble.com.au
>> http://zacster.blogspot.com
>> +61 405 847 168
>> _______________________________________________
>> mapguide-internals mailing list
>> mapguide-internals at lists.osgeo.org
>> http://lists.osgeo.org/mailman/listinfo/mapguide-internals
>> _______________________________________________
>> mapguide-internals mailing list
>> mapguide-internals at lists.osgeo.org
>> http://lists.osgeo.org/mailman/listinfo/mapguide-internals
>> _______________________________________________
>> mapguide-internals mailing list
>> mapguide-internals at lists.osgeo.org
>> http://lists.osgeo.org/mailman/listinfo/mapguide-internals
>>
>
>
>
> --
> Zac Spitzer
> Solution Architect / Director
> Ennoble Consultancy Australia
> http://www.ennoble.com.au
> http://zacster.blogspot.com
> +61 405 847 168
>


-- 
Zac Spitzer
Solution Architect / Director
Ennoble Consultancy Australia
http://www.ennoble.com.au
http://zacster.blogspot.com
+61 405 847 168