[checkmk-commits] Introduced special agent for monitoring Amazon Web Services

Module: check_mk Branch: master Commit: 8590981f343752948870a708b3f7041d36602767 URL: http://git.mathias-kettner.de/git/?p=check_mk.git;a=commit;h=8590981f343752… Author: Simon Betz &lt;si(a)mathias-kettner.de&gt; Date: Wed Nov 14 13:23:15 2018 +0100 Introduced special agent for monitoring Amazon Web Services Change-Id: I4736dca691ae76988fcef52a4ab10c273a471350 --- agents/special/agent_aws | 72 +++++++++++++++++++++++++++++ checks/agent_aws | 39 ++++++++++++++++ cmk/gui/plugins/wato/datasource_programs.py | 46 ++++++++++++++++++ tests/unit/checks/test_agent_aws.py | 14 ++++++ 4 files changed, 171 insertions(+) diff --git a/agents/special/agent_aws b/agents/special/agent_aws new file mode 100755 index 0000000..60a1e84 --- /dev/null +++ b/agents/special/agent_aws @@ -0,0 +1,72 @@ +#!/usr/bin/env python +# -*- encoding: utf-8; py-indent-offset: 4 -*- +# +------------------------------------------------------------------+ +# | ____ _ _ __ __ _ __ | +# | / ___| |__ ___ ___| | __ | \/ | |/ / | +# | | | | '_ \ / _ \/ __| |/ / | |\/| | ' / | +# | | |___| | | | __/ (__| < | | | | . \ | +# | \____|_| |_|\___|\___|_|\_\___|_| |_|_|\_\ | +# | | +# | Copyright Mathias Kettner 2018 mk(a)mathias-kettner.de | +# +------------------------------------------------------------------+ +# +# This file is part of Check_MK. +# The official homepage is at http://mathias-kettner.de/check_mk. +# +# check_mk is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation in version 2. check_mk is distributed +# in the hope that it will be useful, but WITHOUT ANY WARRANTY; with- +# out even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. See the GNU General Public License for more de- +# tails. You should have received a copy of the GNU General Public +# License along with GNU Make; see the file COPYING. If not, write +# to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, +# Boston, MA 02110-1301 USA. +""" +Special agent for monitoring Amazon web services (AWS) with Check_MK. +""" + +import sys +import argparse +import boto3 + + +def parse_arguments(argv): + parser = argparse.ArgumentParser(description=__doc__) + parser.add_argument("--debug", action="store_true", help='''Raise Python exceptions.''') + parser.add_argument("--aws-access-key-id", help='''The access key for your AWS account.''') + parser.add_argument("--aws-secret-access-key", help='''The secret key for your AWS account.''') + parser.add_argument("--region", help='''The region to use.''') + return parser.parse_args(argv) + + +def main(): + args = parse_arguments(sys.argv[1:]) + + if not args.aws_access_key_id or not args.aws_secret_access_key or not args.region: + sys.stderr.write("Access key ID, secret access key and region must be set.\n") + return 1 + + s = boto3.session.Session( + aws_access_key_id=args.aws_access_key_id, + aws_secret_access_key=args.aws_secret_access_key, + region_name=args.region) + + try: + _cloudwatch = s.client('cloudwatch') + except ValueError, err: + # If region name is not valid we get a ValueError + # but not in all cases, eg.: + # 1. 'eu-central-' raises a ValueError + # 2. 'foobar' does not raise a ValueError + # In the second case we get an exception raised by botocore + # during we execute an operation, eg. cloudwatch.get_metrics(**kwargs): + # - botocore.exceptions.EndpointConnectionError + sys.stderr.write("ERROR: %s\n" % err) + return 3 + return 0 + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/checks/agent_aws b/checks/agent_aws new file mode 100644 index 0000000..f08a435 --- /dev/null +++ b/checks/agent_aws @@ -0,0 +1,39 @@ +#!/usr/bin/python +# -*- encoding: utf-8; py-indent-offset: 4 -*- +# +------------------------------------------------------------------+ +# | ____ _ _ __ __ _ __ | +# | / ___| |__ ___ ___| | __ | \/ | |/ / | +# | | | | '_ \ / _ \/ __| |/ / | |\/| | ' / | +# | | |___| | | | __/ (__| < | | | | . \ | +# | \____|_| |_|\___|\___|_|\_\___|_| |_|_|\_\ | +# | | +# | Copyright Mathias Kettner 2014 mk(a)mathias-kettner.de | +# +------------------------------------------------------------------+ +# +# This file is part of Check_MK. +# The official homepage is at http://mathias-kettner.de/check_mk. +# +# check_mk is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation in version 2. check_mk is distributed +# in the hope that it will be useful, but WITHOUT ANY WARRANTY; with- +# out even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. See the GNU General Public License for more de- +# tails. You should have received a copy of the GNU General Public +# License along with GNU Make; see the file COPYING. If not, write +# to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, +# Boston, MA 02110-1301 USA. + + +def agent_aws_arguments(params, hostname, ipaddress): + return [ + "--aws-access-key-id", + params["--aws-access-key-id"], + "--aws-secret-access-key", + passwordstore_get_cmdline("%s", params["--aws-secret-access-key"]), + "--region", + params["--region"], + ] + + +special_agent_info['aws'] = agent_aws_arguments diff --git a/cmk/gui/plugins/wato/datasource_programs.py b/cmk/gui/plugins/wato/datasource_programs.py index 15ab062..e778235 100644 --- a/cmk/gui/plugins/wato/datasource_programs.py +++ b/cmk/gui/plugins/wato/datasource_programs.py @@ -1445,3 +1445,49 @@ register_rule( help=_("This rule allows you to check multiple BI aggregations from multiple sites at once. " "You can also assign aggregations to specific hosts through the piggyback mechanism."), match='first') + +register_rule( + 'datasource_programs', + 'special_agents:aws', + Dictionary( + elements=[ + ("--aws-access-key-id", + TextAscii( + title=_("The access key for your AWS account"), + allow_empty=False, + )), + ("--aws-secret-access-key", + IndividualOrStoredPassword( + title=_("The secret key for your AWS account"), + allow_empty=False, + )), + ("--region", + DropdownChoice( + title=_("The region to use"), + choices=sorted([ + ("ap-south-1", _("Asia Pacific (Mumbai)")), + ("ap-northeast-3", _("Asia Pacific (Osaka-Local)")), + ("ap-northeast-2", _("Asia Pacific (Seoul)")), + ("ap-southeast-1", _("Asia Pacific (Singapore)")), + ("ap-southeast-2", _("Asia Pacific (Sydney)")), + ("ap-northeast-1", _("Asia Pacific (Tokyo)")), + ("ca-central-1", _("Canada (Central)")), + ("cn-north-1", _("China (Beijing)")), + ("cn-northwest-1", _("China (Ningxia)")), + ("eu-central-1", _("EU (Frankfurt)")), + ("eu-west-1", _("EU (Ireland)")), + ("eu-west-2", _("EU (London)")), + ("eu-west-3", _("EU (Paris)")), + ("sa-east-1", _("South America (Sao Paulo)")), + ("us-east-2", _("US East (Ohio)")), + ("us-east-1", _("US East (N. Virginia)")), + ("us-west-1", _("US West (N. California)")), + ("us-west-2", _("US West (Oregon)")), + ], + key=lambda x: x[1]), + )), + ], + optional_keys=[], + ), + title=_('Amazon Web Services (AWS)'), + match='first') diff --git a/tests/unit/checks/test_agent_aws.py b/tests/unit/checks/test_agent_aws.py new file mode 100644 index 0000000..bba4178 --- /dev/null +++ b/tests/unit/checks/test_agent_aws.py @@ -0,0 +1,14 @@ +import pytest + + +(a)pytest.mark.parametrize(&quot;params,result&quot;sult", [ + ({ + "--aws-access-key-id": "user", + "--aws-secret-access-key": "d1ng", + "--region": 'region-eu', + }, ['--aws-access-key-id', 'user', '--aws-secret-access-key', 'd1ng', '--region', 'region-eu']), +]) +def test_aws(check_manager, params, result): + agent = check_manager.get_special_agent("agent_aws") + arguments = agent.argument_func(params, "host", "address") + assert arguments == result