internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-08 06:12:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Tidy up validate-modules ignores for monitoring modules (#1350)

Browse Source 
* fixed validation-modules for plugins/modules/monitoring/bigpanda.py

* fixed validation-modules for plugins/modules/monitoring/circonus_annotation.py

* fixed validation-modules for plugins/modules/monitoring/honeybadger_deployment.py

* fixed validation-modules for plugins/modules/monitoring/icinga2_feature.py

* fixed validation-modules for plugins/modules/monitoring/icinga2_host.py

* fixed validation-modules for plugins/modules/monitoring/librato_annotation.py

* fixed validation-modules for plugins/modules/monitoring/logentries.py

* fixed validation-modules for plugins/modules/monitoring/logstash_plugin.py

* fixed validation-modules for plugins/modules/monitoring/newrelic_deployment.py

* fixed validation-modules for plugins/modules/monitoring/pagerduty_alert.py

* fixed validation-modules for plugins/modules/monitoring/pagerduty.py

* fixed validation-modules for plugins/modules/monitoring/pingdom.py

* fixed validation-modules for plugins/modules/monitoring/rollbar_deployment.py

* fixed validation-modules for plugins/modules/monitoring/spectrum_device.py

* fixed validation-modules for plugins/modules/monitoring/stackdriver.py

* fixed validation-modules for plugins/modules/monitoring/statusio_maintenance.py

* fixed validation-modules for plugins/modules/monitoring/uptimerobot.py

* fixed validation-modules for plugins/modules/monitoring/datadog/datadog_event.py

* fixed validation-modules for plugins/modules/monitoring/datadog/datadog_monitor.py

* fixed validation-modules for plugins/modules/monitoring/sensu/sensu_check.py

* fixed validation-modules for plugins/modules/monitoring/sensu/sensu_client.py

* fixed validation-modules for plugins/modules/monitoring/sensu/sensu_handler.py

* fixed validation-modules for plugins/modules/monitoring/sensu/sensu_silence.py

* fixed validation-modules for plugins/modules/monitoring/sensu/sensu_subscription.py

* fixed trailing space

* Enabling validation-modules for monitoring modules

* Added line for 2.9

* Update plugins/modules/monitoring/icinga2_host.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/monitoring/datadog/datadog_event.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Suggestion from PR

* oops, missed the 2.11 ignore file

* Update plugins/modules/monitoring/icinga2_host.py

Co-authored-by: Felix Fontein <felix@fontein.de>

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky
2020-11-24 10:07:03 +13:00
committed by GitHub
parent 5a567b80c6
commit ce5fc7764a
27 changed files with 234 additions and 198 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
plugins/modules/monitoring/sensu/sensu_check.py
View File

@@ -19,16 +19,19 @@ description:
- they are simply specified for your convenience.
options:
name:
type: str
description:
- The name of the check
- This is the key that is used to determine whether a check exists
required: true
state:
type: str
description:
- Whether the check should be present or not
choices: [ 'present', 'absent' ]
default: present
path:
type: str
description:
- Path to the json file of the check to be added/removed.
- Will be created if it does not exist (unless I(state=absent)).
@@ -41,40 +44,48 @@ options:
type: bool
default: 'no'
command:
type: str
description:
- Path to the sensu check to run (not required when I(state=absent))
required: true
handlers:
type: list
description:
- List of handlers to notify when the check fails
default: []
subscribers:
type: list
description:
- List of subscribers/channels this check should run for
- See sensu_subscribers to subscribe a machine to a channel
default: []
interval:
type: int
description:
- Check interval in seconds
timeout:
type: int
description:
- Timeout for the check
default: 10
- If not specified, it defaults to 10.
ttl:
type: int
description:
- Time to live in seconds until the check is considered stale
handle:
description:
- Whether the check should be handled or not
type: bool
default: 'yes'
default: false
subdue_begin:
type: str
description:
- When to disable handling of check failures
subdue_end:
type: str
description:
- When to enable handling of check failures
dependencies:
type: list
description:
- Other checks this check depends on, if dependencies fail,
- handling of this check will be disabled
@@ -95,12 +106,14 @@ options:
- Whether the check should be scheduled at all.
- You can still issue it via the sensu api
type: bool
default: 'yes'
default: false
occurrences:
type: int
description:
- Number of event occurrences before the handler should take action
default: 1
- If not specified, defaults to 1.
refresh:
type: int
description:
- Number of seconds handlers should wait before taking second action
aggregate:
@@ -110,17 +123,21 @@ options:
type: bool
default: 'no'
low_flap_threshold:
type: int
description:
- The low threshold for flap detection
high_flap_threshold:
type: int
description:
- The high threshold for flap detection
custom:
type: dict
description:
- A hash/dictionary of custom parameters for mixing to the configuration.
- You can't rewrite others module parameters using this
default: {}
source:
type: str
description:
- The check source, used to create a JIT Sensu client for an external resource (e.g. a network switch).
author: "Anders Ingemann (@andsens)"

18
plugins/modules/monitoring/sensu/sensu_client.py
View File

@@ -16,33 +16,38 @@ description:
- 'For more information, refer to the Sensu documentation: U(https://sensuapp.org/docs/latest/reference/clients.html)'
options:
state:
type: str
description:
- Whether the client should be present or not
choices: [ 'present', 'absent' ]
default: present
name:
type: str
description:
- A unique name for the client. The name cannot contain special characters or spaces.
default: System hostname as determined by Ruby Socket.gethostname (provided by Sensu)
- If not specified, it defaults to the system hostname as determined by Ruby Socket.gethostname (provided by Sensu).
address:
type: str
description:
- An address to help identify and reach the client. This is only informational, usually an IP address or hostname.
default: Non-loopback IPv4 address as determined by Ruby Socket.ip_address_list (provided by Sensu)
- If not specified it defaults to non-loopback IPv4 address as determined by Ruby Socket.ip_address_list (provided by Sensu).
subscriptions:
type: list
description:
- An array of client subscriptions, a list of roles and/or responsibilities assigned to the system (e.g. webserver).
- These subscriptions determine which monitoring checks are executed by the client, as check requests are sent to subscriptions.
- The subscriptions array items must be strings.
required: True
safe_mode:
description:
- If safe mode is enabled for the client. Safe mode requires local check definitions in order to accept a check request and execute the check.
type: bool
default: 'no'
redact:
type: list
description:
- Client definition attributes to redact (values) when logging and sending client keepalives.
socket:
type: dict
description:
- The socket definition scope, used to configure the Sensu client socket.
keepalives:
@@ -51,9 +56,11 @@ options:
type: bool
default: 'yes'
keepalive:
type: dict
description:
- The keepalive definition scope, used to configure Sensu client keepalives behavior (e.g. keepalive thresholds, etc).
registration:
type: dict
description:
- The registration definition scope, used to configure Sensu registration event handlers.
deregister:
@@ -62,18 +69,23 @@ options:
type: bool
default: 'no'
deregistration:
type: dict
description:
- The deregistration definition scope, used to configure automated Sensu client de-registration.
ec2:
type: dict
description:
- The ec2 definition scope, used to configure the Sensu Enterprise AWS EC2 integration (Sensu Enterprise users only).
chef:
type: dict
description:
- The chef definition scope, used to configure the Sensu Enterprise Chef integration (Sensu Enterprise users only).
puppet:
type: dict
description:
- The puppet definition scope, used to configure the Sensu Enterprise Puppet integration (Sensu Enterprise users only).
servicenow:
type: dict
description:
- The servicenow definition scope, used to configure the Sensu Enterprise ServiceNow integration (Sensu Enterprise users only).
notes:

15
plugins/modules/monitoring/sensu/sensu_handler.py
View File

@@ -16,35 +16,42 @@ description:
- 'For more information, refer to the Sensu documentation: U(https://sensuapp.org/docs/latest/reference/handlers.html)'
options:
state:
type: str
description:
- Whether the handler should be present or not
choices: [ 'present', 'absent' ]
default: present
name:
type: str
description:
- A unique name for the handler. The name cannot contain special characters or spaces.
required: True
type:
type: str
description:
- The handler type
choices: [ 'pipe', 'tcp', 'udp', 'transport', 'set' ]
required: True
filter:
type: str
description:
- The Sensu event filter (name) to use when filtering events for the handler.
filters:
type: list
description:
- An array of Sensu event filters (names) to use when filtering events for the handler.
- Each array item must be a string.
severities:
type: list
description:
- An array of check result severities the handler will handle.
- 'NOTE: event resolution bypasses this filtering.'
choices: [ 'warning', 'critical', 'unknown' ]
- "Example: [ 'warning', 'critical', 'unknown' ]."
mutator:
type: str
description:
- The Sensu event mutator (name) to use to mutate event data for the handler.
timeout:
type: int
description:
- The handler execution duration timeout in seconds (hard stop).
- Only used by pipe and tcp handler types.
@@ -60,19 +67,23 @@ options:
type: bool
default: 'no'
command:
type: str
description:
- The handler command to be executed.
- The event data is passed to the process via STDIN.
- 'NOTE: the command attribute is only required for Pipe handlers (i.e. handlers configured with "type": "pipe").'
socket:
type: dict
description:
- The socket definition scope, used to configure the TCP/UDP handler socket.
- 'NOTE: the socket attribute is only required for TCP/UDP handlers (i.e. handlers configured with "type": "tcp" or "type": "udp").'
pipe:
type: dict
description:
- The pipe definition scope, used to configure the Sensu transport pipe.
- 'NOTE: the pipe attribute is only required for Transport handlers (i.e. handlers configured with "type": "transport").'
handlers:
type: list
description:
- An array of Sensu event handlers (names) to use for events using the handler set.
- Each array item must be a string.

9
plugins/modules/monitoring/sensu/sensu_silence.py
View File

@@ -18,12 +18,15 @@ description:
for subscriptions and checks.
options:
check:
type: str
description:
- Specifies the check which the silence entry applies to.
creator:
type: str
description:
- Specifies the entity responsible for this entry.
expire:
type: int
description:
- If specified, the silence entry will be automatically cleared
after this number of seconds.
@@ -33,23 +36,25 @@ options:
cleared once the condition it is silencing is resolved.
type: bool
reason:
type: str
description:
- If specified, this free-form string is used to provide context or
rationale for the reason this silence entry was created.
state:
type: str
description:
- Specifies to create or clear (delete) a silence entry via the Sensu API
required: true
default: present
choices: ['present', 'absent']
subscription:
type: str
description:
- Specifies the subscription which the silence entry applies to.
- To create a silence entry for a client prepend C(client:) to client name.
Example - C(client:server1.example.dev)
required: true
default: []
url:
type: str
description:
- Specifies the URL of the Sensu monitoring host server.
required: false

3
plugins/modules/monitoring/sensu/sensu_subscription.py
View File

@@ -16,16 +16,19 @@ description:
- Manage which I(sensu channels) a machine should subscribe to
options:
name:
type: str
description:
- The name of the channel
required: true
state:
type: str
description:
- Whether the machine should subscribe or unsubscribe from the channel
choices: [ 'present', 'absent' ]
required: false
default: present
path:
type: str
description:
- Path to the subscriptions json file
required: false