Skip to main content

Quit Datasette if it has not received traffic for a specified time period

Project description

datasette-scale-to-zero

PyPI Changelog Tests License

Quit Datasette if it has not received traffic for a specified time period

Some hosting providers such as Fly offer a scale to zero mechanism, where servers can shut down and will be automatically started when new traffic arrives.

This plugin can be used to configure Datasette to quit X minutes (or seconds, or hours) after the last request it received. It can also cause the Datasette server to exit after a configured maximum time whether or not it is receiving traffic.

Installation

Install this plugin in the same environment as Datasette.

datasette install datasette-scale-to-zero

Configuration

This plugin will only take effect if it has been configured.

Add the following to your metadata.json or metadata.yml configuration file:

{
    "plugins": {
        "datasette-scale-to-zero": {
            "duration": "10m"
        }
    }
}

This will cause Datasette to quit if it has not received any HTTP traffic for 10 minutes.

You can set this value using a suffix of m for minutes, h for hours or s for seconds.

To cause Datasette to exit if the server has been running for longer than a specific time, use "max-age":

{
    "plugins": {
        "datasette-scale-to-zero": {
            "max-age": "10h"
        }
    }
}

This example will exit the Datasette server if it has been running for more than ten hours.

You can use "duration" and "max-age" together in the same configuration file:

{
    "plugins": {
        "datasette-scale-to-zero": {
            "max-age": "10h",
            "duration": "5m"
        }
    }
}

This example will quit if no traffic has been received in five minutes, or if the server has been running for ten hours.

Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:

cd datasette-scale-to-zero
python3 -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

pytest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

datasette-scale-to-zero-0.2.tar.gz (7.3 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page