README.md

OpsGenie Logstash Plugin

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.

Install and Run OpsGenie Output Plugin in Logstash

OpsGenie Logstash Output plugin is available in RubyGems.org

• Logstash 5.4+

bin/logstash-plugin install logstash-output-opsgenie

• Other Versions

bin/plugin install logstash-output-opsgenie

• OpsGenie has an integration with Logstash. To use the plugin you need to add a Logstash Integration in OpsGenie and obtain the API Key.

• You may use plugins like Mutate to populate the fields which will be used in logstash-output-opsgenie.

  mutate{
    add_field => {
        "opsgenieAction" => "create"
        "alias" => "neo123"
        "description" => "Every alert needs a description"
        "actions" => ["Restart", "AnExampleAction"]
	"tags" => ["OverwriteQuietHours","Critical"]
	"[details][prop1]"=> "val1"
        "[details][prop2]" => "val2"
        "entity" => "An example entity"
        "priority" => "P4"
	"source" => "custom source"
	"user" => "custom user"
	"note" => "alert is created"
        }
    }
    ruby {
 	 code => "event.set('teams', [{'name' => 'Integration'}, {'name' => 'Platform'}])"
    }
}

• Add the following configuration to your configuration file and populate "apiKey" field with your Logstash Integration API Key

output {
	opsgenie {
		"apiKey" => "logstash_integration_api_key"
	}
}

• Run Logstash.

For more information about OpsGenie Logstash Integration, please refer to integration guide.