sensu/check-plugin-template

{{- /* Ignore this text, until templating is ran via sensu-plugin-tool the below badge links wiill not render */ -}}

[](https://bonsai.sensu.io/assets/{{ .GithubUser }}/{{ .GithubProject }})  

Check Plugin Template

Overview

check-plugin-template is a template repository which wraps the Sensu Plugin SDK. To use this project as a template, click the "Use this template" button from the main project page. Once the repository is created from this template, you can use the [Sensu Plugin Tool][9] to populate the templated fields with the proper values.

Functionality

After successfully creating a project from this template, update the Config struct with any configuration options for the plugin, map those values as plugin options in the variable options, and customize the checkArgs and executeCheck functions in [main.go][7].

When writing or updating a plugin's README from this template, review the Sensu Community plugin README style guide for content suggestions and guidance. Remove everything prior to # {{ .Name }} from the generated README file, and add additional context about the plugin per the style guide.

Releases with Github Actions

To release a version of your project, simply tag the target sha with a semver release without a v prefix (ex. 1.0.0). This will trigger the [GitHub action][5] workflow to [build and release][4] the plugin with goreleaser. Register the asset with [Bonsai][8] to share it with the community!

---

{{ .Name }}

Table of Contents

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

Overview

The {{ .Name }} is a [Sensu Check][6] that ...

Files

Usage examples

Configuration

Asset registration

[Sensu Assets][10] 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 {{ .GithubUser }}/{{ .GithubProject }}

If you're using an earlier version of sensuctl, you can find the asset on the [Bonsai Asset Index][https://bonsai.sensu.io/assets/{{ .GithubUser }}/{{ .GithubProject }}].

Check definition

---
type: CheckConfig
api_version: core/v2
metadata:
  name: {{ .GithubProject }}
  namespace: default
spec:
  command: {{ .GithubProject }} --example example_arg
  subscriptions:
  - system
  runtime_assets:
  - {{ .GithubUser }}/{{ .GithubProject }}

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 {{ .GithubProject }} repository:

go build

Additional notes

Contributing

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

[4]: https://github.com/{{ .GithubUser }}/{{ .GithubProject }}/blob/master/.github/workflows/release.yml [5]: https://github.com/{{ .GithubUser }}/{{ .GithubProject }}/actions [6]: https://docs.sensu.io/sensu-go/latest/reference/checks/ [7]: https://github.com/sensu/check-plugin-template/blob/master/main.go [8]: https://bonsai.sensu.io/ [9]: https://github.com/sensu/sensu-plugin-tool [10]: https://docs.sensu.io/sensu-go/latest/reference/assets/