Package net.logstash.logback.argument
Interface StructuredArgument
- All Known Implementing Classes:
DeferredStructuredArgument
,EmptyLogstashMarker
,MapEntriesAppendingMarker
,ObjectAppendingMarker
,ObjectFieldsAppendingMarker
,RawJsonAppendingMarker
,SingleFieldAppendingMarker
public interface StructuredArgument
A wrapper for an argument passed to a log method (e.g.
Logger.info(String, Object...)
)
that adds data to the JSON event (via ArgumentsJsonProvider
).-
Method Summary
Modifier and TypeMethodDescriptiontoString()
Writes the data associated with this argument to aString
to be included in a log event's formatted message (via parameter substitution).void
writeTo
(JsonGenerator generator) Writes the data associated with this argument to the givenJsonGenerator
.
-
Method Details
-
writeTo
Writes the data associated with this argument to the givenJsonGenerator
.- Parameters:
generator
- theJsonGenerator
to produce JSON content- Throws:
IOException
- if an I/O error occurs
-
toString
String toString()Writes the data associated with this argument to aString
to be included in a log event's formatted message (via parameter substitution).Note that this will only be included in the log event's formatted message if the message format includes a parameter for this argument.
-