Skip to content

de55/logstash-input-zendesk

 
 

Repository files navigation

Logstash Input Plugin for Zendesk

NOTE: We have since switched case systems and no longer have access to the Zendesk service. This plugin is no longer being maintained.

This input fetches data from Zendesk and generates Logstash events for indexing into Elasticsearch. It uses the official Zendesk ruby client api (https://github.com/zendesk/zendesk_api_client_rb).
Currently, the input supports organization, user, ticket, ticket comment and topic object types.
It assumes that the user specified has the appropriate Zendesk permissions to access the fetched objects. Don't forget to apply the index templates from the templates folder to Elasticsearch before running the plugin.

Just sharing what I have been using and I hope it helps other folks get started.

Disclaimer: This is my first Ruby program :)

 Sample configuration:

 [source,ruby]
 ----------------------------------
     input 
     { 
       zendesk
       {
         domain => "company.zendesk.com"
         # Specify either user and password or user and api_token for authentication
         user => "user@company.com"
         # password => "your_password"
         api_token => "your_api_token"
         organizations => true
         users => true
         tickets => true
         tickets_last_updated_n_days_ago => 1
         comments => false
         append_comments_to_tickets => false
         topics => false
         sleep_between_runs => 30
       }
     }

    output 
    {
    	elasticsearch
        {
          index => "zd_%{type}"
          document_type => "%{type}"
          document_id => "%{id}"
          manage_template => false
          template_name => "zd_%{type}"
        }
    }
 ----------------------------------

See comments in code for descriptions of the parameters above.

This is a plugin for Logstash.

To build, see Logstash documentation here. In short, clone the repository, build the gem, and install the gem using the Logstash plugin command.

It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.

About

A Logstash input plugin for Zendesk

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 100.0%