https://github.com/xmatters/sensu-plugins-xmatters

A Sensu plugin for xMatters
https://github.com/xmatters/sensu-plugins-xmatters

Last synced: 15 days ago
JSON representation

A Sensu plugin for xMatters

• Host: GitHub
• URL: https://github.com/xmatters/sensu-plugins-xmatters
• Owner: xmatters
• License: mit
• Created: 2017-09-25T18:57:13.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-02-14T18:59:02.000Z (almost 7 years ago)
• Last Synced: 2024-07-27T19:13:56.409Z (6 months ago)
• Language: Ruby
• Size: 12.7 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Sensu-Plugins-xMatters

## What is it?

This version of the integration is a simple sensu plugin with a single handler, found at [bin/handler-xmatters.rb](bin/handler-xmatters.rb). The handler will create a new event in xMatters via an inbound integration in the included Sensu Communication Plan.

## How does it work?

### Installation

Before installing the Sensu plugin, import the Sensu communication plan into your xMatters instance. You will need the URLs for the inbound and outbound integrations from the imported plan.

To install the integration, run the following command:

```sh

sensu-install -p xmatters

```

### Configuration

#### Configuring a handler:

To configure a handler, use the following syntax:

```json

{

  "handlers": {

    "xmatters_handler": {

      "type": "pipe",

      "command": "handler-xmatters.rb"

    }

  }

}

```

#### Create a default settings file:

To create a default settings file, use the following syntax, and replace the inbound_integration_url with the URL of the inbound integration in the Sensu communication plan:

```json

{

  "xmatters": {

     "inbound_integration_url": "https://company.instance.xmatters.com/api/integration/1/functions/uuid/triggers"

   }

}

```

To create multiple handlers that point to different integration URLS, use the following syntax:

```json

{

  "handlers": {

    "xmatters_handler": {

      "type": "pipe",

      "command": "handler-xmatters.rb -c xmatters_custom"

    }

  }

}

{

  "xmatters_custom": {

     "inbound_integration_url": "https://company.instance.xmatters.com/api/integration/1/functions/uuid/triggers"

   }

}

```

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

## Development and Publishing

During development, to execute tests and perform additional linting and validation run the following command:

```sh

  bundle exec rake

```

When ready to release a new version, run the following commands:

```sh

  gem build sensu-plugins-xmatters.gemspec

  gem push sensu-plugins-xmatters-x.y.z.gem

```