[ https://issues.apache.org/jira/browse/TS-2106?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13746839#comment-13746839 ]
James Peach commented on TS-2106: --------------------------------- Let's land fe3c17fe882e3df00967f7cdfb2ed8e911651413 in master and make the same change for <ink_config.h>. I think we should make the log message formatting consistent, and table the API changes for now. That's a clear benefit. > Normalize TSError messages in plugins (and examples) > ---------------------------------------------------- > > Key: TS-2106 > URL: https://issues.apache.org/jira/browse/TS-2106 > Project: Traffic Server > Issue Type: Bug > Components: Plugins > Reporter: Igor Galić > Assignee: Igor Galić > Fix For: 5.0.0 > > > right now many of plugins send error messages without prefixing the plugin > they come from, this bad practice is also continued in our examples. > many error messages also close with {{\n}}, although this is not necessary. > We should fix this by "normalizing" the way we send those error messages. > Our proposal is either: > {code} > TSError("%s: cannot parse file %s", PLUGIN_NAME, filename); > {code} > or: > {code} > TSError("[%s] cannot parse file %s", PLUGIN_NAME, filename); > {code} > I have no strong leanings towards either. BUT: We should have one consistent > format between examples and plugins and newly imported code. The word "error" > should not be repeated, as it is already in the "severity" ({{TSError()}}. > There should be *no* {{\n}} at the end of the message. -- This message is automatically generated by JIRA. If you think it was sent incorrectly, please contact your JIRA administrators For more information on JIRA, see: http://www.atlassian.com/software/jira