Skip to content

KAFKA-6733: Support of printing additional ConsumerRecord fields in DefaultMessageFormatter #4807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Matzz wants to merge 2 commits into from
Closed

KAFKA-6733: Support of printing additional ConsumerRecord fields in DefaultMessageFormatter #4807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b92f4f6
KAFKA-6733: Support of printing additional ConsumerRecord fields in D…
Matzz Mar 31, 2018
0e4e28d
KAFKA-6733 - added new properties documentation, renamed header to he…
onzo-mateuszzakarczemny Mar 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
163 changes: 111 additions & 52 deletions core/src/main/scala/kafka/tools/ConsoleConsumer.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,16 +223,22 @@ object ConsoleConsumer extends Logging {
.ofType(classOf[String])
.defaultsTo(classOf[DefaultMessageFormatter].getName)
val messageFormatterArgOpt = parser.accepts("property",
"The properties to initialize the message formatter. Default properties include:\n" +
"\tprint.timestamp=true|false\n" +
"\tprint.key=true|false\n" +
"\tprint.value=true|false\n" +
"\tkey.separator=<key.separator>\n" +
"\tline.separator=<line.separator>\n" +
"\tkey.deserializer=<key.deserializer>\n" +
"\tvalue.deserializer=<value.deserializer>\n" +
"\nUsers can also pass in customized properties for their formatter; more specifically, users " +
"can pass in properties keyed with \'key.deserializer.\' and \'value.deserializer.\' prefixes to configure their deserializers.")
"""The properties to initialize the message formatter. Default properties include:
| print.timestamp=true|false
| print.key=true|false
| print.offset=true|false
| print.partition=true|false
| print.headers=true|false
| print.value=true|false
| key.separator=<key.separator>
| line.separator=<line.separator>
| headers.separator=<line.separator>
| key.deserializer=<key.deserializer>
| value.deserializer=<value.deserializer>
| header.deserializer=<header.deserializer>
|
|Users can also pass in customized properties for their formatter; more specifically, users can pass in properties keyed with 'key.deserializer.', 'value.deserializer.' and 'headers.deserializer.' prefixes to configure their deserializers."""
.stripMargin)
.withRequiredArg
.describedAs("prop")
.ofType(classOf[String])
Expand Down Expand Up @@ -457,47 +463,34 @@ object ConsoleConsumer extends Logging {
}

