README.md

sensu-ofd-check

Table of Contents

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

Overview

The sensu-ofd-check is a Sensu Check that calcualtes total number of open file descriptors per specified linux user

Files

bin/check-open-file-descriptors

Usage examples

The Sensu Go Open File Descriptors plugin

Usage:
  sensu-ofd-check [flags]
  sensu-ofd-check [command]

Available Commands:
  help        Help about any command
  version     Print the version number of this plugin

Flags:
  -c, --crit int      Critical threshold - count of file descriptors required for critical state
  -h, --help          help for sensu-ofd-check
  -u, --user string   User to query for open file descriptors (default "sensu")
  -w, --warn int      Warning threshold - count of file descriptors required for warning state

Use "sensu-ofd-check [command] --help" for more information about a command.

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 ValkyrieOps/check-open-file-descriptors

If you're using an earlier version of sensuctl, you can find the asset on the [Bonsai Asset Index][https://bonsai.sensu.io/assets/ValkyrieOps/check-open-file-descriptors].

Check definition

---
type: CheckConfig
api_version: core/v2
metadata:
  name: check-open-file-descriptors
  namespace: default
spec:
  command: check-open-file-descriptors -u 'sensu' -w 100 -c 200
  subscriptions:
  - system
  runtime_assets:
  - ValkyrieOps/check-open-file-descriptors

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 check-open-file-descriptors repository:

go build

Additional notes

Contributing

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