JavaScript HTML
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
.serverless_plugins
docs
src
.coveralls.yml
.editorconfig
.gitignore
.travis.yml
README.md
config.default.yml
docker-compose.yml
jdoc.template.md.erb
package.json
sample-errors.json
schema.json
serverless.yml

README.md

faultline Build Status GitHub release Coverage Status

Error tracking tool on AWS managed services.

logo

Migration Guide: from v0.x to v1.x

Table of Contents

Concept

Using framework

  • Serverless Framework ⚡️

AWS Resources

  • AWS Lambda
  • API Gateway
  • Amazon S3
  • Amazon DynamoDB
  • IAM
  • KMS (option)

How to deploy

:octocat: STEP 1. Clone

$ git clone https://github.com/faultline/faultline.git
$ cd faultline
$ npm install

📝 STEP 2. Set environment variables OR Edit config.yml

Set environment variables.

OR

Copy config.default.yml to config.yml. And edit.

Environment / config.yml Document is here 📖 .

🚀 STEP 3. Deploy to AWS

$ AWS_PROFILE=XXxxXXX npm run deploy

💣 Destroy faultline

  1. Delete all projects (or Empty S3 bucket).
  2. Run following command.
$ AWS_PROFILE=XXxxXXX npm run destroy

Usage

POST errors using cURL

Example:

$ curl -X POST -H "x-api-key: xxxxXXXXXxXxXXxxXXXXXXXxxxxXXXXXX" -H "Content-Type: application/json" -d @sample-errors.json https://xxxxxxxxx.execute-api.ap-northeast-1.amazonaws.com/v0/projects/sample-project/errors

Sample errors POST JSON file is here.

API Document is here 📖 .

POST errors using library

Notifications

When receive error, faultline can send nofitications with POST config.

More document is here 📖 .

💬 Slack

slack

:octocat: GitHub issue

GitHub

🔶 GitLab issue

GitLab

API

API Document generated by jdoc.

JSON Hyper-Schema is here 📖 .

Web UI

Sample web UI for faultline

https://github.com/faultline/faultline-webui

Web UI

Architecture

"Architecture of faultline" document is here 📖 .

Run test

$ docker-compose up -d
$ npm run test

Docker for Mac

$ TMPDIR=/private$TMPDIR docker-compose up -d
$ npm run test

Contribute

PRs accepted.

License

MIT © Ken'ichiro Oyama