class DefaultMessageFormatter extends MessageFormatter {
var printTimestamp = false
var printKey = false
var printOffset = false
var printPartition = false
var printHeaders = false
var printValue = true
var printTimestamp = false
var keySeparator = "\t".getBytes(StandardCharsets.UTF_8)
var lineSeparator = "\n".getBytes(StandardCharsets.UTF_8)
var keySeparator = utfBytes("\t")
var headersSeparator = utfBytes(",")
var lineSeparator = utfBytes("\n")

var keyDeserializer: Option[Deserializer[_]] = None
var valueDeserializer: Option[Deserializer[_]] = None
var headersDeserializer: Option[Deserializer[_]] = None

override def init(props: Properties) {
if (props.containsKey("print.timestamp"))
printTimestamp = props.getProperty("print.timestamp").trim.equalsIgnoreCase("true")
if (props.containsKey("print.key"))
printKey = props.getProperty("print.key").trim.equalsIgnoreCase("true")
if (props.containsKey("print.value"))
printValue = props.getProperty("print.value").trim.equalsIgnoreCase("true")
if (props.containsKey("key.separator"))
keySeparator = props.getProperty("key.separator").getBytes(StandardCharsets.UTF_8)
if (props.containsKey("line.separator"))
lineSeparator = props.getProperty("line.separator").getBytes(StandardCharsets.UTF_8)
// Note that `toString` will be called on the instance returned by `Deserializer.deserialize`
if (props.containsKey("key.deserializer")) {
keyDeserializer = Some(Class.forName(props.getProperty("key.deserializer")).getDeclaredConstructor()
.newInstance().asInstanceOf[Deserializer[_]])
keyDeserializer.get.configure(propertiesWithKeyPrefixStripped("key.deserializer.", props).asScala.asJava, true)
}
// Note that `toString` will be called on the instance returned by `Deserializer.deserialize`
if (props.containsKey("value.deserializer")) {
valueDeserializer = Some(Class.forName(props.getProperty("value.deserializer")).getDeclaredConstructor()
.newInstance().asInstanceOf[Deserializer[_]])
valueDeserializer.get.configure(propertiesWithKeyPrefixStripped("value.deserializer.", props).asScala.asJava, false)
}
}

private def propertiesWithKeyPrefixStripped(prefix: String, props: Properties): Properties = {
val newProps = new Properties()
props.asScala.foreach { case (key, value) =>
if (key.startsWith(prefix) && key.length > prefix.length)
newProps.put(key.substring(prefix.length), value)
}
newProps
getPropertyIfExists(props, "print.timestamp", getBoolProperty).foreach(printTimestamp = _)
getPropertyIfExists(props, "print.key", getBoolProperty).foreach(printKey = _)
getPropertyIfExists(props, "print.offset", getBoolProperty).foreach(printOffset = _)
getPropertyIfExists(props, "print.partition", getBoolProperty).foreach(printPartition = _)
getPropertyIfExists(props, "print.headers", getBoolProperty).foreach(printHeaders = _)
getPropertyIfExists(props, "print.value", getBoolProperty).foreach(printValue = _)
getPropertyIfExists(props, "key.separator", getByteProperty).foreach(keySeparator = _)
getPropertyIfExists(props, "line.separator", getByteProperty).foreach(lineSeparator = _)
getPropertyIfExists(props, "headers.separator", getByteProperty).foreach(headersSeparator = _)

keyDeserializer = getPropertyIfExists(props, "key.deserializer", getDeserializerProperty(true))
valueDeserializer = getPropertyIfExists(props, "value.deserializer", getDeserializerProperty(false))
headersDeserializer = getPropertyIfExists(props, "headers.deserializer", getDeserializerProperty(false))
}

def writeTo(consumerRecord: ConsumerRecord[Array[Byte], Array[Byte]], output: PrintStream) {
Expand All @@ -510,32 +503,98 @@ class DefaultMessageFormatter extends MessageFormatter {
}

def write(deserializer: Option[Deserializer[_]], sourceBytes: Array[Byte], topic: String) {
val nonNullBytes = Option(sourceBytes).getOrElse("null".getBytes(StandardCharsets.UTF_8))
val convertedBytes = deserializer.map(_.deserialize(topic, nonNullBytes).toString.
getBytes(StandardCharsets.UTF_8)).getOrElse(nonNullBytes)
output.write(convertedBytes)
output.write(deserialize(deserializer, sourceBytes, topic))
}

import consumerRecord._

if (printTimestamp) {
if (timestampType != TimestampType.NO_TIMESTAMP_TYPE)
output.write(s"$timestampType:$timestamp".getBytes(StandardCharsets.UTF_8))
output.write(utfBytes(s"$timestampType:$timestamp"))
else
output.write(s"NO_TIMESTAMP".getBytes(StandardCharsets.UTF_8))
writeSeparator(printKey || printValue)
output.write(utfBytes("NO_TIMESTAMP"))
writeSeparator(columnSeparator = printKey || printOffset || printPartition || printHeaders || printValue)
}

if (printKey) {
write(keyDeserializer, key, topic)
writeSeparator(printValue)
writeSeparator(columnSeparator = printOffset || printPartition || printHeaders || printValue)
}

if (printOffset) {
output.write(utfBytes(offset().toString))
writeSeparator(columnSeparator = printPartition || printHeaders || printValue)
}

if (printPartition) {
output.write(utfBytes(partition().toString))
writeSeparator(columnSeparator = printHeaders || printValue)
}

if (printHeaders) {
val headersIt = headers().iterator.asScala
if(headersIt.hasNext) {
headersIt.foreach { header =>
output.write(utfBytes(header.key() + ":"))
output.write(deserialize(headersDeserializer, header.value(), topic))
if(headersIt.hasNext) {
output.write(headersSeparator)
}
}
} else {
output.write(utfBytes("NO_HEADERS"))
}
writeSeparator(columnSeparator = printValue)
}

if (printValue) {
write(valueDeserializer, value, topic)
output.write(lineSeparator)
}
}

private def propertiesWithKeyPrefixStripped(prefix: String, props: Properties): Properties = {
val newProps = new Properties()
props.asScala.foreach { case (key, value) =>
if (key.startsWith(prefix) && key.length > prefix.length)
newProps.put(key.substring(prefix.length), value)
}
newProps
}

private def deserialize(deserializer: Option[Deserializer[_]], sourceBytes: Array[Byte], topic: String) = {
val nonNullBytes = Option(sourceBytes).getOrElse(utfBytes("null"))
val convertedBytes = deserializer
.map(d => utfBytes(d.deserialize(topic, nonNullBytes).toString))
.getOrElse(nonNullBytes)
convertedBytes
}

private def utfBytes(str: String) = str.getBytes(StandardCharsets.UTF_8)

private def getByteProperty(props: Properties, key: String): Array[Byte] = {
utfBytes(props.getProperty(key))
}

private def getBoolProperty(props: Properties, key: String): Boolean = {
props.getProperty(key).trim.equalsIgnoreCase("true")
}

private def getDeserializerProperty(isKey: Boolean)(props: Properties, propertyName: String): Deserializer[_] = {
val deserializer = Class.forName(props.getProperty(propertyName)).newInstance().asInstanceOf[Deserializer[_]]
val deserializerConfig = propertiesWithKeyPrefixStripped(propertyName + ".", props)
.asScala
.asJava
deserializer.configure(deserializerConfig, isKey)
deserializer
}

private def getPropertyIfExists[T](props: Properties, key: String, getter: (Properties, String) => T): Option[T] = {
if (props.containsKey(key))
Some(getter(props, key))
else
None
}
}

class LoggingMessageFormatter extends MessageFormatter with LazyLogging {
Expand Down
Loading