Arthur/ssh check #1117
Merged
Arthur/ssh check #1117
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| import time | ||
| import paramiko as p | ||
| from checks import AgentCheck | ||
| import socket |
There was a problem hiding this comment.
Concerning the imports we usually try to put them in 3 separate categories:
# stdlib
# 3p
# project
-refactored try cases in sftp_check to be more efficient -exception message modified to be none by default -file renamed to ssh check and sftp is now an option
|
@remh Please review |
|
|
||
| class CheckSSH(AgentCheck): | ||
|
|
||
| def _load_conf(self, instance): |
There was a problem hiding this comment.
You can refactor and make them clearer by using namedtuples:
from collections import namedtuple
OPTIONS = [
('host', True, None, str),
('port', False, 22, int),
('username', True, None, str),
('password', False, None, str),
('private_key', False, None, str),
('sftp_check', False, True, bool),
]
Config = namedtuple('Config', [
'host',
'port',
'username',
'password',
'private_key',
'sftp_check',
]
)
def _load_conf(self, instance):
params = []
for option, required, default, expected_type in REQUIRED:
value = instance.get(option)
if required and not value or type(value) != expected_type :
raise Exception("Please specify a valid {0}".format(option))
if value is None or type(value) != expected_type:
self.log.debug("Bad or missing value for {0} parameter. Using default".format(option))
params.append(value)
return Config._make(params)
| self.gauge('sftp.response_time', time_taken) | ||
|
|
||
| except Exception as e: | ||
| exception_message = "{0}".format(e) |
|
Looks good besides the few small comments! |
-load function that uses namedtuple -easier and cleaner to read -yaml file now commented with required and optional
| return self.Config._make(params) | ||
|
|
||
| def check(self, instance): | ||
| host, port, username, password, private_key_file, sftp_check, add_missing_keys = self._load_conf(instance) |
There was a problem hiding this comment.
You shouldn't unpack the conf like that. It defeats the purpose of using a namedtuple.
You should do:
conf = self._load_conf(instance)and then if you want to get the host you can just get it using:
conf.host
|
Last point, would it be possible to add a test for that check ? Maybe using http://sdf.org/ ? |
| self.service_check('ssh.can_connect', status, message=exception_message) | ||
| if conf.sftp_check: | ||
| self.service_check('sftp.can_connect', status, message=exception_message) | ||
| raise Exception (e) |
-tests for SSH connection
|
|
||
| class SshTestCase(unittest.TestCase): | ||
|
|
||
| def test_ssh(self): |
There was a problem hiding this comment.
Can you configure your editors to have 4 spaces indentation instead of tabs ?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Check meant to:
2.Check The response time
@LeoCavaille