Package org.apache.nifi.processors.standard

Class LogAttribute

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.LogAttribute

All Implemented Interfaces:

ConfigurableComponent, Processor

@SideEffectFree
@SupportsBatching(defaultDuration=TWENTY_FIVE_MILLIS)
@Tags({"attributes","logging"})
@InputRequirement(INPUT_REQUIRED)
@CapabilityDescription("Emits attributes of the FlowFile at the specified log level")
public class LogAttribute
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LogAttribute.DebugLevels
protected static class	LogAttribute.FlowFilePayloadCallback

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyDescriptor	ATTRIBUTES_TO_IGNORE_CSV
static final PropertyDescriptor	ATTRIBUTES_TO_IGNORE_REGEX
static final PropertyDescriptor	ATTRIBUTES_TO_LOG_CSV
static final PropertyDescriptor	ATTRIBUTES_TO_LOG_REGEX
static final PropertyDescriptor	CHARSET
static final String	FIFTY_DASHES
(package private) static final PropertyDescriptor	LOG_FLOWFILE_PROPERTIES
static final PropertyDescriptor	LOG_LEVEL
static final PropertyDescriptor	LOG_PAYLOAD
static final PropertyDescriptor	LOG_PREFIX
static final long	ONE_MB
static final PropertyDescriptor	OUTPUT_FORMAT
private static final AllowableValue	OUTPUT_FORMAT_LINE_PER_ATTRIBUTE
private static final AllowableValue	OUTPUT_FORMAT_SINGLE_LINE
static final Relationship	REL_SUCCESS
private Set<Relationship>	relationships
private List<PropertyDescriptor>	supportedDescriptors

Constructor Summary

Constructors

Constructor	Description
LogAttribute()

Method Summary

Modifier and Type	Method	Description
private Set<String>	getAttributesToLog(Set<String> flowFileAttrKeys, ProcessContext context)
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
void	onTrigger(ProcessContext context, ProcessSession session)
protected String	processFlowFile(ComponentLog logger, LogAttribute.DebugLevels logLevel, FlowFile flowFile, ProcessSession session, ProcessContext context)
private void	transferChunk(ProcessSession session)

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Methods inherited from interface org.apache.nifi.processor.Processor

isStateful, migrateProperties, migrateRelationships

Field Details

OUTPUT_FORMAT_LINE_PER_ATTRIBUTE

private static final AllowableValue OUTPUT_FORMAT_LINE_PER_ATTRIBUTE

OUTPUT_FORMAT_SINGLE_LINE

private static final AllowableValue OUTPUT_FORMAT_SINGLE_LINE

LOG_LEVEL

public static final PropertyDescriptor LOG_LEVEL

ATTRIBUTES_TO_LOG_CSV

public static final PropertyDescriptor ATTRIBUTES_TO_LOG_CSV

ATTRIBUTES_TO_LOG_REGEX

public static final PropertyDescriptor ATTRIBUTES_TO_LOG_REGEX

ATTRIBUTES_TO_IGNORE_CSV

public static final PropertyDescriptor ATTRIBUTES_TO_IGNORE_CSV

ATTRIBUTES_TO_IGNORE_REGEX

public static final PropertyDescriptor ATTRIBUTES_TO_IGNORE_REGEX

OUTPUT_FORMAT

public static final PropertyDescriptor OUTPUT_FORMAT

LOG_PAYLOAD

public static final PropertyDescriptor LOG_PAYLOAD

LOG_FLOWFILE_PROPERTIES

static final PropertyDescriptor LOG_FLOWFILE_PROPERTIES

LOG_PREFIX

public static final PropertyDescriptor LOG_PREFIX

CHARSET

public static final PropertyDescriptor CHARSET

FIFTY_DASHES

public static final String FIFTY_DASHES

See Also:

• Constant Field Values

ONE_MB

public static final long ONE_MB

See Also:

• Constant Field Values

relationships

private Set<Relationship> relationships

supportedDescriptors

private List<PropertyDescriptor> supportedDescriptors

REL_SUCCESS

public static final Relationship REL_SUCCESS

Constructor Details

LogAttribute

public LogAttribute()

Method Details

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

processFlowFile

protected String processFlowFile(ComponentLog logger,
 LogAttribute.DebugLevels logLevel,
 FlowFile flowFile,
 ProcessSession session,
 ProcessContext context)

getAttributesToLog

private Set<String> getAttributesToLog(Set<String> flowFileAttrKeys,
 ProcessContext context)

transferChunk

private void transferChunk(ProcessSession session)

onTrigger

public void onTrigger(ProcessContext context,
 ProcessSession session)

Specified by:

onTrigger in class AbstractProcessor