Giter Club home page Giter Club logo

sensu-system-check's Introduction

Sensu Bonsai Asset Go Test goreleaser

Sensu System Check

Table of Contents

Overview

The Sensu System Check is a cross-platform Sensu Metrics Check that provides baseline system metrics in prometheus format.

Output Metrics

cpu

Name Description
system_cpu_cores Number of cpu cores on the system
system_cpu_idle Percent of time cpu was idle1
system_cpu_used Percent of time cpu was used1
system_cpu_user Percent of time cpu was used by normal processes in user mode1
system_cpu_system Percent of time cpu used by processes executed in kernel mode1
system_cpu_nice Percent of time cpu used by niced processes in user mode1
system_cpu_iowait Percent of time cpu waiting for I/O to complete1
system_cpu_irq Percent of time cpu servicing interrupts1
system_cpu_softirq Percent of time cpu servicing software interrupts1
system_cpu_stolen Percent of time cpu serviced virtual hosts operating systems1
system_cpu_guest Percent of time cpu serviced guest operating system1
system_cpu_guest_nice Percent of time cpu serviced niced guest operating system1

Note 1: Metric tagged by cpu name with cpu-total meaning summed over all cpus on the system (Ex: cpu="cpu0", cpu="cpu-total")

mem

Name Description
system_mem_used Percent of memory used
system_mem_used_bytes Used memory in bytes
system_mem_total_bytes Total memory in bytes

swap

Name Description
system_swap_used Percent of swap used
system_swap_used_bytes Used swap in bytes
system_swap_total_bytes Total swap in bytes

load

Name Description
system_load_load1 System load averaged over 1 minute, high load value dependant on number of cpus in system
system_load_load5 System load averaged over 5 minute, high load value dependent on number of cpus in system
system_load_load15 System load averaged over 15 minute, high load value dependent on number of cpus in system
system_load_load1_per_cpu System load averaged over 1 minute normalized by cpu count, values > 1 means system may be overloaded
system_load_load5_per_cpu System load averaged over 5 minute normalized by cpu count, values > 1 means system may be overloaded
system_load_load15_per_cpu System load averaged over 15 minute normalized by cpu count, values > 1 means system may be overloaded

host

Name Description
system_host_uptime Host uptime in seconds
system_host_processes Number of host processes

Usage examples

Help output

Cross-platform System Check

Usage:
  system-check [flags]
  system-check [command]

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

Flags:
  -h, --help           help for system-check
  -i, --interval int   Interval in seconds over which to calculate cpu usage metrics (default 3)

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

Environment variables

Argument Environment Variable
--interval SYSTEM_CHECK_INTERVAL

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 sensu/system-check

If you're using an earlier version of sensuctl, you can find the asset on the Bonsai Asset Index.

Check definition

---
type: CheckConfig
api_version: core/v2
metadata:
  name: system-check
  namespace: default
spec:
  command: system-check
  subscriptions:
  - system
  runtime_assets:
  - sensu/system-check

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 system-check repository:

go build

Additional notes

Contributing

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

sensu-system-check's People

Contributors

jspaleta avatar echlebek avatar jadiunr avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.