Hi Michael, >From working on the IBM code base, I think Bryant means that strings passed through log.error would be externalized (for NLS), but messages passed through log.debug would not be. I guess it depends on the logging mechanism whether log.error is a "message that can be returned to the user" or not. I would expect log.error to be configured to go to an error log, or even System.err if that's appropriate for the given runtime environment. I think the intent for log.error in the IBM runtime was to report user errors, not JAX-RS engine data dumps -- that would be reserved for log.debug. The log.error messages are intended to help the customer solve an issue him/herself, such as if an important annotation has been forgotten (see org.apache.cxf.jaxrs.utils.JAXRSUtils.findTargetMethod where the log.error reports that a resource has no GET, POST, PUT, or DELETE annotations, for example). So with that in mind, I would want log.error messages to be readable by the customer in their language of choice.
However, you make a good point that this means the log.error messages are perhaps in a language unknown by the support team, but the log.debug messages would be. So, what's the solution to this? Do we: 1) do not externalize anything that goes through log.*, thus externalizing only the messages in a thrown exception or message response body? or 2) use log.debug and log.error side-by-side every place a log.error message might appear so we can report in both a customer's language and English? (I don't like this option) 3) others?. Ideally, I think log.error would be used to report NLS strings so a customer can quickly resolve the error him/herself without requiring a call to support. Your thoughts? Mike Rheinheimer (512) 838-0086 t/l 678-0086 WebSphere WebService Core Engine Team |------------> | From: | |------------> >--------------------------------------------------------------------------------------------------------------------------------------------------| |"Elman, Michael" <[email protected]> | >--------------------------------------------------------------------------------------------------------------------------------------------------| |------------> | To: | |------------> >--------------------------------------------------------------------------------------------------------------------------------------------------| |"[email protected]" <[email protected]> | >--------------------------------------------------------------------------------------------------------------------------------------------------| |------------> | Date: | |------------> >--------------------------------------------------------------------------------------------------------------------------------------------------| |06/11/2009 02:58 AM | >--------------------------------------------------------------------------------------------------------------------------------------------------| |------------> | Subject: | |------------> >--------------------------------------------------------------------------------------------------------------------------------------------------| |RE: Wink Project Guidelines | >--------------------------------------------------------------------------------------------------------------------------------------------------| Well, I'm not quite sure that logging messages should be externalized. I mean here the messages that are only written to log files. It may happen that a problem will occur on the customer site and we'll ask for the logs. I'm quite unsure that I want to read messages in a language I don't know. I think that only messages that can be returned to the user must be externalized. In case of Wink, these can be messages thrown in exceptions or put in the response body. Btw, there is almost no way to throw exceptions with a message that can be returned to the user from the JAX-RS runtime. WebApplicationException that should be thrown in most cases, has no constructors that accept messages. And I don't think that throwing a RuntimeException with a message embedded in the WebApplicationException is a good solution: the stacktrace looks weird; and actually the message will not be returned to the client, since the default handling of WebApplicationException ignores the message. Michael Elman -----Original Message----- From: Bryant Luk [mailto:[email protected]] Sent: Wednesday, June 10, 2009 5:21 PM To: [email protected] Subject: Re: Wink Project Guidelines One quick note, I added an explicit part for logging messages. Basically I think we should externalize any logging message strings into a message.properties file that are not debug messages (for NLS and the like). On Tue, Jun 9, 2009 at 9:26 AM, Bryant Luk<[email protected]> wrote: > I like the coding guidelines. I think using Maven would be good. The > only issue I think we need to address is making sure that we allow the > integration tests to run on various platforms.(jetty, tomcat, > geronimo, etc.), maybe via the Maven profiles functionality. > > On Mon, Jun 8, 2009 at 8:50 AM, Elman, Michael<[email protected]> wrote: >> I've created "Coding Guidelines" under the "Project Guidelines". >> Feel free to modify/add/discuss. >> >> Michael Elman >> >> >> -----Original Message----- >> From: Bryant Luk [mailto:[email protected]] >> Sent: Friday, June 05, 2009 6:10 AM >> To: [email protected] >> Subject: Re: Wink Project Guidelines >> >> >> I've updated the Wink Wiki with some of the project guidelines at: >> >> http://cwiki.apache.org/confluence/display/WINK/Project+Guidelines. >> >> I copied what I thought was relevant for now. Feel free to >> modify/add/discuss. >> >> Thanks, >> >> Bryant Luk >> [email protected] >> >> >> Davanum Srinivas <[email protected]> wrote on 06/04/2009 08:25:09 PM: >> >>> [image removed] >>> >>> Re: Wink Project Guidelines >>> >>> Davanum Srinivas >>> >>> to: >>> >>> wink-dev >>> >>> 06/04/2009 08:26 PM >>> >>> Please respond to wink-dev >>> >>> Eli, Bryant, >>> >>> Feel free to use the wiki: >>> http://cwiki.apache.org/confluence/display/WINK/Index >>> >>> thanks, >>> dims >>> >>> On Thu, Jun 4, 2009 at 8:39 AM, Baram, Eliezer<[email protected]> wrote: >>> > Hi >>> > I think it can be a starting point, there are some modifications I >>> believe we should add, but in general it look good. >>> > let's copy it as a draft and then do the modifications and >>> discussions upon it. >>> > Regards, >>> > Eli >>> > >>> > >>> > >>> > >>> > -----Original Message----- >>> > From: Bryant Luk [mailto:[email protected]] >>> > Sent: Wednesday, June 03, 2009 11:39 PM >>> > To: [email protected] >>> > Subject: Wink Project Guidelines >>> > >>> > >>> > Hi all, >>> > >>> > For project guidelines, Jakarta seems to have a well written set >> (thanks >>> > Carlton): >>> > >>> > http://jakarta.apache.org/site/guidelines.html >>> > >>> > Any thoughts if we should just copy these guidelines for Wink? Some of >>> > these aren't applicable but these seem fairly standard in how other >> Apache >>> > projects are run. >>> > >>> > I imagine that more coding guidelines would need to be done later (like >>> > maybe formatting, logging, NLS, etc.) >>> > >>> > Thanks, >>> > >>> > Bryant Luk >>> > [email protected] >>> > >>> >>> >>> >>> -- >>> Davanum Srinivas :: http://davanum.wordpress.com >> > > > > -- > > - Bryant Luk > -- - Bryant Luk
