logstash-input-signalsciences 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adc669a1475396aeeb25ca851e61b8c69914ad72
-  data.tar.gz: e7cbaf103b9ae261b76cdc3e8488041bf85ee654
+  metadata.gz: 7677c8fd764c77486906ebebb98b7d95a5d5d557
+  data.tar.gz: dc4601ef183dde9d4b8d4014d6cd0a06732b6b09
 SHA512:
-  metadata.gz: 7b20bcccc6b23113c25b87e8a0d6274fc5c3c855c69c2b708e90cfe18534896686a77b66f3975125367e793d91e9be01521dc9706fcea6aacfd6c6c7338cd1b9
-  data.tar.gz: 4f93b2eac90ce4fa3a3fe447d9ce3b6eaf4d2bc0330da3e500b3b8609b41fe8020a86ccad1b5a1ac84d157aff00f149a0403c53ed410d70f3557001560638750
+  metadata.gz: 20b7b7971d2f708fbfa0f866f80851770eba97c77e00176135ea4f1b2de098d598d587b3254cc4ed93ac2076aa37f26575c819d8176e3360c0623e9305774101
+  data.tar.gz: 7fccc04bca6c78d89918f8b16c1fb456c0c5d66ecc9ee1d5e993d301e1e892a991d815ef64537c9306fb92c3ad96cfb5c98eb3b2546607ab534066b5df32d714

data/CHANGELOG.md

@@ -1,2 +1,5 @@
+## 0.1.1
+  - Fixed references to vulnerable dependencieas in Gemfile.lock
+
 ## 0.1.0
   - Plugin created with the logstash plugin generator

data/INSTRUCTIONS.md

@@ -0,0 +1,70 @@
+# Instructions
+
+This document aims to provide more detail on how to implement the logstash-input-signalsciences plugin.
+
+## Installation
+
+There are two methods of installing this plugin.
+
+1. The plugin is published on rubygems.org (https://rubygems.org/gems/logstash-input-signalsciences) so it can be easily installed via Logstash by using the following command:
+
+`logstash-plugin install logstash-input-signalciences`
+
+2. You can build and install the gem file locally by using the `Makefile` on your system. However, you will need to ensure Ruby requirements for building gem files are met. Use the following commands:
+
+`make build`
+
+This command will build and install the gem file. You will need to ensure the `logstash-plugin` command is in your PATH.
+
+## Configuration
+
+Refer to the example configuration file [here](logstash-input-signalsciences.conf). The example file contains comments to explain each configuration option. This file assumes you will import the data into Elasticsearch using the logstash-output-elasticsearch plugin. However, you can certainly use any output plugin you like.
+
+## Quick Start - Running the ELK stack locally
+
+This section is optional. If you want to run a local ELK stack to run or test this plugin with, below are 
+basic instructions for installing ELK on Mac OS. These instructions use Homebrew to install all packages.
+You can find lots of ELK documentation online, this section is just intended to be a helpful quick overivew/guide.
+you can also refer to Elasticsearch's getting started page: https://www.elastic.co/start
+
+1. The first requirement is Java 8, run:
+
+```
+brew update
+brew tap caskroom/versions
+brew cask install java8
+```
+
+Reference https://stackoverflow.com/questions/24342886/how-to-install-java-8-on-mac
+
+2. Next install Elasticsearch, Logstash, and Kibana, run:
+
+```
+brew install elasticsearch
+brew install logstash
+brew install kibana
+```
+
+With brew you can start/stop these services by running:
+
+```
+brew services start elasticsearch
+brew services start logstash
+brew services start kibana
+
+brew services stop elasticsearch
+brew services stop logstash
+brew services stop kibana
+```
+
+## Quick Start - Developing logstash plugins
+
+This section references to help you get started with logstash plugin development.
+
+1. The article [So, You Want to Make a Logstash Plugin...](https://dzone.com/articles/so-you-want-to-make-a-logstash-plugin) is a great first step. It outlines installing Ruby requirements and setting up the Ruby environment. With this setup you can start developing on the logstash-input-signalsciences plugin, or any other plugin.
+
+If you want to create a new plugin, see:
+
+1. Plugin generator https://www.elastic.co/guide/en/logstash/current/plugins-inputs-generator.html, usage: https://github.com/elastic/logstash/blob/master/docs/static/plugin-generator.asciidoc
+
+2. Submitting your plugin to [RubyGems.org and the Logstash-plugin repository] (https://www.elastic.co/guide/en/logstash/current/submitting-plugin.html).

data/README.md

@@ -1,4 +1,4 @@
-# Logstash Plugin
+# Logstash Input Plugin for Signal Sciences
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

data/lib/logstash/inputs/signalsciences.rb

@@ -26,6 +26,7 @@ class LogStash::Inputs::Signalsciences < LogStash::Inputs::Base
   # Number of seconds in the past to filter data on
   # This value will also be used to set the interval at which the API is polled.
   config :from, :validate => :number, :default => 600
+  # Debug for plugin development.
   config :debug, :validate => :boolean, :default => false
 
   # Set how frequently messages should be sent.

data/logstash-input-signalsciences.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-input-signalsciences'
-  s.version       = '0.1.0'
+  s.version       = '0.1.1'
   s.licenses      = ['Apache-2.0']
   s.summary       = 'Logstash input plugin for Signal Sciences.'
   s.description   = 'Logstash input plugin for the Signal Sciences request feed endpoint https://docs.signalsciences.net/api/#get-request-feed'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-signalsciences
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - foospidy
@@ -72,8 +72,8 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - CONTRIBUTORS
-- DEVELOPER.md
 - Gemfile
+- INSTRUCTIONS.md
 - LICENSE
 - README.md
 - lib/logstash/inputs/signalsciences.rb

data/DEVELOPER.md

@@ -1,2 +0,0 @@
-# logstash-input-signalsciences
-Example input plugin. This should help bootstrap your effort to write your own input plugin!