sensu-go-systemd-handler

sensu-go-systemd-handler

Table of Contents

• Overview
• Files
• Usage examples
• Configuration
  • Asset registration
  • Handler definition
  • Annotations
• Installation from source
• Additional notes
• Contributing

Overview

The sensu-go-systemd-handler is a Sensu Handler that can restart failed unit.

That program uses ssh to forward systemd dbus socket.

Files

sensu-go-systemd-handler

Usage examples

sensu-go-systemd-handler -s nginx.service -a reload
sensu-go-systemd-handler -s nginx.service -M fail
sensu-go-systemd-handler -m -s nginx*

Configuration

Asset registration

Sensu Assets are the best way to make use of this plugin. If you're not using an asset, please consider doing so! If you're using sensuctl 5.13 with Sensu Backend 5.13 or later, you can use the following command to add the asset:

sensuctl asset add sardinasystems/sensu-go-systemd-handler

If you're using an earlier version of sensuctl, you can find the asset on the [Bonsai Asset Index][https://bonsai.sensu.io/assets/sardinasystems/sensu-go-systemd-handler].

Handler definition

---
type: Handler
api_version: core/v2
metadata:
  name: sensu-go-systemd-handler
  namespace: default
spec:
  command: sensu-go-systemd-handler
  type: pipe
  runtime_assets:
  - sensu-go-systemd-handler

Proxy Support

This handler supports the use of the environment variables HTTP_PROXY, HTTPS_PROXY, and NO_PROXY (or the lowercase versions thereof). HTTPS_PROXY takes precedence over HTTP_PROXY for https requests. The environment values may be either a complete URL or a "host[:port]", in which case the "http" scheme is assumed.

Annotations

All arguments for this handler are tunable on a per entity or check basis based on annotations. The annotations keyspace for this handler is sensu.io/plugins/sensu-go-systemd-handler/config.

Examples

To change the example argument for a particular check, for that checks's metadata add the following:

type: CheckConfig
api_version: core/v2
metadata:
  annotations:
    sensu.io/plugins/sensu-go-systemd-handler/config/unit: "nginx.service"
[...]

Installation from source

The preferred way of installing and deploying this plugin is to use it as an Asset. If you would like to compile and install the plugin from source or contribute to it, download the latest version or create an executable script from this source.

From the local path of the sensu-go-systemd-handler repository:

go build

Additional notes

Contributing

For more information about contributing to this plugin, see Contributing.