如何为自定义处理器生成使用文档

时间:2019-08-16 19:59:26

标签: apache-nifi

我创建了几个自定义NiFi处理器,但是无法获取使用文档。 “使用情况”文档指的是在处理器上单击鼠标右键,然后选择“使用情况”,这将调出有关该特定处理器的文档。显示文档面板,但没有我的自定义处理器。

我在自定义处理器类上使用了几个NiFi文档标签,包括几个“读/写”属性。该代码编译和单元测试没有任何问题。生成报告

  

[INFO]正在为NAR中的NiFi扩展生成文档...

根据开发者guide文档,应该自动生成。

我还尝试创建一个update_products.sql文件,并根据文档将其放在nar中。

  

此文件应存在于名称为Processor的全限定名称的目录中,并且该目录的父目录应命名为docs并位于Processor jar的根目录中。

但是,它破坏了NiFi,我在日志中找到了它。

additionalDetails.html

我正在使用标准的 === End Processor types === 2019-08-16 15:16:36,100 WARN [main] org.apache.nifi.web.server.JettyServer Failed to start web server... shutting down. java.lang.NullPointerException: null at org.apache.nifi.documentation.DocGenerator.generate(DocGenerator.java:62) at org.apache.nifi.web.server.JettyServer.start(JettyServer.java:932) at org.apache.nifi.NiFi.<init>(NiFi.java:158) at org.apache.nifi.NiFi.<init>(NiFi.java:72) at org.apache.nifi.NiFi.main(NiFi.java:297) 2019-08-16 15:16:36,100 INFO [Thread-1] org.apache.nifi.NiFi Initiating shutdown of Jetty web server... 来生成nar文件。 这是我的nifi-nar-maven-plugin文件的摘要。

pom.xml

生成的.nar(没有<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.myorg</groupId> <artifactId>nifi-mylib</artifactId> <packaging>nar</packaging> <version>0.0.3</version> <name>nifi-mylib</name> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> <nifi.version>1.9.2</nifi.version> </properties> <dependencies> <dependency> <groupId>org.apache.nifi</groupId> <artifactId>nifi-api</artifactId> <version>${nifi.version}</version> </dependency> ... </dependencies> <build> <plugins> <plugin> <groupId>org.apache.nifi</groupId> <artifactId>nifi-nar-maven-plugin</artifactId> <version>1.3.1</version> <extensions>true</extensions> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <version>2.15</version> </plugin> </plugins> </build> </project> 文件)将正确加载并显示在处理器列表中。只是我无法使用的使用情况文档。

1 个答案:

答案 0 :(得分:1)

我能够在NiFi电子邮件列表上获得一些帮助。

nar必须包含一个带有处理器的jar。这说明了如何设置Maven项目结构: https://cwiki.apache.org/confluence/display/NIFI/Maven+Projects+for+Extensions#MavenProjectsforExtensions-ExampleProcessorBundleStructure