Generate static html files with images from CloudWatch API

This projects works just as CLI command.

Templates

The template system is Jinja2. It use some variables to generate the reports.

Example template

<html>
<body>
    <div class="col-md-12">

        <em>Generated at {{ gentime }}</em>

        {% for graph in graphs %}
            <div class="row">

                <div class="col-md-12">
                    <h2>{{ graph.Title }} <small>The last {{ graph.Timeframe }} hour(s)</small></h2>


                        <img class="img-responsive" src="data:image/png;base64,{{ graph.image_base64 }}">

                        {% for m in graph.metrics %}
                        <p>
                            <span style="color: {{ m.color }};">
                                {{ m.name_dimension }} / <strong>{{ m.name }}</strong>
                            </span>
                            [<span class="text-primary">median {{ m.median }}</span>]
                            [<span class="text-warning">max {{ m.max }}</span>]
                            [<span class="text-muted">min {{ m.min }}</span>]

                            {% if m.Unit == "Count" %}
                            <blockquote>
                                Equivalent to {{ m.equivalent }} per day.
                            </blockquote>
                            {% endif %}

                        </p>
                        {% endfor %}

                </div>

            </div>
        {% endfor %}
    </div>
</body>
</html>

Parameters / CLI

dashboard.py

This is the main script.

--hours

Means: the last X hours. The software works in UTC time.

--config

Define the route to the config file. This file must be in YML format.

--file

Route of the file where we has to save the generated HTML file.

--email

The destinatin email of the dashboard. This will use the template at templates/email.html

NOTE: If there is an error, the script will not overwrite the old file

Example config file

Template:
  title: "Your cloud status"
  from: "yourname@yourcompany.com"
Credentials:
  # Credentials for CloudWatch API at AWS
  AWS_ID: 'XXXXXXXXXXXXXXXXXXXX'
  AWS_PASS: 'YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY'
  region: 'ap-northeast-2'
  # Credentials for SES service of AWS
  email:
    AWS_ID: 'XXXXXXXXXXXXXXXXXXXX'
    AWS_PASS: 'YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY'
    region: 'eu-west-1'
Graphs:
    - LoadBalancer:
        title: "External Load balancer"
        metrics:
            - metric:
                label: "Latency external load balancer"
                namespace: "AWS/ELB"
                name: "Latency"
                dimensions:
                    name: "LoadBalancerName"
                    value: "ELB-EXT"
                stadistics: "Average"
                unit: "Seconds"
                yaxis: False
            - metric:
                label: "Requests external load balancer"
                namespace: "AWS/ELB"
                name: "RequestCount"
                dimensions:
                    name: "LoadBalancerName"
                    value: "ELB-INT"
                stadistics: "Sum"
                unit: "Count"
                yaxis: True

Use with docker

Build the container. This step need some time to install and compile matplotlib.

git clone git://github.com/APSL/kumostatus.git kumostatus
cd kumostatus
sudo docker build -t kumostatus .

Now you have ready container image, and you can use in the command line:

For docker, the whole project and files are in /code, and /app is "mounted" over /home/user/kumostatus. The app can read and write just in this folder, your config YML files must be there, and the html the app will generate too.

sudo docker run --rm -v /home/user/kumostatus:/app/ kumostatus /code/dashboard.py --hours 1 --config /app/aws.yml --file /app/aws.html

Example CRON jobs

# Local python version
* * * * * python /home/user/kumostatus/dashboard.py --config="/home/user/config.yml" --hours 1 --file /var/www/status/index.html
*/2 * * * * python /home/user/kumostatus/dashboard.py --config="/home/user/config.yml" --hours 8 --file /var/www/status/last8hours.html
*/10 * * * * python /home/user/kumostatus/dashboard.py --config="/home/user/config.yml" --hours 24 --file /var/www/status/last24hours.html
*/10 * * * * python /home/user/kumostatus/dashboard.py --config="/home/user/config.yml" --hours 48 --file /var/www/status/last48hours.html
# Docker container version
* * * * * docker run --rm -v /home/user/:/app/ kumostatus /code/dashboard.py --config="config.yml" --hours 1 --file index.html
*/2 * * * * docker run --rm -v /home/user/:/app/ kumostatus /code/dashboard.py --config="config.yml" --hours 8 --file last8hours.html
*/10 * * * * docker run --rm -v /home/user/:/app/ kumostatus /code/dashboard.py --config="config.yml" --hours 24 --file last24hours.html
*/10 * * * * docker run --rm -v /home/user/:/app/ kumostatus /code/dashboard.py --config="config.yml" --hours 48 --file last48hours.html

Sent reports by email

# Local python version
0 6 * * * python /home/user/kumostatus/dashboard.py --config="/home/user/config.yml" --hours 12 --email email@example.com
0 16 * * * python /home/user/kumostatus/dashboard.py --config="/home/user/config.yml" --hours 24 --email email@example.com
# Docker container version
0 6 * * * docker run --rm -v /home/user/:/app/ kumostatus /code/dashboard.py --config="config.yml" --hours 12 --email email@example.com
0 16 * * * docker run --rm -v /home/user/:/app/ kumostatus /code/dashboard.py --config="config.yml" --hours 24 --email email@example.com

TODO

Parameter to select the jinja2 templates in the command line
Use SMTP standar protocol to send emails, at the moment only send by SES

APSL / kumostatus