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:
org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.processor.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 org.apache.nifi.processor.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 org.apache.nifi.components.PropertyDescriptor
    ATTRIBUTES_TO_IGNORE_CSV
     
    static final org.apache.nifi.components.PropertyDescriptor
    ATTRIBUTES_TO_IGNORE_REGEX
     
    static final org.apache.nifi.components.PropertyDescriptor
    ATTRIBUTES_TO_LOG_CSV
     
    static final org.apache.nifi.components.PropertyDescriptor
    ATTRIBUTES_TO_LOG_REGEX
     
    static final org.apache.nifi.components.PropertyDescriptor
    CHARSET
     
    static final String
    FIFTY_DASHES
     
    (package private) static final org.apache.nifi.components.PropertyDescriptor
    LOG_FLOWFILE_PROPERTIES
     
    static final org.apache.nifi.components.PropertyDescriptor
    LOG_LEVEL
     
    static final org.apache.nifi.components.PropertyDescriptor
    LOG_PAYLOAD
     
    static final org.apache.nifi.components.PropertyDescriptor
    LOG_PREFIX
     
    static final long
    ONE_MB
     
    static final org.apache.nifi.components.PropertyDescriptor
    OUTPUT_FORMAT
     
    private static final org.apache.nifi.components.AllowableValue
    OUTPUT_FORMAT_LINE_PER_ATTRIBUTE
     
    private static final org.apache.nifi.components.AllowableValue
    OUTPUT_FORMAT_SINGLE_LINE
     
    private static final List<org.apache.nifi.components.PropertyDescriptor>
    PROPERTY_DESCRIPTORS
     
    static final org.apache.nifi.processor.Relationship
    REL_SUCCESS
     
    private static final Set<org.apache.nifi.processor.Relationship>
    RELATIONSHIPS
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    LogAttribute()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    private Set<String>
    getAttributesToLog(Set<String> flowFileAttrKeys, org.apache.nifi.processor.ProcessContext context)
     
    Set<org.apache.nifi.processor.Relationship>
    getRelationships()
     
    protected List<org.apache.nifi.components.PropertyDescriptor>
    getSupportedPropertyDescriptors()
     
    void
    onTrigger(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.ProcessSession session)
     
    protected String
    processFlowFile(org.apache.nifi.logging.ComponentLog logger, LogAttribute.DebugLevels logLevel, org.apache.nifi.flowfile.FlowFile flowFile, org.apache.nifi.processor.ProcessSession session, org.apache.nifi.processor.ProcessContext context)
     
    private void
    transferChunk(org.apache.nifi.processor.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, init, 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 org.apache.nifi.components.AllowableValue OUTPUT_FORMAT_LINE_PER_ATTRIBUTE

    • OUTPUT_FORMAT_SINGLE_LINE

      private static final org.apache.nifi.components.AllowableValue OUTPUT_FORMAT_SINGLE_LINE

    • LOG_LEVEL

      public static final org.apache.nifi.components.PropertyDescriptor LOG_LEVEL

    • ATTRIBUTES_TO_LOG_CSV

      public static final org.apache.nifi.components.PropertyDescriptor ATTRIBUTES_TO_LOG_CSV

    • ATTRIBUTES_TO_LOG_REGEX

      public static final org.apache.nifi.components.PropertyDescriptor ATTRIBUTES_TO_LOG_REGEX

    • ATTRIBUTES_TO_IGNORE_CSV

      public static final org.apache.nifi.components.PropertyDescriptor ATTRIBUTES_TO_IGNORE_CSV

    • ATTRIBUTES_TO_IGNORE_REGEX

      public static final org.apache.nifi.components.PropertyDescriptor ATTRIBUTES_TO_IGNORE_REGEX

    • OUTPUT_FORMAT

      public static final org.apache.nifi.components.PropertyDescriptor OUTPUT_FORMAT

    • LOG_PAYLOAD

      public static final org.apache.nifi.components.PropertyDescriptor LOG_PAYLOAD

    • LOG_FLOWFILE_PROPERTIES

      static final org.apache.nifi.components.PropertyDescriptor LOG_FLOWFILE_PROPERTIES

    • LOG_PREFIX

      public static final org.apache.nifi.components.PropertyDescriptor LOG_PREFIX

    • CHARSET

      public static final org.apache.nifi.components.PropertyDescriptor CHARSET

    • PROPERTY_DESCRIPTORS

      private static final List<org.apache.nifi.components.PropertyDescriptor> PROPERTY_DESCRIPTORS

    • FIFTY_DASHES

      public static final String FIFTY_DASHES
      See Also:

    • ONE_MB

      public static final long ONE_MB
      See Also:

    • REL_SUCCESS

      public static final org.apache.nifi.processor.Relationship REL_SUCCESS

    • RELATIONSHIPS

      private static final Set<org.apache.nifi.processor.Relationship> RELATIONSHIPS

  • Constructor Details

    • LogAttribute

      public LogAttribute()

  • Method Details

    • getRelationships

      public Set<org.apache.nifi.processor.Relationship> getRelationships()
      Specified by:
      getRelationships in interface org.apache.nifi.processor.Processor
      Overrides:
      getRelationships in class org.apache.nifi.processor.AbstractSessionFactoryProcessor

    • getSupportedPropertyDescriptors

      protected List<org.apache.nifi.components.PropertyDescriptor> getSupportedPropertyDescriptors()
      Overrides:
      getSupportedPropertyDescriptors in class org.apache.nifi.components.AbstractConfigurableComponent

    • processFlowFile

      protected String processFlowFile(org.apache.nifi.logging.ComponentLog logger, LogAttribute.DebugLevels logLevel, org.apache.nifi.flowfile.FlowFile flowFile, org.apache.nifi.processor.ProcessSession session, org.apache.nifi.processor.ProcessContext context)

    • getAttributesToLog

      private Set<String> getAttributesToLog(Set<String> flowFileAttrKeys, org.apache.nifi.processor.ProcessContext context)

    • transferChunk

      private void transferChunk(org.apache.nifi.processor.ProcessSession session)

    • onTrigger

      public void onTrigger(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.ProcessSession session)
      Specified by:
      onTrigger in class org.apache.nifi.processor.AbstractProcessor