[
https://issues.apache.org/jira/browse/NIFI-5337?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16545227#comment-16545227
]
ASF GitHub Bot commented on NIFI-5337:
--------------------------------------
Github user bbende commented on a diff in the pull request:
https://github.com/apache/nifi/pull/2816#discussion_r202687489
--- Diff:
nifi-nar-bundles/nifi-standard-services/nifi-record-serialization-services-bundle/nifi-record-serialization-services/src/main/java/org/apache/nifi/syslog/Syslog5424Reader.java
---
@@ -0,0 +1,151 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.nifi.syslog;
+
+import org.apache.nifi.annotation.documentation.CapabilityDescription;
+import org.apache.nifi.annotation.documentation.Tags;
+import org.apache.nifi.annotation.lifecycle.OnEnabled;
+import org.apache.nifi.components.AllowableValue;
+import org.apache.nifi.components.PropertyDescriptor;
+import org.apache.nifi.components.ValidationContext;
+import org.apache.nifi.controller.ConfigurationContext;
+import org.apache.nifi.logging.ComponentLog;
+import org.apache.nifi.processor.util.StandardValidators;
+import org.apache.nifi.schema.access.SchemaAccessStrategy;
+import org.apache.nifi.schema.access.SchemaField;
+import org.apache.nifi.schema.access.SchemaNotFoundException;
+import org.apache.nifi.schemaregistry.services.SchemaRegistry;
+import org.apache.nifi.serialization.RecordReader;
+import org.apache.nifi.serialization.RecordReaderFactory;
+import org.apache.nifi.serialization.SchemaRegistryService;
+import org.apache.nifi.serialization.SimpleRecordSchema;
+import org.apache.nifi.serialization.record.RecordField;
+import org.apache.nifi.serialization.record.RecordFieldType;
+import org.apache.nifi.serialization.record.RecordSchema;
+import org.apache.nifi.syslog.attributes.Syslog5424Attributes;
+import org.apache.nifi.syslog.attributes.SyslogAttributes;
+import org.apache.nifi.syslog.keyproviders.SimpleKeyProvider;
+import org.apache.nifi.syslog.parsers.StrictSyslog5424Parser;
+import org.apache.nifi.syslog.utils.NifiStructuredDataPolicy;
+import org.apache.nifi.syslog.utils.NilHandlingPolicy;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.charset.Charset;
+import java.util.ArrayList;
+import java.util.EnumSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+@Tags({"syslog 5424", "syslog", "logs", "logfiles", "parse", "text",
"record", "reader"})
+@CapabilityDescription("Provides a mechanism for reading RFC 5424
compliant Syslog data, such as log files, and structuring the data" +
+ " so that it can be processed.")
+public class Syslog5424Reader extends SchemaRegistryService implements
RecordReaderFactory {
+ static final AllowableValue RFC_5424_SCHEMA = new
AllowableValue("default-5424-schema", "Use RFC 5424 Schema",
+ "The schema will be the default schema per RFC 5424.");
+ public static final PropertyDescriptor CHARSET = new
PropertyDescriptor.Builder()
+ .name("Character Set")
+ .description("Specifies which character set of the Syslog
messages")
+ .required(true)
+ .defaultValue("UTF-8")
+ .addValidator(StandardValidators.CHARACTER_SET_VALIDATOR)
+ .build();
+
+ private volatile StrictSyslog5424Parser parser;
+ private volatile RecordSchema recordSchema;
+
+ @Override
+ protected List<PropertyDescriptor> getSupportedPropertyDescriptors() {
+ final List<PropertyDescriptor> properties = new ArrayList<>(1);
+ properties.add(CHARSET);
+ return properties;
+ }
+
+
+ @OnEnabled
+ public void onEnabled(final ConfigurationContext context) {
+ final String charsetName = context.getProperty(CHARSET).getValue();
+ parser = new StrictSyslog5424Parser(Charset.forName(charsetName),
NilHandlingPolicy.NULL, NifiStructuredDataPolicy.MAP_OF_MAPS, new
SimpleKeyProvider());
+ recordSchema = createRecordSchema();
+ }
+
+ @Override
+ protected List<AllowableValue> getSchemaAccessStrategyValues() {
+ final List<AllowableValue> allowableValues = new ArrayList<>();
+ allowableValues.add(RFC_5424_SCHEMA);
+ return allowableValues;
+ }
+
+ @Override
+ protected AllowableValue getDefaultSchemaAccessStrategy() {
+ return RFC_5424_SCHEMA;
+ }
+
+ @Override
+ protected SchemaAccessStrategy getSchemaAccessStrategy(final String
strategy, final SchemaRegistry schemaRegistry, final ConfigurationContext
context) {
+ return createAccessStrategy();
+ }
+
+ @Override
+ protected SchemaAccessStrategy getSchemaAccessStrategy(final String
strategy, final SchemaRegistry schemaRegistry, final ValidationContext context)
{
+ return createAccessStrategy();
+ }
+
+ static RecordSchema createRecordSchema() {
+ final List<RecordField> fields = new ArrayList<>();
+ fields.add(new RecordField(SyslogAttributes.PRIORITY.key(),
RecordFieldType.STRING.getDataType(), true));
+ fields.add(new RecordField(SyslogAttributes.SEVERITY.key(),
RecordFieldType.STRING.getDataType(), true));
+ fields.add(new RecordField(SyslogAttributes.FACILITY.key(),
RecordFieldType.STRING.getDataType(), true));
+ fields.add(new RecordField(SyslogAttributes.VERSION.key(),
RecordFieldType.STRING.getDataType(), true));
+ fields.add(new RecordField(SyslogAttributes.TIMESTAMP.key(),
RecordFieldType.TIMESTAMP.getDataType(), true));
+ fields.add(new RecordField(SyslogAttributes.HOSTNAME.key(),
RecordFieldType.STRING.getDataType(), true));
+ fields.add(new RecordField(SyslogAttributes.BODY.key(),
RecordFieldType.STRING.getDataType(), true));
+ fields.add(new RecordField(Syslog5424Attributes.APP_NAME.key(),
RecordFieldType.STRING.getDataType(), true));
+ fields.add(new RecordField(Syslog5424Attributes.PROCID.key(),
RecordFieldType.STRING.getDataType(), true));
+ fields.add(new RecordField(Syslog5424Attributes.MESSAGEID.key(),
RecordFieldType.STRING.getDataType(), true));
+ fields.add(new
RecordField(Syslog5424Attributes.STRUCTURED_BASE.key(),
+
RecordFieldType.MAP.getMapDataType(RecordFieldType.MAP.getMapDataType(RecordFieldType.STRING.getDataType()))));
+
+ final RecordSchema schema = new SimpleRecordSchema(fields);
--- End diff --
Sorry for the delay, something like...
SchemaIdentifier schemaIdentifier =
StandardSchemaIdentifier.Builder.name("my-name").build();
RecordSchema schema = new SimpleRecordSchema(fields, schemaIdentifier)
> Add Syslog 5424 Record Reader and create nifi-syslog-utils
> ----------------------------------------------------------
>
> Key: NIFI-5337
> URL: https://issues.apache.org/jira/browse/NIFI-5337
> Project: Apache NiFi
> Issue Type: Sub-task
> Reporter: Otto Fowler
> Assignee: Otto Fowler
> Priority: Major
>
> Create Record Reader for Syslog 5424 messages ( including structured data )
> built on the ParseSyslog5424 processor infrastructure.
>
> Create nifi-syslog-utils to centralize syslog support to be shared better the
> standard processors and the serialization library
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
