Skip to content

Latest commit

 

History

History
76 lines (52 loc) · 3.37 KB

README.md

File metadata and controls

76 lines (52 loc) · 3.37 KB
Raw

Logstash Output Plugin for Azure Kusto

Travis Build Status

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.

This plugin will enable you to process events from Logstash into an Azure Kusto database for later analysis.

Installation

To make the plugin available in your Logstash environment follow these steps:

  • Download the latest release from this repository
  • Install the plugin from the Logstash home
bin/logstash-plugin install /path/to/logstash-output-kusto-0.1.6.gem

Configuration

Before you can start sending events from Logstash to Kusto you need to configure it. The following example shows the bear minimum you should provide, and it would be enough for most use-cases:

output {
	kusto {
            path => "/tmp/kusto/%{+YYYY-MM-dd-HH-mm}.txt"
            ingest_url => "https://ingest-<cluster-name>.kusto.windows.net/"
            app_id => "<application id>"
            app_key => "<application key/secret>"
            app_tenant => "<tenant id>"
            database => "<database name>"
            table => "<target table>"
            mapping => "<mapping name>"
	}
}

Available Configuration Keys

path

The plugin writes events to temporary files before sending them to Kusto. These settings should include a path where these files should be written as well as some sort of time expression to note when file rotation should happen and trigger an upload to the Kusto service. The example above shows how to rotate the files every minute, check the Logstash docs for more information on time expressions.

ingest_url

The Kusto endpoint for ingestion related communication. You can see it on the Azure Portal.

app_id, app_key, app_tenant

Those are the credentials required to connect to the Kusto service. Be sure to use an application with 'ingest' privilages.

database

Database name where events should go to

table

Target table name where events should be saved

mapping

The mapping object name used by Kusto to map an incoming event to the right row format (what value goes into which column)

recovery

If this is set to true (the default), the plugin will attempt to resend pre-existing temp files it finds in the path upon startup

delete_temp_files

Determines if temp files will be deleted after a successful upload (default is true, set false only for debug purposes)

flush_interval

The time (in seconds) for flushing writes to temporary files. Defaults to 2 seconds, 0 will flush on every event. Increase this value to reduce IO calls but keep in mind that events in the buffer will be lost in case of abrupt failure.

Contributing

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.