Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Introduction

The Splunk plugins 

Use case(s)

User Storie(s)

  • As a pipeline developer, I would like to write relevant and filtered data to Splunk for log analysis
  • As a pipeline developer I would like to sent 
  • The destination sends HTTP POST requests to the HEC endpoint using the JSON data format. The destination generates one HTTP request for each batch, sending multiple records at a time. Each record must contain the event data and optionally the event metadata in the format required by Splunk.

Plugin Type

  • Batch Source
  • Batch Sink 
  • Real-time Source
  • Real-time Sink
  • Action
  • Post-Run Action
  • Aggregate
  • Join
  • Spark Model
  • Spark Compute

Configurables

This integration should be built using two plugins:

Zendesk single object

Used when you want to pull only a single object from Zendesk

User Facing NameTypeDescriptionOptionalConstraints
Admin emailtextshould validate email.No
API tokentextCan be obtained from from the Zendesk Support Admin interface. Check out Zendesk's documentation for API Token generationNo
Objects to pullselectSelect an object to pull from Zendesk. Comments, Groups, Organizations, Satisfaction Ratings, Tags, Ticket Events, Ticket Fields, Ticket Metrics, Ticket Metrics Events, Tickets, UsersNoDefaults to all.

Zendesk multi-object

Used when you want to pull only a single object from Zendesk

User Facing NameTypeDescriptionOptionalConstraints
Admin emailtextshould validate email.No
API tokentextCan be obtained from from the Zendesk Support Admin interface. Check out Zendesk's documentation for API Token generationNo
Objects to pullmulti-selectSelect a list of objects to pull from Zendesk. Comments, Groups, Organizations, Satisfaction Ratings, Tags, Ticket Events, Ticket Fields, Ticket Metrics, Ticket Metrics Events, Tickets, UsersYesDefaults to all.
Objects to skipmulti-selectSelect a list of objects to skip from Zendesk. All other objects will be pulled.YesOnly used when Objects to pull is not specified

The plugin should output one record per row in Zendesk, with an additional field specifying the object where the record came from. Refer to the Salesforce multi-objects plugin for examples

Design / Implementation Tips

  • Tip #1
  • Tip #2

Design

Approach(s)

Properties

Security

Limitation(s)

Future Work

  • Some future work – HYDRATOR-99999
  • Another future work – HYDRATOR-99999

Test Case(s)

  • Test case #1
  • Test case #2

Sample Pipeline

Please attach one or more sample pipeline(s) and associated data. 

Pipeline #1

Pipeline #2



Table of Contents

Checklist

  • User stories documented 
  • User stories reviewed 
  • Design documented 
  • Design reviewed 
  • Feature merged 
  • Examples and guides 
  • Integration tests 
  • Documentation for feature 
  • Short video demonstrating the feature
  • No labels