Avro codec plugin

• Plugin version: v3.5.0 (Other versions)
• Released on: 2025-11-26
• Changelog

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Read serialized Avro records as Logstash events

This plugin is used to serialize Logstash events as Avro datums, as well as deserializing Avro datums into Logstash events.

The plugin behaves the same regardless of ECS compatibility, except adding the original message to [event][original].

This codec is for serializing individual Logstash events as Avro datums that are Avro binary blobs. It does not encode Logstash events into an Avro file.

This codec is for deserializing individual Avro records. It is not for reading Avro files. Avro files have a unique format that must be handled upon input.

Partial deserialization

Avro format is known to support partial deserialization of arbitrary fields, providing a schema containing a subset of the schema which was used to serialize the data. This codec doesn’t support partial deserialization of arbitrary fields. Partial deserialization might work only when providing a schema which contains the first N fields of the schema used to serialize the data (and in the same order).

Example usage with Kafka input.

input {
  kafka {
    codec => avro {
        schema_uri => "/tmp/schema.avsc"
    }
  }
}
filter {
  ...
}
output {
  ...
}
		

• Value type is string

• Supported values are:

  • disabled: Avro data added at root level
  • v1,v8: Elastic Common Schema compliant behavior ([event][original] is also added)

Controls this plugin’s compatibility with the Elastic Common Schema (ECS).

• Value can be any of: binary, base64
• Default value is base64

Set encoding for Avro’s payload. Use base64 (default) to indicate that this codec sends or expects to receive base64-encoded bytes.

Set this option to binary to indicate that this codec sends or expects to receive binary Avro data.

• Value type is password
• There is no default value for this setting.

Password for HTTP basic authentication when fetching remote schemas. Used together with username.

• Value type is uri
• There is no default value for this setting.

The address of a forward HTTP proxy to use when contacting a remote schema registry.

• This is a required setting.
• Value type is string
• There is no default value for this setting.

schema path to fetch the schema from. This can be a http or file scheme URI example:

• http - http://example.com/schema.avsc
• file - /path/to/schema.avsc

• Value type is boolean
• Default value is false

tag events with _avroparsefailure when decode fails

• Value type is path
• There is no default value for this setting.

Path to PEM encoded certificate file for client authentication (mutual TLS). You may use this setting or ssl_keystore_path, but not both simultaneously.

Example

ssl_certificate => "/path/to/client.crt"
		

• Value type is a list of path
• There is no default value for this setting.

Path to PEM encoded CA certificate file(s) for server verification. This is an alternative to using ssl_truststore_path. You may use this setting or ssl_truststore_path, but not both simultaneously.

Example

ssl_certificate_authorities => ["/path/to/ca.crt"]
		

• Value type is array
• There is no default value for this setting.

The list of cipher suites to use, listed by priorities. Supported cipher suites vary depending on which version of Java is used.

• Value type is path
• There is no default value for this setting.

Path to PEM encoded private key file for client authentication. Must be used together with ssl_certificate. The private key must be unencrypted (passphrase-protected keys are not supported).

Example

ssl_key => "/path/to/client.key"
		

• Value type is boolean
• There is no default value for this setting.

Enable SSL/TLS secured communication to remote schema registry. When using HTTPS schema URIs, SSL is automatically enabled.

• Value type is path
• There is no default value for this setting.

The path to the JKS or PKCS12 keystore file for client certificate authentication. Use this when the schema registry requires mutual TLS (mTLS) authentication.

• Value type is password
• There is no default value for this setting.

The password for the keystore file specified in ssl_keystore_path.

• Value type is string
• There is no default value for this setting.

The format of the keystore file. It must be either jks or pkcs12.

• Value type is array
• Default value is [] (uses Java defaults)
• Valid values are: TLSv1.1, TLSv1.2, TLSv1.3

List of allowed SSL/TLS protocol versions. When not specified, the JVM defaults are used.

• Value type is path
• There is no default value for this setting.

The path to the JKS or PKCS12 truststore file containing certificates to verify the schema registry server’s certificate.

Example

input {
  kafka {
    codec => avro {
        schema_uri => "https://schema-registry.example.com:8081/schemas/ids/1"
        ssl_truststore_path => "/path/to/truststore.jks"
        ssl_truststore_password => "${TRUSTSTORE_PASSWORD}"
    }
  }
}
		

• Value type is password
• There is no default value for this setting.

The password for the truststore file specified in ssl_truststore_path.

• Value type is string
• There is no default value for this setting.

The format of the truststore file. It must be either jks or pkcs12.

• Value type is string
• Default value is "full"
• Valid options are: full, none

Options to verify the server’s certificate:

• full: Validates that the provided certificate has an issue date that’s within the not_before and not_after dates; chains to a trusted Certificate Authority (CA); has a hostname or IP address that matches the names within the certificate. (recommended)
• none: Performs no certificate validation. Warning: Disabling this severely compromises security (https://www.cs.utexas.edu/~shmat/shmat_ccs12.pdf)

Example

input {
  kafka {
    codec => avro {
        schema_uri => "https://schema-registry.example.com:8081/schemas/ids/1"
        ssl_certificate_authorities => ["/path/to/ca.crt"]
        ssl_verification_mode => "full"
    }
  }
}
		

• Value type is string
• There is no default value for this setting.
• This is only relevant when decode data into an event

Define the target field for placing the values. If this setting is not set, the Avro data will be stored at the root (top level) of the event.

Example

input {
  kafka {
    codec => avro {
        schema_uri => "/tmp/schema.avsc"
        target => "[document]"
    }
  }
}
		

• Value type is string
• There is no default value for this setting.

Username for HTTP basic authentication when fetching remote schemas. Used together with password.

Example

input {
  kafka {
    codec => avro {
        schema_uri => "https://schema-registry.example.com:8081/schemas/ids/1"
        username => "registry_user"
        password => "${REGISTRY_PASSWORD}"
    }
  }
}