Skip to content

Commit

Permalink
doc: add information for enabling debug option (#182)
Browse files Browse the repository at this point in the history
To facilitate devlopment on the project, documenting a way to have a
better output & understanding of the way it works seemed important.
Despite the fact that those options aren't available via
cloudformation/terraform it is now more obvious how to use it.
  • Loading branch information
xlr-8 authored and cristim committed Dec 6, 2017
1 parent 2c9e019 commit ed177f7
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions START.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
* [Testing configuration](#testing-configuration)
* [Running configuration](#running-configuration)
* [Minimum on-demand configuration](#minimum-on-demand-configuration)
* [Debug autospotting](#debug-autospotting)
* [Updates and Downgrades](#updates-and-downgrades)
* [Compatibility notices](#compatibility-notices)
* [Uninstallation](#uninstallation)
Expand Down Expand Up @@ -276,6 +277,21 @@ still understand that you want 0 instances, because `0.16 * 3` is equal to
one instance (`0.17 * 3 = 0.51`). All in all it should work as you expect, but
this was just to explain some more the functionning of the percentage's math.

### Debug autospotting ###

In certain situations you might want to add verbosity to the project in order
to understand a bit better what its doing. If you want to do so please run it
with the following environment variable `AUTOSPOTTING_DEBUG`.

You can do it locally with some custom binary:
```bash
AUTOSPOTTING_DEBUG=true ./autospotting
```

Or you can do it via the Lambda console under the `Environment variables`
section. Please note those variables aren't exposed via Cloudformation nor via
terraform.

## Updates and Downgrades ##

The software doesn't auto-update anymore(it used to in the first few versions),
Expand Down

0 comments on commit ed177f7

Please sign in to comment.