NOTE: This repo contains only the documentation for the private BoltsOps Pro repo code. Original file: https://github.com/boltopspro/up/blob/master/README.md The docs are publish so they are available for interested customers. For access to the source code, you must be a paying BoltOps Pro subscriber. If are interested, you can contact us at email@example.com or https://www.boltops.com
up command checks if services are up and running and reports CloudWatch custom metrics. It's a companion tool that is used by the UpCheck Blueprint.
- Metric Names: 1) HealthCheckStatus and 2) ResponseTime
- Useful to run this script within the network to check internal applications that cannot be pinged from the outside world.
- Tool reads a
up.ymlfile in the current directory by default.
The tool looks for a configuration file in these locations:
- up.yml - current directory
- config/up.yml - current directory
- ~/.up.yml - home directory (note the dot)
The up.yml looks like this:
--- - name: demo-web-1 url: http://external-site.com/health/check/path - name: demo-web-2 url: http://internal-site.private
Some of the tool's settings can be controlled with environmental variables:
|Env Var||Description||Default Value|
|UP_CLOUDWATCH_DIMENSION_NAME||CloudWatch metric dimension name||App|
|UP_CLOUDWATCH_DIMENSION_VALUE||CloudWatch metric dimension value||site name from
|UP_CLOUDWATCH_ENABLED||Enables sending of the data to CloudWatch.||(unset) Defaults to enabled on AWS Lambda and disabled when not on Lambda.|
|UP_CLOUDWATCH_NAMESPACE||CloudWatch metric namespace||UpCheck|
|UP_MAX_THREADS||Max number of threads||200|