Field name casing
Protobuf JSON uses lowerCamelCase by default, so email_address becomes emailAddress
{"id":1,"email_address":"a@b.com"}Kafka Protobuf JSON Converter
Check a JSON document against a .proto and get the canonical
proto3 form back. The differences that bite are named individually: a 64-bit
integer written as a number, a field written with its proto name, a value an
unsigned field cannot hold.
A type behind an import has to be pasted in alongside:
this page reads one file. The google.protobuf.* well-known
types are built in and still need their import line, the
way protoc requires.
Paste below, or drop a file anywhere on this panel
Or drop a file anywhere on this panel. Nothing is uploaded: the analysis runs in this tab.
The answer appears here
Paste on the left and press Check. Nothing leaves this tab.
Formatted
Results
Nothing else to flag.
No formatting problems, and nothing the rules object to. Worth remembering what that covers: this reads the file you pasted, not the account or cluster it will be applied to.
No finding matches that filter.
Examples
Real input you can load into the tool above. Each one shows a different thing going wrong, because that is what the tool is for.
Default values omitted
Proto3 JSON leaves scalar defaults out entirely, which is not the same as null
{"id":0,"emailAddress":""}Common mistakes
These are the ones that fail silently. The config is accepted, nothing raises an error, and the consequence arrives later.
Expecting snake_case in the JSON
Canonical protobuf JSON uses lowerCamelCase, so email_address becomes emailAddress. Most libraries accept both on input and emit camel.
Instead:Configure the printer if you need original names, and be consistent.
Reading an absent field as null
Proto3 JSON omits scalar defaults entirely. An absent field means zero, empty or false, not null.
Instead:Use wrappers or optional if you need to distinguish.
Assuming 64-bit ints stay numbers
int64 and uint64 are encoded as STRINGS in canonical protobuf JSON, because JSON numbers lose precision above 2^53.
Instead:Parse them as strings.
The canonical JSON mapping is not the JSON you would have written
Protobuf specifies exactly one JSON form, and a Java service using JsonFormat, a Confluent JSON converter and a Go service all emit that one. Hand-written documents rarely match it, and the mismatches are quiet.
Sixty-four-bit integers are quoted strings
int64, uint64, sint64, fixed64 and sfixed64 all serialise as JSON strings. Thirty-two-bit types stay numbers. The reason is that a JSON number is an IEEE 754 double, which holds integers exactly only to 2^53, and a protobuf int64 runs to 9223372036854775807. A consumer that expects a number gets a string; a producer that writes a number loses precision above 9007199254740991 without any error at all. This page names every field where that applies.
Field names are lowerCamelCase, by a rule with a twist in it
protoc derives a JSON name for every field by removing underscores and capitalising what follows, so field_with_underscores becomes fieldWithUnderscores. The twist is that it does not lowercase the first letter, so a field named FooBar stays FooBar rather than becoming fooBar. A parser accepts the original proto name as well, which is why a document written with proto names appears to work and then does not round-trip.
Default values are absent, and that is not the same as null
A singular proto3 scalar holding its default is not written at all: a false bool, a zero int, an empty string are all simply missing from the document. There is no null and no key. Anything that has to tell unset from zero, a patch, a nullable column, a partial update, cannot, unless the field is declared optional. A field that is optional, or a oneof member, or a message, does have presence and does appear even at its default.
The well-known types have their own forms
Timestamp is an RFC 3339 string with zero, three, six or nine fractional digits and never any other number. Duration is a string of seconds ending in s, with the same fractional rule. The wrapper types collapse to their bare value and still appear when holding zero, because having presence is their whole purpose. FieldMask is the surprise: it is a single comma-joined string and its paths are camel-cased too, so a path written c_d comes out as cD.
What this cannot see
Anything in another file. This page reads one .proto, so a type behind an import has to be pasted in alongside. It also cannot check a custom option: (google.api.http) and the like are extensions defined in files it cannot read, so their presence is reported as unverified rather than judged either way. Enum values are checked against the enum in this file, and proto3 enums are open, so an unrecognised number is preserved rather than rejected.
More kafka tools
Kafka Confluent Wire Format Decoder The five junk bytes in front of your payload Kafka Key to Partition Mapper Which partition does this key land on? Kafka Topic Name Validator Legal, risky, or 249 characters too long? Kafka Replication Safety Checker How many brokers can you lose Kafka Producer Config Linter Will it start, and will it lose a record? Kafka Message Payload Decoder The first five bytes are usually not data Kafka Connect Source Connector Generator tasks.max is a ceiling, not a count Kafka Connect Sink Connector Generator A dead letter queue with no context headers is a pile of records Kafka Connect SMT Chain Builder The order is the transforms list Kafka MirrorMaker 2 Config Generator It renames every topic by default Kafka Partition Reassignment Generator The throttle is not optional Strimzi Kafka Resource Generator Without the cluster label, nothing happens Kafka mTLS Config Generator The certificate is the identity Kafka Schema Registry Config Generator The compatibility direction is your deployment order Kafka Exactly-Once Config Generator Half of it is worse than none Kafka Broker and KRaft Config Generator The internal topics that break a one-broker cluster Kafka Quota Generator Byte rates are per broker, not per cluster Kafka Streams Config Generator application.id is four things at once Kafka Connect Worker Config Generator Security three times, or the tasks fail Kafka Retention and Unit Converter log.retention.hours does not take milliseconds Kafka Timestamp Converter Two sentinels and two meanings Kafka .properties to YAML Converter Dotted keys stay flat Kafka Streams Internal Topic Predictor Create them before Streams does Kafka ACL Generator The grant you forgot is on another resource type Kafka Topic Config Generator min.insync.replicas is the one that matters Kafka client.properties Generator The file every CLI tool asks for Kafka Producer Config Generator No password field, on purpose Kafka Consumer Config Generator The commit mode decides the semantics Kafka Disk and Retention Calculator retention.bytes is per partition Kafka Partition Count Calculator The number you can never reduce Kafka Cluster Sizing Calculator The traffic no client metric shows Kafka Consumer Lag Catch-Up Calculator Whether it ever clears, not just when Kafka Producer Batching Calculator linger.ms=0 still batches Kafka Segment and Index Sizing Why retention.ms is a lower bound Kafka Rebalance Duration Estimator What a rolling restart really costs Kafka Cost Estimator Your rates, so nothing goes stale Kafka Config Explorer by Version The answer depends on the release Kafka Default Config Reference What moved under a config you never edited Kafka OAuth Bearer Token Decoder Will Kafka accept it, and can it refresh Kafka Record Header Viewer Headers are a list, not a map Kafka Topic Regex Subscription Tester Kafka matches the whole name Kafka ACL Permission Matrix Viewer DENY beats every ALLOW Kafka Connect Config Validator The mistakes that raise no error Kafka Consumer Group Id Validator Which broker coordinates the group Kafka Partition Assignment Visualizer Leadership is the load, not replicas Kafka Consumer Assignment Visualizer The three assignors disagree Kafka ZooKeeper to KRaft Config Converter The authorizer class nobody changes Kafka Config to Strimzi Half of it belongs elsewhere Kafka Docker Compose Generator (KRaft) Reachable from inside and outside Kafka JAAS Config Decoder The line that stops SASL working Kafka CRC32C Calculator Which CRC, over which bytes Kafka Config Upgrade Checker What breaks when you upgrade Kafka Kafka Config Diff Which change actually changed something Kafka Consumer Config Linter Why the group rebalances, and where the records went Kafka Avro Schema Validator The defaults Avro accepts and rejects Kafka Schema Compatibility Checker What the registry will say, before you ask it Kafka Avro Schema Diff Which direction each change breaks Kafka Compression Comparison Measured on your bytes Kafka Delivery Semantics Exactly-once has a consumer half Kafka ksqlDB Query Builder It looks like SQL and the rules are not Kafka Connect SMT Predicate Tester negate reads backwards Kafka Streams Topology Viewer Count the repartitions Kafka Connect Pipeline Visualizer The order things really run in Kafka Protobuf Binary Decoder Works without the .proto Kafka Protobuf to Avro Schema What does not survive the conversion Kafka Avro Binary Decoder Wrong schema, no error Kafka Avro JSON Converter Why the console producer rejects your line Kafka Avro Sample Data Generator Records that actually serialize Kafka JSON to Avro Schema What JSON cannot tell you Kafka JSON Schema to Avro What does not survive the conversion Kafka SASL JAAS Generator One login module, four syntaxes Kafka CLI Command Builder kcat is librdkafka, not Kafka