This is a plugin for Logstash.
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.
The RETS input plugin can be configured very simply as shown below. Each rets input allows you to send as many queries as desired
against a single MLS RETS server.
The retrieved fields will be stored at the event root level by default (unless the target field is configured).
input {
rets {
url => "http://mls.server.com/Login"
username => "retsuser"
password => "retspwd"
user_agent => "you/1.0"
user_agent_password => "uapwd"
rets_version => "RETS/1.5"
# Supports "cron", "every", "at" and "in" schedules by rufus scheduler
schedule => { cron => "* * * * * UTC"}
# The target field in which the RETS fields will be stored
#target => "rets_fields"
# A hash of request metadata info (timing, response headers, etc.) will be sent here
metadata_target => "@rets_metadata"
queries => {
properties => {
resource => "Property"
class => "RE_1"
query => "(L_Status=|1_0,1_1,1_2)"
select => ""
limit => 1000
}
active_agents => {
resource => "Agent"
class => "Agent"
query => "(U_user_is_active=1)"
select => ""
limit => 1000
}
}
}
}
output {
stdout {
codec => rubydebug
}
}
Here is how a sample event will look like:
{
"L_ListingID" => "12345678",
"L_Class" => "1",
"L_Type_" => "7",
"L_Area" => "12",
"L_SystemPrice" => "165000",
"L_AskingPrice" => "165000",
"L_AddressNumber" => "1234",
"L_AddressSearchNumber" => "1234",
"L_AddressDirection" => "",
"L_AddressStreet" => "Main Street",
... => ...
"L_IdxInclude" => "0",
"L_LastDocUpdate" => "",
"@version" => "1",
"@timestamp" => "2016-09-05T09:13:03.545Z",
"@rets_metadata" => {
"host" => "iMac.local",
"runtime_seconds" => 3.504
"query_name" => "properties",
"query_spec" => {
"resource" => "Property",
"class" => "RE_1",
"query" => "(L_Status=|1_0)",
"limit" => 10
}
}
}
The following list enumerates all configuration parameters of the rets input:
url: the Login URL to the MLS RETS server (required)username: the username to log into the MLS RETS server (required)password: the password to log into the MLS RETS server (required)user_agent: the User-Agent to use when identifying to the MLS RETS server (required)user_agent_password: the User-Agent password to use when identifying to the MLS RETS server (optional)rets_version: the RETS version to use. Valid versions areRETS/1.5,RETS/1.7,RETS/1.7.2,RETS/1.8(required)schedule: the schedule specification determining when theretsinput must run (see below for details) (required)target: the name of the field into which to store the pulled RETS fields (default: root) (optional)metadata_target: the name of the field into which to store some metadata about the call (default:@metadata(optional)queries: Any number of named queries mapped to a hash with the following parameters: (at least one required)resource: the RETS resource to query (e.g.Property,Agent, etc)class: the RETS class to query (e.g.RE_1,LD_2,Agent, etc)query: the DMQL query to sendselect: a comma-separated list of fields to pull, leave empty to pull all fieldslimit: a number indicating how many records to pull at once
This plugin must also be scheduled to run periodically according to a specific schedule. This scheduling syntax is powered by rufus-scheduler. The syntax is cron-like with some extensions specific to Rufus (e.g. timezone support ).
Examples:
* 5 * 1-3 * | will execute every minute of 5am every day of January through March.
0 * * * * | will execute on the 0th minute of every hour every day.
0 6 * * * America/Chicago | will execute at 6:00am (UTC/GMT -5) every day.
Further documentation describing this syntax can be found here.
Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
-
To get started, you'll need JRuby with the Bundler gem installed.
-
Create a new plugin or clone and existing from the GitHub logstash-plugins organization. We also provide example plugins.
-
Install dependencies
bundle install- Update your dependencies
bundle install- Run tests
bundle exec rspec- Edit Logstash
Gemfileand add the local plugin path, for example:
gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"- Install plugin
bin/logstash-plugin install --no-verify- Run Logstash with your plugin
bin/logstash -e 'filter {awesome {}}'At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
You can use the same 2.1 method to run your plugin in an installed Logstash by editing its Gemfile and pointing the :path to your local plugin development directory or you can build the gem and install it using:
- Build your plugin gem
gem build logstash-filter-awesome.gemspec- Install the plugin from the Logstash home
bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem- Start Logstash and proceed to test the plugin
All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
Programming is not a required skill. Whatever you've seen about open source and maintainers or community members saying "send patches or die" - you will not see that here.
It is more important to the community that you are able to contribute.
For more information about contributing, see the CONTRIBUTING file.