Neo4j input plugin v2.0.5

  • Plugin version: v2.0.5
  • Released on: 2017-06-23
  • Changelog

For other versions, see the overview list.

To learn more about Logstash, see the Logstash Reference.

Getting Help

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Description

This plugin gets data from a Neo4j database in predefined intervals. To fetch this data uses a given Cypher query.

# Usage:

input {
  neo4j {
    query => "MATCH (p:`Person`)-->(m:`Movie`) WHERE m.released = 2005 RETURN *"
    path  => "/foo/bar.db"
  }
}

In embedded_db mode this plugin require a neo4j db 2.0.1 or superior. If using the remote version there is no major restriction.

Neo4j Input Configuration Options

This plugin supports the following configuration options plus the Common Options described later.

Setting Input typeRequired

path

string

Yes

query

string

Yes

schedule

string

No

Also see Common Options for a list of options supported by all input plugins.

 

path

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

The path within your file system where the neo4j database is located

query

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

If undefined, Logstash will complain, even if codec is unused. Cypher query used to retrieve data from the neo4j database, this statement should looks like something like this:

MATCH (p:Person)-→(m:Movie) WHERE m.released = 2005 RETURN *

schedule

  • Value type is string
  • There is no default value for this setting.

Schedule of when to periodically run statement, in Cron format for example: "* * * * *" (execute query every minute, on the minute). If this variable is not specified then this input will run only once

Common Options

The following configuration options are supported by all input plugins:

Details

 

add_field

  • Value type is hash
  • Default value is {}

Add a field to an event

codec

  • Value type is codec
  • Default value is "plain"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

enable_metric

  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

id

  • Value type is string
  • There is no default value for this setting.

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 neo4j inputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

input {
  neo4j {
    id => "my_plugin_id"
  }
}

tags

  • Value type is array
  • There is no default value for this setting.

Add any number of arbitrary tags to your event.

This can help with processing later.

type

  • Value type is string
  • There is no default value for this setting.

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.