Skip to content
Amazon Web Services Elastic Compute Cloud (EC2) Rescue for Linux is a python-based tool that allows for the automatic diagnosis of common problems found on EC2 Linux instances.
Branch: develop
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add pull request template. Jun 22, 2018
docs Fix prediagnostics to properly detect nitro, update dependent modules… Jun 4, 2019
ec2rlcore Fix typo in comment Jun 4, 2019
example_configs Add example remediation oriented configuration files. Jul 17, 2018
example_modules Add alami2 to relevant modules, update conditionals to support alami2… Feb 13, 2018
lib Add requests license. Jul 23, 2018
mod.d Fix YAML document start. Jun 28, 2019
post.d Bump copyright year to 2018. Feb 4, 2018
pre.d Bump copyright year to 2018. Feb 4, 2018
rpmbuild Bump version to 1.1.5. Dec 12, 2018
ssmdocs Update SSM example docs to accommodate the ec2rl directory including … Feb 21, 2018
test Refactor IMDS document unit tests to have less duplication. (#52) Jun 11, 2019
tools Add check the ensure tcp_tw_recycle is applicable to the running kernel. May 1, 2018
.coveragerc Add 1.0.0 release. Jul 18, 2017
.travis.yml Add travis-ci and SonarCloud to the project. Oct 16, 2017
CHANGELOG.md adding support for bcc mysqldqslower tool (#54) Jun 25, 2019
LICENSE Add 1.0.0 release. Jul 18, 2017
Makefile Update version in Makefile to 1.1.5. Dec 13, 2018
NOTICE Bump copyright year to 2018. Feb 4, 2018
README.md Fix a couple typos/omissions. Nov 13, 2018
buildspec.yml Source the make args from the environment. Jun 26, 2018
ec2rl Use the a bundled version of Python if present. Jul 31, 2018
ec2rl.py Refactor subcommand return values to represent execution success/fail… Apr 17, 2018
functions.bash Bump copyright year to 2018. Feb 4, 2018
github-sonar.properties Add travis-ci and SonarCloud to the project. Oct 16, 2017
make_bin_modules.py Bump copyright year to 2018. Feb 4, 2018
make_symlinks.py Prefer os.path.join for path creation. Apr 15, 2018
requirements.txt Add 1.0.0 release. Jul 18, 2017
requirements_build_bin.txt Add 1.0.0 release. Jul 18, 2017
requirements_test.txt Add maximum responses version. Nov 13, 2018

README.md

Gitter chat Build Status

Amazon Elastic Compute Cloud (EC2) Rescue for Linux

What is it?

Amazon Elastic Compute Cloud (EC2) Rescue for Linux (ec2rl) is a framework for executing diagnostic and troubleshooting modules to analyze and remediate issues on Linux instances on AWS.

The Latest Version

Builds

Two builds of the latest version are provided:

  1. The standard build only includes the EC2 Rescue for Linux code and requires the system meet the Prerequisites.
  2. The bundled build includes a minimal copy of Python. It is intended for use on systems that do not meet the Python version prerequisite. Please see the FAQ for limitations associated with this build.

Downloads

Build Download sha256 hash GPG signature
Standard Link Link Link
Bundled Link Link Link

Our GPG public key can be downloaded from here.

Integrity Verification

File integrity can be verified in two ways. The examples below demonstrate verifying the standard build.

sha256 hash

Example:

[ec2-user@localhost ~]$ wget -q https://s3.amazonaws.com/ec2rescuelinux/ec2rl.tgz.sha256
[ec2-user@localhost ~]$ sha256sum -c ec2rl.tgz.sha256
ec2rl.tgz: OK

Detached GPG signature with GPG public key

Example:

[ec2-user@localhost ~]$ wget -q https://s3.amazonaws.com/ec2rescuelinux/ec2rl.tgz.sig
[ec2-user@localhost ~]$ wget -q https://s3.amazonaws.com/ec2rescuelinux/ec2rl.key
[ec2-user@localhost ~]$ gpg2 --import ec2rl.key
[ec2-user@localhost ~]$ gpg2 --verify ec2rl.tgz.sig
...
gpg: Good signature from "ec2autodiag@amazon.com <EC2 Rescue for Linux>"
...

Documentation

Available in docs/ subdirectory

Prerequisites

Python 2.7.9+ / 3.2+

Installation

No ec2rl specific installation required. Unpack the tarball and run the tool.

Usage

ec2rl:  A framework for executing diagnostic and troubleshooting
        modules for analyzing issues on Linux instances on AWS.

USAGE:
    ec2rl [subcommand] [parameters]

COMMANDS:
  The following are the accepted subcommands:
    menu-config    - use a text-based menu system to create a configuration file, configuration.cfg
    save-config    - use the provided arguments to create a configuration file, configuration.cfg
    run            - executes modules
    list           - list available modules for platform
    upload         - upload a tarball of a directory to S3 using either a presigned URL or an AWS-support provided URL
    help           - print long help
    version        - print version and license information
    version-check  - check program version against the latest upstream version
    software-check - check for software required by modules that is not installed on the system and give install details
    bug-report     - print version information relevant for inclusion in a bug report

Additional usage information is available in the usage guide in docs/USAGE.md and the help subcommand output.

Examples

ec2rl can be run with no options or special configuration.

ec2rl run

Some modules require sudo/root. Utilizing sudo is required in order to run these modules if executing ec2rl as a regular user.

sudo ec2rl run

Some modules require arguments for their usage. For example, most performance metric collection modules require times (number of samples to take) and period (length of sample).

sudo ec2rl run --times=3 --period=5

Some modules may negatively impact system performance. These modules require the perfimpact argument to run.

sudo ec2rl run --times=3 --period=5 --perfimpact=true

Some modules detect an issue and can also remediate the issue. These modules require the remediate argument to perform the remediation actions.

sudo ec2rl run --remediate

Module Development

Modules are YAML files containing either a BASH or a Python script as well as the necessary metadata. Examples are available in mod.d and the module development guide found in docs/MODULE.md

FAQ

Why does EC2 Rescue For Linux not have the ability to run and upload in a single command?

It is recommended the resulting data be reviewed prior to being uploaded in order to ensure that no confidential information is included.

Why does EC2 Rescue For Linux require Python 2.7.9+? What about Python 2.7.x, x < 9?

SSL SNI (Server Name Indication) is required for the ec2rl's upload functionality, however, this wasn't added to Python 2.7 until 2.7.9. See PEP 466 for more information regarding the SSL changes in Python 2.7.9.

What are the limitations of the bundled build?

SSL and curses functionality may not work depending upon the versions of these libraries on the system. This impacts three subcommands:

  1. The "menu-config" subcommand may not function.
  2. The "upload" subcommand may not function.
  3. The "version-check" subcommand may not function.

I'm trying to use the menu on a system running SUSE, but it does not work.

Python's curses module is normally built into its standard library, however, it is sometimes separated and included as a separate package. You will need to install it with the operating system's package manager. The package name in SUSE Linux Enterprise Server 12 is "python-curses".

Licensing

Please see the file called LICENSE.

You can’t perform that action at this time.