Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simonw/datasette-scale-to-zero
Quit Datasette if it has not received traffic for a specified time period
https://github.com/simonw/datasette-scale-to-zero
datasette datasette-plugin
Last synced: 3 months ago
JSON representation
Quit Datasette if it has not received traffic for a specified time period
- Host: GitHub
- URL: https://github.com/simonw/datasette-scale-to-zero
- Owner: simonw
- License: apache-2.0
- Created: 2022-06-21T22:49:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-29T21:23:49.000Z (10 months ago)
- Last Synced: 2024-10-07T13:53:47.772Z (3 months ago)
- Topics: datasette, datasette-plugin
- Language: Python
- Homepage: https://datasette.io/plugins/datasette-scale-to-zero
- Size: 31.3 KB
- Stars: 16
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# datasette-scale-to-zero
[](https://pypi.org/project/datasette-scale-to-zero/)
[](https://github.com/simonw/datasette-scale-to-zero/releases)
[](https://github.com/simonw/datasette-scale-to-zero/actions?query=workflow%3ATest)
[](https://github.com/simonw/datasette-scale-to-zero/blob/main/LICENSE)
Quit Datasette if it has not received traffic for a specified time period
Some hosting providers such as [Fly](https://fly.io/) 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:
```json
{
"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"`:
```json
{
"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:
```json
{
"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.
## Configuring a shutdown HTTP message
You can also configure the plugin to send an HTTP request somewhere right before it quits, using the `"shutdown_url"` option:
```json
{
"plugins": {
"datasette-scale-to-zero": {
"duration": "10m",
"shutdown_url": "https://example.com/shutdown"
}
}
}
```
You can add additional headers to the GET request - for example to send Authorization headers - using `"shutdown_headers"`:
```json
{
"plugins": {
"datasette-scale-to-zero": {
"duration": "10m",
"shutdown_url": "https://example.com/shutdown",
"shutdown_headers": {
"Authorization": "Bearer secret"
}
}
}
}
```
Use `"shutdown_method"` to set a different HTTP method, e.g. for `POST`. You can also set `shutdown_body` to specify the body that should be sent with the request:
```json
{
"plugins": {
"datasette-scale-to-zero": {
"duration": "10m",
"shutdown_url": "https://example.com/shutdown",
"shutdown_method": "POST",
"shutdown_headers": {
"Authorization": "Bearer secret",
"Content-Type": "application/json"
},
"shutdown_body": "{\"message\": \"shutting down\"}"
}
}
}
```
## 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