Otis, We've disabled the automatic generation of the REST API documentation do to license concerns of the generated output. If you've built NiFi from source, you could enable it using the maven profile 'docs'. We have an open ticket to address this [1]. If the application is built with the REST API documentation it can be accessed in the Help section within the NiFi instance your running. After clicking the help link, the Developer section is located on the bottom of the side navigation.
I realize this isn't great. The next best thing I could suggest is opening your browser's Developer Tools to watch the requests in the Summary page. This is where we show metrics for the data flow and various system diagnostics. [1] https://issues.apache.org/jira/browse/NIFI-292 On Wed, Feb 18, 2015 at 1:25 AM, Otis Gospodnetic < [email protected]> wrote: > Hi Joe, > > Kafka devs describe their MBeans here - > https://kafka.apache.org/08/ops.html > - section 6.5, which is good for people who want to understand what each > metric means. > It sounds like the reporting task stuff is all about the push. I think > pull may be better for us, so if you can document the end point (I assume > we are talking about an HTTP/REST API? That returns various metrics in > JSON?), that would be very very helpful (and not just to us). > > Thanks, > Otis > -- > Monitoring * Alerting * Anomaly Detection * Centralized Log Management > Solr & Elasticsearch Support * http://sematext.com/ > > > On Wed, Feb 18, 2015 at 12:50 AM, Joe Witt <[email protected]> wrote: > > > Otis, > > > > We're quite light on documentation thus far for the Reporting Task > > API. But you can see a bit about it here: > > > > > > > http://nifi.incubator.apache.org/docs/nifi-docs/developer-guide.html#reporting-tasks > > > > > http://nifi.incubator.apache.org/docs/nifi-docs/developer-guide.html#developing-a-reporting-task > > > > The javadocs are published to Maven as well so that will do nicely to > > give a sense of what we expose from the Internals of NiFi to an > > implementation of a reporting task. > > > > But feel free to ask detailed questions and as many as you want. That > > will give us good information on the types of things we need to cover > > and in how much detail. > > > > Thanks > > Joe > > > > On Wed, Feb 18, 2015 at 12:46 AM, Otis Gospodnetic > > <[email protected]> wrote: > > > Hi Joe, > > > > > > On Wed, Feb 18, 2015 at 12:15 AM, Joe Witt <[email protected]> wrote: > > > > > >> Otis, > > >> > > >> Glad you are liking it. > > >> > > >> We do provide support for both push and pull based metrics > > >> reporting/gathering. > > >> > > >> For NiFi being able to push out metrics: > > >> We do have an API for what we call "Reporting Tasks". For example we > > >> have a Ganglia reporter today. > > >> > > > > > > So we are talking about the Yammer/Coda Hale's Metrics being used here? > > > If so, are the metrics also available via JMX, too? > > > > > > For a client being able to pull metrics from NiFI: > > >> The REST API is the way to go. > > >> > > > > > > This sounds good. Are this API and the metrics it exposes documented > > > anywhere? > > > I looked in the guides, but couldn't find anything. > > > > > > > > >> Do either of these sound like a path that can work for you? Let us > > >> know if you'd like more details. > > >> > > > > > > Thanks, > > > Otis > > > -- > > > Monitoring * Alerting * Anomaly Detection * Centralized Log Management > > > Solr & Elasticsearch Support * http://sematext.com/ > > > > > > > > > > > > > > >> > > >> On Wed, Feb 18, 2015 at 12:01 AM, Otis Gospodnetic > > >> <[email protected]> wrote: > > >> > Hi, > > >> > > > >> > Nifi looks mightily impressive! > > >> > I see Nifi has built-in monitoring and metrics.... but is there an > API > > >> that > > >> > would allow something like SPM to add support for Nifi monitoring? > Or > > >> JMX? > > >> > > > >> > Thanks, > > >> > Otis > > >> > -- > > >> > Monitoring * Alerting * Anomaly Detection * Centralized Log > Management > > >> > Solr & Elasticsearch Support * http://sematext.com/ > > >> > > >
