CEFReader

CEFReader 2.0.0

Bundle: org.apache.nifi | nifi-record-serialization-services-nar
Description: Parses CEF (Common Event Format) events, returning each row as a record. This reader allows for inferring a schema based on the first event in the FlowFile or providing an explicit schema for interpreting the values.
Tags: cef, parser, reader, record
Input Requirement
Supports Sensitive Dynamic Properties: false

Properties

Accept empty extensions
If set to true, empty extensions will be accepted and will be associated to a null value.
Display Name

Accept empty extensions

Description

If set to true, empty extensions will be accepted and will be associated to a null value.

API Name

accept-empty-extensions

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
DateTime Locale
The IETF BCP 47 representation of the Locale to be used when parsing date fields with long or short month names (e.g. may <en-US> vs. mai. <fr-FR>. The defaultvalue is generally safe. Only change if having issues parsing CEF messages

Display Name

DateTime Locale

Description

The IETF BCP 47 representation of the Locale to be used when parsing date fields with long or short month names (e.g. may <en-US> vs. mai. <fr-FR>. The defaultvalue is generally safe. Only change if having issues parsing CEF messages

API Name

datetime-representation

Default Value

en-US

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Inference Strategy
Defines the set of fields should be included in the schema and the way the fields are being interpreted.
Display Name

Inference Strategy

Description

Defines the set of fields should be included in the schema and the way the fields are being interpreted.

API Name

inference-strategy

Default Value

custom-extensions-inferred

Allowable Values
- Headers only
- Headers and extensions
- With custom extensions as strings
- With custom extensions inferred
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Schema Access Strategy is set to any of [infer-schema]
Invalid Field
Used when a line in the FlowFile cannot be parsed by the CEF parser. If set, instead of failing to process the FlowFile, a record is being added with one field. This record contains one field with the name specified by the property and the raw message as value.

Display Name

Invalid Field

Description

Used when a line in the FlowFile cannot be parsed by the CEF parser. If set, instead of failing to process the FlowFile, a record is being added with one field. This record contains one field with the name specified by the property and the raw message as value.

API Name

invalid-message-field

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Raw Message Field
If set the raw message will be added to the record using the property value as field name. This is not the same as the "rawEvent" extension field!

Display Name

Raw Message Field

Description

If set the raw message will be added to the record using the property value as field name. This is not the same as the "rawEvent" extension field!

API Name

raw-message-field

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Schema Access Strategy
Specifies how to obtain the schema that is to be used for interpreting the data.
Display Name

Schema Access Strategy

Description

Specifies how to obtain the schema that is to be used for interpreting the data.

API Name

schema-access-strategy

Default Value

infer-schema

Allowable Values
- Use 'Schema Name' Property
- Use 'Schema Text' Property
- Schema Reference Reader
- Infer Schema
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Schema Branch
Specifies the name of the branch to use when looking up the schema in the Schema Registry property. If the chosen Schema Registry does not support branching, this value will be ignored.
Display Name

Schema Branch

Description

Specifies the name of the branch to use when looking up the schema in the Schema Registry property. If the chosen Schema Registry does not support branching, this value will be ignored.

API Name

schema-branch

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-name]
Schema Inference Cache
Specifies a Schema Cache to use when inferring the schema. If not populated, the schema will be inferred each time. However, if a cache is specified, the cache will first be consulted and if the applicable schema can be found, it will be used instead of inferring the schema.
Display Name

Schema Inference Cache

Description

Specifies a Schema Cache to use when inferring the schema. If not populated, the schema will be inferred each time. However, if a cache is specified, the cache will first be consulted and if the applicable schema can be found, it will be used instead of inferring the schema.

API Name

schema-inference-cache

Service Interface

org.apache.nifi.serialization.RecordSchemaCacheService

Service Implementations

org.apache.nifi.schema.inference.VolatileSchemaCache

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [infer-schema]
Schema Name
Specifies the name of the schema to lookup in the Schema Registry property
Display Name

Schema Name

Description

Specifies the name of the schema to lookup in the Schema Registry property

API Name

schema-name

Default Value

${schema.name}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-name]
Schema Reference Reader
Service implementation responsible for reading FlowFile attributes or content to determine the Schema Reference Identifier
Display Name

Schema Reference Reader

Description

Service implementation responsible for reading FlowFile attributes or content to determine the Schema Reference Identifier

API Name

schema-reference-reader

Service Interface

org.apache.nifi.schemaregistry.services.SchemaReferenceReader

Service Implementations

org.apache.nifi.confluent.schemaregistry.ConfluentEncodedSchemaReferenceReader

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Schema Access Strategy is set to any of [schema-reference-reader]
Schema Registry
Specifies the Controller Service to use for the Schema Registry
Display Name

Schema Registry

Description

Specifies the Controller Service to use for the Schema Registry

API Name

schema-registry

Service Interface

org.apache.nifi.schemaregistry.services.SchemaRegistry

Service Implementations

org.apache.nifi.aws.schemaregistry.AmazonGlueSchemaRegistry

org.apache.nifi.apicurio.schemaregistry.ApicurioSchemaRegistry

org.apache.nifi.schemaregistry.services.AvroSchemaRegistry

org.apache.nifi.confluent.schemaregistry.ConfluentSchemaRegistry

org.apache.nifi.db.schemaregistry.DatabaseTableSchemaRegistry

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-reference-reader, schema-name]
Schema Text
The text of an Avro-formatted Schema
Display Name

Schema Text

Description

The text of an Avro-formatted Schema

API Name

schema-text

Default Value

${avro.schema}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-text-property]
Schema Version
Specifies the version of the schema to lookup in the Schema Registry. If not specified then the latest version of the schema will be retrieved.
Display Name

Schema Version

Description

Specifies the version of the schema to lookup in the Schema Registry. If not specified then the latest version of the schema will be retrieved.

API Name

schema-version

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-name]