NiFi用户指南文档分析（2）

NiFi文档分析

组件版本

您可以访问有关处理器，控制器服务和报告任务的版本的信息。当您在具有运行不同版本组件的多个NiFi实例的集群环境中工作或者已升级到较新版本的处理器时，此功能尤其有用。“添加处理器”，“添加控制器服务”和“添加报告任务”对话框包括一个标识组件版本的列，以及组件的名称，创建组件的组织或组以及包含该组件的NAR包。
画布上显示的每个组件也包含此信息。

排序和过滤组件

添加组件时，可以根据原始源对版本号或过滤器进行排序。

要基于版本进行排序，请单击版本列以按升序或降序版本顺序显示。

要基于源组进行过滤，请单击“添加组件”对话框左上角的源下拉列表，然后选择要查看的组。

更改组件版本

要更改组件版本，请执行以下步骤。

1. 右键单击画布上的组件以显示配置选项。
2. 选择更改版本。
3. 在“组件版本”对话框中，从“版本”下拉菜单中选择要运行的版本。

了解版本依赖关系

配置组件时，还可以查看有关版本依赖性的信息。
1.右键单击组件，然后选择“配置”以显示组件的“配置”对话框。
2.单击“属性”选项卡。
3.单击信息图标以查看任何版本依赖关系信息。

如果MyProcessor的版本更改为不兼容的版本（MyProcessor 2.0），则验证错误将显示在处理器上：并且由于服务不再有效，因此处理器的控制器服务配置中将显示错误消息：

配置处理器

