sensu-plugins-uptime-checks 3.1.0 → 3.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -1
  3. data/README.md +117 -11
  4. data/lib/sensu-plugins-uptime-checks/version.rb +1 -1
  5. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c4863501e07af1962dbd17f7c7b2549afab3f3b04140280b18fca5c4c3fd8c7e
4
- data.tar.gz: d9c1f7741a2ae51dbff4449036446fc6fa7168b4ca7b9c8aef9eb9d863daed4c
3
+ metadata.gz: 261c7ce7f96c71ee2efad332354f357e02cd796ac47dc2f53734581070781fbe
4
+ data.tar.gz: 496a1af59516df743890dab5d950f327bdf810f8c01173d13bbc90e70ad585fb
5
5
  SHA512:
6
- metadata.gz: 88b467fedaac944113da1ea13f41173c24b97c13c995464ce659dbedca0654ae751e64f58c8238d12924c58753e0ccef575f915ff071c47be83cbdf9b79540a8
7
- data.tar.gz: ce342c667a394293ed3fa106c24b17430a11ba691886dea99fcc093f66f4925bb37f7f8718552ebf8df2903e01174b6c2b944ea06356e4470602d5d864419bc7
6
+ metadata.gz: ff0f0d60676edc6e6182edc358e91340d920504f8b1b1c45ac2decb0c551d08c5228ac7a69f062af50b08f3fafe6c81f05ebe28ca0e1dceb9b1fb27ae5b1b019
7
+ data.tar.gz: 675012d80bc87f54947811a1efd1eff6659b4757ab1398a8ed72fd4c4b322fff5f9b4456de07b5883682d76f5edf1857c7724d8aa363a80abb0657326e3409ea
data/CHANGELOG.md CHANGED
@@ -5,6 +5,12 @@ This Changelog following the conventions laid out [here](https://github.com/sens
5
5
 
6
6
  ## [Unreleased]
7
7
 
8
+ ## [3.1.0] - 2019-12-19
9
+ ### Changed
10
+ - Updated bundler development depedency to '~> 2.1'
11
+ - Updated README to conform with standardization guidelines (sensu-plugins/community#134)
12
+ - Removed centos asset definition
13
+
8
14
  ## [3.1.0] - 2019-12-09
9
15
  ### Added
10
16
  - Updated asset build targets
@@ -64,7 +70,8 @@ This Changelog following the conventions laid out [here](https://github.com/sens
64
70
  ### Added
65
71
  - initial release
66
72
 
67
- [Unreleased]: https://github.com/sensu-plugins/sensu-plugins-uptime-checks/compare/3.1.0...HEAD
73
+ [Unreleased]: https://github.com/sensu-plugins/sensu-plugins-uptime-checks/compare/3.2.0...HEAD
74
+ [3.2.0]: https://github.com/sensu-plugins/sensu-plugins-uptime-checks/compare/3.1.0...3.2.0
68
75
  [3.1.0]: https://github.com/sensu-plugins/sensu-plugins-uptime-checks/compare/3.0.0...3.1.0
69
76
  [3.0.0]: https://github.com/sensu-plugins/sensu-plugins-uptime-checks/compare/2.0.0...3.0.0
70
77
  [2.0.0]: https://github.com/sensu-plugins/sensu-plugins-uptime-checks/compare/1.2.0...2.0.0
data/README.md CHANGED
@@ -1,26 +1,132 @@
1
- ## Sensu-Plugins-uptime-checks
2
-
1
+ [![Sensu Bonsai Asset](https://img.shields.io/badge/Bonsai-Download%20Me-brightgreen.svg?colorB=89C967&logo=sensu)](https://bonsai.sensu.io/assets/sensu-plugins/sensu-plugins-uptime-checks)
3
2
  [ ![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-uptime-checks.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-uptime-checks)
4
3
  [![Gem Version](https://badge.fury.io/rb/sensu-plugins-uptime-checks.svg)](http://badge.fury.io/rb/sensu-plugins-uptime-checks)
5
4
  [![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-uptime-checks/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-uptime-checks)
6
5
  [![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-uptime-checks/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-uptime-checks)
7
6
  [![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-uptime-checks.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-uptime-checks)
8
- [![Sensu Bonsai Asset](https://img.shields.io/badge/Bonsai-Download%20Me-brightgreen.svg?colorB=89C967&logo=sensu)](https://bonsai.sensu.io/assets/sensu-plugins/sensu-plugins-uptime-checks)
9
7
 
10
- ## Sensu Asset
11
- The Sensu assets packaged from this repository are built against the Sensu Ruby runtime environment. When using these assets as part of a Sensu Go resource (check, mutator or handler), make sure you include the corresponding Sensu Ruby runtime asset in the list of assets needed by the resource. The current ruby-runtime assets can be found [here](https://bonsai.sensu.io/assets/sensu/sensu-ruby-runtime) in the [Bonsai Asset Index](bonsai.sensu.io).
8
+ ## Sensu Plugins Uptime Checks Plugin
9
+
10
+ - [Overview](#overview)
11
+ - [Files](#files)
12
+ - [Usage examples](#usage-examples)
13
+ - [Configuration](#configuration)
14
+ - [Sensu Go](#sensu-go)
15
+ - [Asset registration](#asset-registration)
16
+ - [Asset definition](#asset-definition)
17
+ - [Check definition](#check-definition)
18
+ - [Sensu Core](#sensu-core)
19
+ - [Check definition](#check-definition)
20
+ - [Installation from source](#installation-from-source)
21
+ - [Additional notes](#additional-notes)
22
+ - [Contributing](#contributing)
12
23
 
13
- ## Functionality
24
+ ### Overview
14
25
 
15
- ## Files
26
+ This plugin provides native instrumentation for collecting uptime and idletime metrics.
27
+
28
+ ### Files
16
29
  * bin/check-uptime.rb
17
30
  * bin/metrics-uptime.rb
31
+
32
+ **check-uptime**
33
+ Checks the system's uptime and warns if the system has been rebooted.
34
+
35
+ **metrics-uptime**
36
+ Provides uptime metrics.
37
+
38
+ ## Usage examples
39
+
40
+ ### Help
41
+
42
+ **check-uptime.rb**
43
+ ```
44
+ Usage: check-uptime.rb (options)
45
+ -g, --greater-than This compare uptime > threshold. Default behavior uptime < threshold
46
+ -w SEC Warn threshold in SEC
47
+ ```
48
+
49
+ **metrics-uptime.rb**
50
+ ```
51
+ Usage: metrics-uptime.rb (options)
52
+ -s, --scheme SCHEME Metric naming scheme, text to prepend to metric
53
+ ```
54
+
55
+ ## Configuration
56
+ ### Sensu Go
57
+ #### Asset registration
58
+
59
+ 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 or later, you can use the following command to add the asset:
60
+
61
+ `sensuctl asset add sensu-plugins/sensu-plugins-uptime-checks`
62
+
63
+ If you're using an earlier version of sensuctl, you can download the asset definition from [this project's Bonsai asset index page](https://bonsai.sensu.io/assets/sensu-plugins/sensu-plugins-uptime-checks).
64
+
65
+ #### Asset definition
66
+
67
+ ```yaml
68
+ ---
69
+ type: Asset
70
+ api_version: core/v2
71
+ metadata:
72
+ name: sensu-plugins-uptime-checks
73
+ spec:
74
+ url: https://assets.bonsai.sensu.io/65a0f4378e92721cf5565e3be73bbe30632df6c7/sensu-plugins-uptime-checks_3.1.0_centos_linux_amd64.tar.gz
75
+ sha512: 2c0337391edfafa308c18bec7cae1c641012d6225c92d7bba98c79665e34311a2b13250a60b5b0074da82b274355e4715bca73c1b428b04132cd8152e39d120f
76
+ ```
77
+
78
+ #### Check definition
79
+
80
+ ```yaml
81
+ ---
82
+ type: CheckConfig
83
+ spec:
84
+ command: "check-uptime.rb"
85
+ handlers: []
86
+ high_flap_threshold: 0
87
+ interval: 10
88
+ low_flap_threshold: 0
89
+ publish: true
90
+ runtime_assets:
91
+ - sensu-plugins/sensu-plugins-uptime-checks
92
+ - sensu/sensu-ruby-runtime
93
+ subscriptions:
94
+ - linux
95
+ ```
96
+
97
+ ### Sensu Core
98
+
99
+ #### Check definition
100
+ ```json
101
+ {
102
+ "checks": {
103
+ "check-uptime": {
104
+ "command": "check-uptime.rb",
105
+ "subscribers": ["linux"],
106
+ "interval": 10,
107
+ "refresh": 10,
108
+ "handlers": ["influxdb"]
109
+ }
110
+ }
111
+ }
112
+ ```
113
+
114
+ ## Installation from source
115
+
116
+ ### Sensu Go
117
+
118
+ See the instructions above for [asset registration](#asset-registration).
119
+
120
+ ### Sensu Core
121
+
122
+ Install and setup plugins on [Sensu Core](https://docs.sensu.io/sensu-core/latest/installation/installing-plugins/).
18
123
 
19
- ## Usage
124
+ ## Additional notes
20
125
 
21
- ## Installation
126
+ ### Sensu Go Ruby Runtime Assets
22
127
 
23
- [Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
128
+ The Sensu assets packaged from this repository are built against the Sensu Ruby runtime environment. When using these assets as part of a Sensu Go resource (check, mutator, or handler), make sure to include the corresponding [Sensu Ruby Runtime Asset](https://bonsai.sensu.io/assets/sensu/sensu-ruby-runtime) in the list of assets needed by the resource.
24
129
 
25
- ## Notes
130
+ ## Contributing
26
131
 
132
+ See [CONTRIBUTING.md](https://github.com/sensu-plugins/sensu-plugins-uptime-checks/blob/master/CONTRIBUTING.md) for information about contributing to this plugin.
data/lib/sensu-plugins-uptime-checks/version.rb CHANGED
@@ -1,7 +1,7 @@
1
1
  module SensuPluginsUptimeChecks
2
2
  module Version
3
3
  MAJOR = 3
4
- MINOR = 1
4
+ MINOR = 2
5
5
  PATCH = 0
6
6
 
7
7
  VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: sensu-plugins-uptime-checks
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.1.0
4
+ version: 3.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Sensu Plugins and contributors
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-12-09 00:00:00.000000000 Z
11
+ date: 2020-01-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: sensu-plugin
@@ -30,14 +30,14 @@ dependencies:
30
30
  requirements:
31
31
  - - "~>"
32
32
  - !ruby/object:Gem::Version
33
- version: '1.7'
33
+ version: '2.1'
34
34
  type: :development
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - "~>"
39
39
  - !ruby/object:Gem::Version
40
- version: '1.7'
40
+ version: '2.1'
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: codeclimate-test-reporter
43
43
  requirement: !ruby/object:Gem::Requirement