[chore] add info to avrologencodingextension README (open-telemetry#3…

…2703)
liatrio · Apr 26, 2024 · d4999c0 · d4999c0
1 parent 21a87ff
commit d4999c0
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/extension/encoding/avrologencodingextension/README.md b/extension/encoding/avrologencodingextension/README.md
@@ -12,3 +12,21 @@
 <!-- end autogenerated section -->
 
 The `avrolog` encoding extension is used to unmarshal AVRO and insert it into the body of a log record. Marshalling is not supported.
+
+The extension accepts a configuration option to specify the Avro schema to use to read the log record body.
+
+Example:
+```yaml
+extensions:
+ avro_log_encoding:
+ schema: |
+ {
+ "type" : "record",
+ "namespace" : "example",
+ "name" : "Datapoint",
+ "fields" : [
+ { "name" : "Key" , "type" : "string" },
+ { "name" : "Value" , "type" : "int" }
+ ]
+ }
+```