Package com.yahoo.log

Class VespaFormatter

java.lang.Object

java.util.logging.Formatter

java.util.logging.SimpleFormatter

com.yahoo.log.VespaFormatter

@Deprecated(since="7",
            forRemoval=true)
public class VespaFormatter
extends SimpleFormatter

Deprecated, for removal: This API element is subject to removal in a future version.

Should only be used internally in the log library

This class implements a log formatter which takes care of formatting messages according to the VESPA common log format.

Author:

Bjorn Borud, arnej27959

Field Summary

Fields

Modifier and Type	Field	Description
static String	serviceNameUnsetValue	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Constructor	Description
VespaFormatter()	Deprecated, for removal: This API element is subject to removal in a future version. Default constructor
VespaFormatter(String serviceName, String componentPrefix)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
String	format(LogRecord r)	Deprecated, for removal: This API element is subject to removal in a future version.
String	getServiceName()	Deprecated, for removal: This API element is subject to removal in a future version. Get the service name for this formatter.
void	setServiceName(String serviceName)	Deprecated, for removal: This API element is subject to removal in a future version. Set the service name (usually the VESPA config-id) of this formatter.
static String	toMessageString(Throwable t)	Deprecated, for removal: This API element is subject to removal in a future version.
static String	unEscape(String s)	Deprecated, for removal: This API element is subject to removal in a future version. Un-escapes previously escaped string.

Methods inherited from class java.util.logging.Formatter

formatMessage, getHead, getTail

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serviceNameUnsetValue

public static final String serviceNameUnsetValue

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

Constant Field Values

Constructor Detail

VespaFormatter

public VespaFormatter()

Deprecated, for removal: This API element is subject to removal in a future version.

Default constructor

VespaFormatter

public VespaFormatter(String serviceName,
                      String componentPrefix)

Deprecated, for removal: This API element is subject to removal in a future version.

Parameters:

serviceName - The VESPA service name.

componentPrefix - The application name.

Method Detail

unEscape

public static String unEscape(String s)

Deprecated, for removal: This API element is subject to removal in a future version.

Un-escapes previously escaped string. note: look at com.yahoo.config.StringNode.unescapeQuotedString()

Parameters:

s - String that might need un-escaping

Returns:

Returns un-escaped string

format

public String format(LogRecord r)

Deprecated, for removal: This API element is subject to removal in a future version.

Overrides:

format in class SimpleFormatter

setServiceName

public void setServiceName(String serviceName)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the service name (usually the VESPA config-id) of this formatter.

Parameters:

serviceName - The service name

getServiceName

public String getServiceName()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the service name for this formatter.

Returns:

Returns the service name.

toMessageString

public static String toMessageString(Throwable t)

Deprecated, for removal: This API element is subject to removal in a future version.