Code Monkey home page Code Monkey logo

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

faultline's Projects

faultline icon faultline

Error tracking tool on AWS managed services.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.