NiFi Ingest 25.1
NiFi Ingest

# IdolLoggingServiceImpl

Provides a way to configure logging for all of your NiFi Ingest components.

Using this controller service provides an alternative to setting properties in the `nifi.properties` configuration file, as described in Configure Logging. Any properties that you set in `nifi.properties` are used as default values and are overridden by the controller service.

NOTE: You cannot enable more than one `IdolLoggingServiceImpl`. Stopping the `IdolLoggingServiceImpl` does not prevent components from writing to the logs. NiFi Ingest continues to use the last settings you saved, until an `IdolLoggingServiceImpl` is enabled with different settings.

## Properties

Name | Default Value | Description
--- | --- | ---
Enabled | true | If you set this property to `FALSE`, all of the remaining properties are ignored and the settings in `conf/logback.xml` are used instead.
Use component directory | false | A Boolean value that specifies whether to write log files to component directories: `./idol_repository/[component_id]/logs` ... rather than the default directory: `./logs/idol` Using the default location puts all log files in a single directory. Using the component directory means that log files for a component are deleted if the component is removed.
Level | INFO | The type of messages to log. You can choose from the following values (from least to most verbose): `OFF` `ERROR` - Errors only. `WARN` - Errors and warnings. `INFO` - Errors, warnings, and additional information. `DEBUG` - Not recommended for production systems because this amount of logging can reduce performance. `TRACE` `ALL`
Maximum history | 10 | The maximum number of log files to keep for each component.
Maximum file size | 10mb | The maximum size of an individual log file; when exceeded the file is renamed with a datestamp and file index.
Maximum total file size | 100mb | The maximum size of all log files for a single component; the oldest file is deleted if this limit is exceeded.
Enable status messages | false | Output messages related to the logging framework itself. This property can be used when troubleshooting problems related to logging.
Maximum recent messages | 1000 | The maximum number of messages to cache. This limits the number of messages that are displayed in the NiFi user interface.
Dynamic properties |  | You can override properties for NiFi Ingest components of a certain type. For example, to specify different options for all `GetFileSystem` processors you could add dynamic properties with the following names:
    GetFileSystem:useComponentDir
    GetFileSystem:level
    GetFileSystem:maxHistory
    GetFileSystem:maxSize
    GetFileSystem:maxTotalSize
You can override properties for individual NiFi Ingest components by using the component ID. For example, to specify different options for a single processor you could add dynamic properties with the following names:
    b0601e0e-94c5-443d-8f43-c6a4c7894720:useComponentDir
    b0601e0e-94c5-443d-8f43-c6a4c7894720:level
    b0601e0e-94c5-443d-8f43-c6a4c7894720:maxHistory
    b0601e0e-94c5-443d-8f43-c6a4c7894720:maxSize
    b0601e0e-94c5-443d-8f43-c6a4c7894720:maxTotalSize

Copyright 2018-2024 Open Text
Version 25.1 | Last updated January 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery NiFi Ingest 25.1

Topic Title: IdolLoggingServiceImpl