Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

API Response Tracking With StreamSets, Elasticsearch, and Kibana

DZone's Guide to

API Response Tracking With StreamSets, Elasticsearch, and Kibana

Learn how to track JSON response data from a RESTful API using Elasticsearch and Kibana to capture and visualize the alerts.

Free Resource

The Integration Zone is brought to you in partnership with Cloud Elements.  What’s below the surface of an API integration? Download The Definitive Guide to API Integrations to start building an API strategy.

Overview

RESTful API JSON response data can be used to view various aspects, such as pipeline configuration or monitoring information of the StreamSets Data Collector. This API response information can be used with Data Collector REST API and can be used to provide Data Collector details to a REST-based monitoring system.

In this blog, let us discuss capturing all alerts produced by StreamSets pipelines using RESTful API, loading alerts in Elasticsearch, and visualizing alerts in Kibana.

Pre-requisites

  • Install Java 1.8
  • Install streamsets-datacollector-2.6.0.1

Use Case

Create a data flow pipeline to capture the response of a RESTful API using StreamSets and load it in Elasticsearch.

Synopsis

  • View RESTful API response data
  • Capture RESTful API response
  • Load API response in Elasticsearch
  • Visualize pipeline alerts in Kibana

Viewing RESTful API Response Data

To view RESTful API response data, perform the following:

  • Log in to StreamSets.
  • On the top right corner, click Help icon.
  • Click RESTful API. Different categories such as ACL, definitions, manager, preview, store, and system can be viewed.

select

  • Click manager to view API required to get alerts triggered for all the pipelines.

  • Click try it out! to get the request URL.

select

  • Check the response in UI using the below URL: http://<sdc_host>:/rest/v1/pipelines/alerts

select

Capturing RESTful API Response

To capture RESTful API response, perform the following:

  • Configure HTTP Client Processor by setting Resource URL as “http://<sdc_host>:/rest/v1/pipelines/alerts”, Mode as “Polling”, and Polling Interval.

select

  • Capture RESTful API response using the HTTP client processor.
  • In Pagination tab, set Pagination Mode as “Link HTTP header” and Result Field Path as “/”.

select

Loading API Response in Elasticsearch

To load API Response in Elasticsearch, perform the following:

  • Configure “Elasticsearch” processor.
  • Set Cluster HTTP URI.
  • Use the below template for Elasticsearch:
{
 "template" : "streamsets*",
 "mappings": {
 "uri": {
 "properties": {
  "gauge": {
             "properties": { 
                      "value":{ 
                               "properties": { 
                                        "timestamp": { 
                                        "type":"date", 
                                                 "format":"yyyy-MM-dd HH:mm:ss.SSS||yyyy-MM-
dd'T'HH:mm:ss.SSS'Z'||yyyy-MM-dd||yyyy-MM-dd HH:mm:ss||mmm dd, yyyy HH:mm:ss 
a||epoch_millis" 
        } 
       } 
      } 
     } 
    } 
   } 
  } 
 } 
}

select

Visualizing Pipeline Alerts in Kibana

The alerts produced by all the pipelines can be viewed in Kibana without using StreamSets.

Number of Alerts vs Label as Attributeselectselect

Number of Alerts vs Timestampselect

Conclusion

StreamSets provides different RESTful APIs to get metrics, status, alerts, and so on. These APIs can be used with different visualization tools to visualize data and to monitor the pipelines externally.

References

The State of API Integration Report provides data from the Cloud Elements platform and will help all developers navigate the recent explosion of APIs and the implications of API integrations to work more efficiently in 2017 and beyond.

Topics:
streamsets ,api ,elasticsearch ,kibana ,rest api ,data pipeline ,integration

Published at DZone with permission of Rathnadevi Manivannan. See the original article here.

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}