要配置处理器，请右键单击处理器，然后Configure从上下文菜单中选择该选项。或者，只需双击处理器即可。打开配置对话框，其中包含四个不同的选项卡，每个选项卡将在下面讨论。完成处理器配置后，可以通过单击Apply按钮应用更改，或单击按钮取消所有更改Cancel。
注意，处理器启动后，为处理器显示的上下文菜单不再有Configure 选项，而是有一个View Configuration选项。处理器运行时无法更改处理器配置。您必须先停止处理器并等待其所有活动任务完成，然后再次配置处理器。
不支持输入某些控制字符，并在输入时自动过滤掉。任何配置中都不会保留以下字符和任何未配对的Unicode代理点代码点:
[＃x0]，[＃x1]，[＃x2]，[＃x3]，[＃x4]，[＃x5]，[＃x6]，[＃x7]，[＃x8]，[＃xB]， [#xC]，[＃xE]，[＃XP]，[＃x10]，[＃x11]，[＃x12]，[＃x13]，[＃x14]，[＃x15]，[＃x16]， [＃x17]，[＃x18]，[＃x19]，[＃x1A]，[＃x1B]，[＃x1C]，[＃x1D]，[＃x1E]，[＃x1F]，[#xFFFE]， [#xFFFF]

设置标签

处理器配置对话框中的第一个选项卡是“设置”选项卡：

此选项卡包含几个不同的配置项。
首先，它允许DFM更改处理器的名称。默认情况下，处理器的名称与处理器类型相同。处理器名称旁边是一个复选框，指示处理器是否已启用。将处理器添加到画布后，将启用它。如果禁用处理器，则无法启动。禁用状态用于指示当启动一组处理器时，例如当DFM启动整个进程组时，应排除此（禁用）处理器。
接下来是两个用于配置“惩罚持续时间”和“产量持续时间”的对话框。在处理一条数据（FlowFile）的正常过程中，可能发生事件，该事件指示此时不能处理数据但是数据可以在稍后的时间处理。发生这种情况时，处理器可以选择Penalize FlowFile。这将阻止FlowFile在一段时间内被处理.
类似地，处理器可以确定存在某种情况，使得处理器不再能够进行任何进展，而不管其正在处理的数据。例如，如果处理器要将数据推送到远程服务并且该服务没有响应，则处理器无法取得任何进展。
“设置”选项卡左侧的最后一个可配置选项是“公告”级别。每当处理器写入其日志时，处理器也将生成公告。此设置指示应在用户界面中显示的最低级别的公告。默认情况下，公告级别设置为WARN，这意味着它将显示所有警告和错误级别公告。
设置”选项卡的右侧包含“自动终止关系”部分。此处列出了处理器定义的每个关系及其描述。为了使处理器被视为有效且能够运行，处理器定义的每个关系必须连接到下游组件或自动终止。如果关系是自动终止的，则将从流中删除任何路由到该关系的FlowFile，并将其处理视为完成。已连接到下游组件的任何关系都无法自动终止。必须首先从使用它的任何Connection中删除关系。

调度选项卡

“处理器配置”对话框中的第二个选项卡是“计划”选项卡：

调度策略

第一个配置选项是调度策略。调度组件有三种可能的选项：
定时器驱动：这是默认模式。处理器将安排定期运行。运行处理器的时间间隔由“运行时间表”选项定义（见下文）。

事件驱动：选择此模式时，将触发处理器以由事件运行，并且当FlowFiles进入连接此处理器的Connections时，将发生该事件。此模式目前被认为是实验性的，并非所有处理器都支持。选择此模式时，“运行计划”选项不可配置，因为处理器未被触发定期运行，而是作为事件的结果。此外，这是“并发任务”选项可以设置为0的唯一模式。在这种情况下，线程数仅受管理员配置的事件驱动线程池的大小限制。

CRON驱动：当使用CRON驱动的调度模式时，处理器被安排定期运行，类似于定时器驱动的调度模式。然而，CRON驱动模式以增加配置的复杂性为代价提供了显着更大的灵活性。CRON驱动的调度值是由六个必需字段和一个可选字段组成的字符串，每个字段由空格分隔。这些字段是：

领域	有效值
秒	0-59
分钟	0-59
小时	0-23
一个月的一天	1-31
月	1-12或JAN-DEC
星期几	1-7或SUN-SAT
年（可选）	空，1970-2099

您通常通过以下方式之一指定值：

• 数字：指定一个或多个有效值。您可以使用逗号分隔列表输入多个值。
• 范围：使用 - 语法指定范围。
• 增量：使用 / 语法指定增量。例如，在“分钟”字段中，0/15表示分钟0,15,30和45。

您还应该知道几个有效的特殊字符：

• * - 表示所有值对该字段都有效。
• ？ - 表示未指定特定值。此特殊字符在“星期几”和“星期几”字段中有效。
• L - 您可以将L附加到星期值之一，以指定该月中该日的最后一次出现。例如，1L表示该月的最后一个星期日。

运行计划

“运行计划”指示应该安排处理器运行的频率。此字段的有效值取决于所选的调度策略（参见上文）。如果使用事件驱动的调度策略，则此字段不可用。使用定时器驱动的调度策略时，该值是由数字后跟时间单位指定的持续时间。例如，1 second或5 mins。默认值0 sec表示处理器应尽可能频繁地运行，只要它有要处理的数据即可。这适用于0任何持续时间，而不管时间单位（即，0 sec，0 mins，0 days）。

执行

执行设置用于确定处理器将被调度执行的节点。选择“所有节点”将导致在集群中的每个节点上调度此处理器。选择“主节点”将导致此处理器仅在主节点上进行调度。已为“主节点”执行配置的处理器由处理器图标旁边的“P”标识：

要快速识别“主节点”处理器，“P”图标也会显示在“摘要”页面的“处理器”选项卡中：

运行持续时间

“调度”选项卡的右侧包含一个用于选择“运行持续时间”的滑块。这可以控制处理器每次触发时应安排运行的时间。在滑块的左侧，标记为“较低延迟”，而右侧标记为“较高吞吐量”。处理器完成运行后，必须更新存储库才能将FlowFiles传输到下一个Connection。更新存储库的成本很高，因此在更新存储库之前可以立即完成的工作量越多，处理器可以处理的工作量就越多（吞吐量越高）。但是，这意味着在上一个Process更新此存储库之前，下一个Processor无法开始处理这些FlowFiles。结果是，延迟时间会更长（从开始到结束处理FlowFile所需的时间会更长）。因此，滑块提供了一个频谱，DFM可以从中选择支持较低延迟或较高吞吐量。

属性选项卡

Properties选项卡提供了一种配置特定于Processor的行为的机制。没有默认属性。每种类型的处理器必须定义哪些属性对其用例有意义。下面，我们看到RouteOnAttribute Processor的Properties选项卡：
默认情况下，此处理器只有一个属性：“路由策略”。默认值为“路由到属性名称”.单击属性的值将允许DFM更改该值。根据属性允许的值，向用户提供从中选择值的下拉列表，或者为用户提供键入值的文本区域：

选项卡的右上角是一个用于添加新属性的按钮。单击此按钮将为DFM提供一个对话框，用于输入新属性的名称和值。并非所有处理器都允许用户定义的属性。在不允许它们的处理器中，处理器在应用用户定义属性时变为无效。但是，RouteOnAttribute允许用户定义的属性。实际上，在用户添加属性之前，此处理器无效。

评论标签

处理器配置对话框中的最后一个选项卡是“注释”选项卡。此选项卡仅为用户提供一个区域，以包含适用于此组件的任何注释。使用“注释”选项卡是可选的：

使用表达式语言的自定义属性

您可以使用NiFi表达式语言来引用FlowFile属性，将它们与其他值进行比较，并在创建和配置数据流时操纵它们的值。
除了在Express Language中使用FlowFile属性，系统属性和环境属性之外，您还可以定义表达式语言使用的自定义属性。定义自定义属性可以更灵活地处理和处理数据流。您还可以为连接，服务器和服务属性创建自定义属性，以便更轻松地配置数据流。

NiFi属性具有在创建自定义属性时应注意的分辨率优先级：

特定于处理器的属性

FlowFile属性

FlowFile属性

从变量注册表：

用户定义的属性（自定义属性）

系统属性

操作系统环境变量

在创建自定义属性时，请确保每个自定义属性包含不同的属性值，以便现有环境属性，系统属性或FlowFile属性不会覆盖它。

有两种方法可以使用和管理自定义属性：

在NiFi UI中通过Variables窗口

通过nifi.properties引用自定义属性

变量窗口

可以在NiFi UI中创建和配置变量。变量可用于支持表达式语言的任何字段。NiFi自动获取在UI中创建的新变量或修改变量。

要访问“变量”窗口，请右键单击未选中任何内容的画布：
从上下文菜单中选择“变量”：
选择进程组时，右键单击“上下文菜单”中也可以使用“变量”：

创建变量

在“变量”窗口中，单击+按钮以创建新变量。添加名称：
和一个值：
选择“应用”：
执行更新变量的步骤（识别受影响的组件，停止受影响的处理器等）。例如，Referencing Processors部分现在列出了“PutFile-Root”处理器。在列表中选择处理器的名称将导航到画布上的该处理器。查看处理器的属性，${putfile_dir}由Directory属性引用：

可变范围

变量的作用域由它们定义的进程组确定，并且可供该级别及以下定义的任何处理器使用（即任何后代处理器）。

后代组中的变量会覆盖父组中的值。更具体地说，如果变量x在根组中声明并且也在进程组内声明，则进程组内的组件将使用进程组中x定义的值。
例如，除了putfile_dir根进程组中存在的变量之外，假设putfile_dir在进程组A中创建了另一个变量。如果进程组A中的一个组件引用putfile_dir，则将列出这两个变量，但是putfile_dir根组中的变量将是有一个删除线表明被覆盖：只能为其创建的进程组修改变量，该变量列在“变量”窗口的顶部。要修改在不同进程组中定义的变量，请选择该变量行中的“箭头”图标：例如，除了putfile_dir根进程组中存在的变量之外，假设putfile_dir在进程组A中创建了另一个变量。如果进程组A中的一个组件引用putfile_dir，则将列出这两个变量，但是putfile_dir根组中的变量将是有一个删除线表明被覆盖：只能为其创建的进程组修改变量，该变量列在“变量”窗口的顶部。要修改在不同进程组中定义的变量，请选择该变量行中的“箭头”图标：这将导航到该进程组的Variables窗口：

变量权限

变量权限仅基于相应进程组上配置的权限。

例如，如果用户无权查看进程组，则无法查看该进程组的“变量”窗口：
选择控制器服务的名称将导航到“配置”窗口中的该控制器服务：

未经授权的引用组件

如果未向引用变量的组件提供“查看”或“修改”权限，则组件的UUID将显示在“变量”窗口中：

在上面的示例中，变量property1由“user1”无法查看的处理器引用：

通过nifi.properties引用自定义属性

识别一组或多组键/值对，并将它们提供给系统管理员。

添加新的自定义属性后，请确保使用自定义属性位置更新nifi.properties文件中的nifi.variable.registry.properties 字段。
【注】必须重新启动NiFi才能获取这些更新。

控制器服务

Controller Services是共享服务，可供报告任务，处理器和其他服务使用，以用于配置或任务执行。

为报告任务添加控制器服务

要为报告任务添加控制器服务，请从全局菜单中选择控制器设置。

这将显示“NiFi设置”窗口。该窗口有四个选项卡：常规，报告任务控制器服务，报告任务和注册表客户端。“常规”选项卡提供实例的总体最大线程数的设置。“常规”选项卡右侧是“报告任务控制器服务”选项卡。在此选项卡中，DFM可以单击右上角的+按钮以创建新的Controller Service。
“添加控制器服务”窗口打开。此窗口类似于“添加处理器”窗口。它提供了右侧可用的Controller Services列表和标签云，显示了左侧用于Controller Services的最常见类别标签。DFM可以单击标签云中的任何标签，以便将Controller Services列表缩小到适合所需类别的那些。DFM还可以使用窗口右上角的“过滤器”字段来搜索所需的“控制器服务”，或使用左上角的“源”下拉列表按创建它们的组筛选列表。从列表中选择Controller Service后，DFM可以在下面看到该服务的描述。选择所需的控制器服务，然后单击“添加”，或者只需双击要添加的服务名称即可。
添加控制器服务后，可以通过单击Configure最右侧列中的按钮进行配置。此列中的其他按钮包括Enable，Remove和Access Policies。
您可以通过单击左侧列中的Usage和Alerts按钮来获取有关Controller Services的信息。当DFM单击该Configure按钮时，将打开“配置控制器服务”窗口。它有三个选项卡：设置，属性和注释。此窗口类似于“配置处理器”窗口。“设置”选项卡为DFM提供了一个位置，以便为Controller Service提供唯一的名称（如果需要）。它还列出了服务的UUID，类型，捆绑和支持信息，并提供了引用该服务的其他组件（报告任务或其他控制器服务）的列表。“属性”选项卡列出了适用于特定控制器服务的各种属性。与配置处理器一样，DFM可以将鼠标悬停在问号图标上以查看有关每个属性的更多信息。“注释”选项卡只是一个开放文本字段，其中DFM可能包含有关服务的注释。配置Controller Service后，单击Apply按钮以应用配置并关闭窗口，或单击Cancel按钮取消更改并关闭窗口。

为数据流添加控制器服务

要为数据流添加控制器服务，可以右键单击“进程组”并选择“配置”，或单击“操作选项板”中的“配置”。
在画布上单击“操作选项板”中的“配置”时，如果未在画布上选择任何内容，则为根进程组添加控制器服务。然后，该控制器服务可用于数据流中的所有嵌套进程组。在画布上选择“进程组”，然后从“操作选项板”或“进程组”上下文菜单中单击“配置”时，该服务将可用于该进程组及以下中定义的所有处理器和控制器服务。使用以下步骤添加Controller服务：

1. 单击“配置”，可以从“操作选项板”或“进程组”上下文菜单中单击“配置”。这将显示进程组“配置”窗口。该窗口有两个选项卡：常规和控制器服务。“常规”选项卡用于与有关进程组的常规信息有关的设置。例如，如果配置根进程组，DFM可以为整个数据流提供唯一的名称，以及描述该流的注释（注意：此信息对于远程连接到此实例的任何其他NiFi实例是可见的（使用远程进程组，又名，站点到站点））。
2. 从Process Group Configuration页面中，选择Controller Services选项卡。
3. 单击+按钮以显示“添加控制器服务”对话框。
4. 选择所需的Controller Service，然后单击“添加”。
5. 单击配置右侧列中的配置图标（），执行任何必要的Controller Service配置任务。

启用/禁用控制器服务

配置Controller Service后，必须启用它才能运行。使用“ 控制器服务”选项卡的最右侧列中的Enable按钮（启用按钮）执行此操作。为了修改现有/正在运行的控制器服务，DFM需要停止/禁用它（以及所有引用报告任务和控制器服务）。使用Disable按钮（禁用按钮）执行此操作。DFM可以在禁用相关控制器服务时停止/禁用它们，而不必搜寻该控制器服务引用的每个组件。启用控制器服务时，DFM可以选择启动/启用控制器服务和所有引用组件，也可以仅启动/启用控制器服务本身。

报告任务

报告任务在后台运行，以提供有关NiFi实例中发生情况的统计报告。DFM添加和配置报告任务，类似于Controller Services的过程。要添加报告任务，请从全局菜单中选择控制器设置。这将显示“NiFi设置”窗口。选择“报告任务”选项卡，然后单击右上角的+按钮以创建新的“报告任务”。将打开“添加报告任务”窗口。此窗口类似于“添加处理器”窗口。它提供了右侧可用报告任务的列表和标签云，显示了左侧用于报告任务的最常见类别标签。DFM可以单击标签云中的任何标签，以便将报告任务列表缩小到适合所需类别的那些。DFM还可以使用窗口右上角的“过滤器”字段来搜索所需的“报告任务”，或使用左上角的“源”下拉列表按创建它们的组筛选列表。从列表中选择报告任务后，DFM可以在下面看到该任务的描述。选择所需的报告任务，然后单击“添加”，或者只需双击要添加的服务名称即可。

添加报告任务后，DFM可以通过单击Edit最右侧列中的按钮对其进行配置。在此列中的其他按钮包括Start，Remove，State和Access Policies。您可以获取有关通过点击报告任务信息View Details，Usage以及Alerts在左侧栏中的按钮。当DFM单击该Edit按钮时，将打开“配置报告任务”窗口。它有三个选项卡：设置，属性和注释。此窗口类似于“配置处理器”窗口。“设置”选项卡为DFM提供了一个位置，以便为报告任务提供唯一的名称（如果需要）。它还列出了任务的UUID，Type和Bundle信息，并提供了任务的Scheduling Strategy和Run Schedule的设置（类似于处理器中的相同设置）。DFM可以将鼠标悬停在问号图标上以查看有关每个设置的更多信息。“属性”选项卡列出了可为任务配置的各种属性。DFM可以将鼠标悬停在问号图标上以查看有关每个属性的更多信息。
“注释”选项卡只是一个开放文本字段，其中DFM可能包含有关任务的注释。配置报告任务后，单击Apply按钮以应用配置并关闭窗口，或单击Cancel按钮取消更改并关闭窗口。

如果要运行“报告任务”，请单击Start按钮（开始按钮）。