henkmeulekamp / opsgenie-dotnet-client

C# OpsGenie library to raise/ack/close alerts. Bonus CLI app.

OpsGenie Dotnet API Client

Simple C# dotnet client for OpsGenie Alert Api.

Including a cli client to raise, ack and resolve alerts.

See OpsGenie alert api documentation based on the v2 opsgenie restful API: https://docs.opsgenie.com/docs/api-overview

Example Raise, Acknowledge and Close:

   var opsClient = new OpsGenieClient(new OpsGenieClientConfig
   {
       ApiKey = ".. your api key"
   });
   
   // Opsgenie V2 api is queuing processing message, alertId is not immidiatly returned
   // use unqiue alias to sequence calls without requesting incident status and retrieve alertId

   var uniqueAlias = "alert123";
   
   var response = await opsClient.Raise(new Alert 
   {
       Alias = uniqueAlias, 
       Source = "Test", 
       Message = "All systems down"
   });
   
   if (response.Ok)
   {
       var respAck =  await opsClient.Acknowledge(null, uniqueAlias, "Working on it!");
   
       var respClose = await opsClient.Close(null, uniqueAlias, "Fixed by ..");
   }

As of v2 a custom JsonSerializer needs to be provided, this to provide flexibility in which version of which jsonserializer is used. See the cli project for usage of ServiceStack.Text v4. If you project is using any other Json serializer, Jil, NewtonSoft just hookup your version in those two methods:

using OpsGenieApi.Helpers;
using ServiceStack.Text;

namespace MyProject.OpsGenieImplementation
{
    public class OpsGenieSerializer : IJsonSerializer
    {
        public T DeserializeFromString<T>(string json)
        {
            //provide you deserializer
            return JsonSerializer.DeserializeFromString<T>(json);
        }

        public string SerializeToString<T>(T data)
        {
            //provide your serializer
            return JsonSerializer.SerializeToString(data);
        }
    }
    
    
}

Then provide it using the constructor:

	var opsClient = new OpsGenieClient(opsConfig, new OpsGenieSerializer());

Published the library to nuget for easy reuse:

Install-Package Simple.OpsGenieApi

Cli interface

For integration with a monitoring tool with limited options to call external APIs I added a CLI tool. With this you can resolve, acknowledge and open incidents using command line. See OpsGeniecli project. Commandline options:

• c: config, config file, see format below
• k: apikey, instead of above option
• s: source, source of alert
• m: message, message/details of incident
• a: action, Raise, Acknowledge, Resolve
• i: alias, important value, keeps alerts unique (so raising same alert use same value. same value can be used to close alert
• d: description, optional description of alert
• n: note, optional note of alert

Example - create new alert:
opsgeniecli -c opsgenie.config -a raise -s cli-test -m "Testing cli" -d "Long description" -i alert1

Example - acknowledge:
opsgeniecli -c opsgenie.config -a acknowledge -n " new ack note with more words" -i alert1

Example - close/resolve:
opsgeniecli -c opsgenie.config -a resolve -n "new resolve note with more words" -i alert1

Example - create new alert with apikey (abc1235678) instead of config file:
opsgeniecli -k abc1235678 -a resolve -n "new resolve note with more words" -i alert1

Example config file:

<?xml version="1.0" encoding="utf-8"?>
<OpsGenieClientConfig>
	 <ApiKey> .. your api key .. </ApiKey>	
</OpsGenieClientConfig>

Dependencies

It has the following nuget dependencies:

• servicestack.client version v5.*
• CommandLineParser version 1.9.72

TODO

• improve code, error handling, more tests
• cleanup interface

Requests/Comments? Let me know..