{"id":13820323,"url":"https://github.com/faultline/faultline","last_synced_at":"2026-01-29T06:14:42.663Z","repository":{"id":66825358,"uuid":"67488466","full_name":"faultline/faultline","owner":"faultline","description":"Error tracking tool on AWS managed services.","archived":false,"fork":false,"pushed_at":"2022-08-31T00:16:04.000Z","size":2284,"stargazers_count":103,"open_issues_count":0,"forks_count":7,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-11-19T19:44:16.818Z","etag":null,"topics":["aws-lambda","crash-reporting","error-monitoring","github","gitlab","notifications","serverless","slack"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/faultline.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-09-06T08:20:16.000Z","updated_at":"2024-07-07T05:26:53.000Z","dependencies_parsed_at":"2024-01-13T16:22:50.427Z","dependency_job_id":"5a13c592-664d-492d-b6de-d4d8c8cda0b7","html_url":"https://github.com/faultline/faultline","commit_stats":null,"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faultline%2Ffaultline","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faultline%2Ffaultline/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faultline%2Ffaultline/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faultline%2Ffaultline/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/faultline","download_url":"https://codeload.github.com/faultline/faultline/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254488779,"owners_count":22079493,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws-lambda","crash-reporting","error-monitoring","github","gitlab","notifications","serverless","slack"],"created_at":"2024-08-04T08:01:01.431Z","updated_at":"2026-01-29T06:14:42.619Z","avatar_url":"https://github.com/faultline.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# faultline [![Build Status](https://travis-ci.org/faultline/faultline.svg?branch=master)](https://travis-ci.org/faultline/faultline) [![GitHub release](https://img.shields.io/github/release/faultline/faultline.svg)](https://github.com/faultline/faultline/releases) [![Coverage Status](https://coveralls.io/repos/github/faultline/faultline/badge.svg?branch=master)](https://coveralls.io/github/faultline/faultline?branch=master)\n\n\u003e Error tracking tool on AWS managed services.\n\n![logo](https://faultline.github.io/faultline/faultline.png)\n\n[Migration Guide: from v0.x to v1.x](docs/migration_v0_to_v1.md)\n\n## Table of Contents\n\n- [Concept](#concept)\n- [Using framework](#using-framework)\n- [How to deploy](#how-to-deploy)\n- [Usage](#usage)\n    - [Notifications](#notifications)\n- [API](#api)\n- [Web UI](#web-ui)\n- [Architecture](#architecture)\n- [Run test](#run-test)\n- [Contribute](#contribute)\n- [License](#license)\n\n## Concept\n\n- Simple deploy\n- Manageless\n- POST errors with config\n- Between \"Only mail notify\" and \"[Error tracking services](https://www.google.co.jp/search?q=error%20tracking%20service)\"\n\n## Using framework\n\n- Serverless Framework :zap:\n\n### AWS Resources\n\n- AWS Lambda\n- API Gateway\n- Amazon S3\n- Amazon DynamoDB\n- IAM\n- KMS (option)\n\n## How to deploy\n\n### :octocat: STEP 1. Clone\n\n```sh\n$ git clone https://github.com/faultline/faultline.git\n$ cd faultline\n$ npm install\n```\n\n### :pencil: STEP 2. Set environment variables OR Edit config.yml\n\nSet environment variables.\n\nOR\n\nCopy [`config.default.yml`](config.default.yml) to `config.yml`. And edit.\n\nEnvironment / config.yml Document is [here](docs/env.md) :book: .\n\n### :rocket: STEP 3. Deploy to AWS\n\n```sh\n$ AWS_PROFILE=XXxxXXX npm run deploy\n```\n\n#### :bomb: Destroy faultline\n\n1. Delete all projects (or Empty S3 bucket).\n2. Run following command.\n\n```sh\n$ AWS_PROFILE=XXxxXXX npm run destroy\n```\n\n## Usage\n\n### POST errors using cURL\n\nExample:\n\n```sh\n$ 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\n```\n\nSample errors POST JSON file is [here](sample-errors.json).\n\nAPI Document is [here](docs/api.md) :book: .\n\n### POST errors using library\n\n- https://github.com/faultline/faultline-php\n- https://github.com/faultline/faultline-js\n- https://github.com/faultline/faultline-ruby\n- https://github.com/faultline/faultline-rack\n\n### Notifications\n\nWhen receive error, faultline can send nofitications with POST config.\n\nMore document is [here](docs/notifications.md) :book: .\n\n#### :speech_balloon: Slack\n\n![slack](docs/slack.png)\n\n#### :octocat: GitHub issue\n\n![GitHub](docs/github.png)\n\n#### :large_orange_diamond: GitLab issue\n\n![GitLab](docs/gitlab.png)\n\n## API\n\n[API Document](docs/api.md) generated by [jdoc](https://github.com/r7kamura/jdoc).\n\nJSON Hyper-Schema is [here](schema.json) :book: .\n\n## Web UI\n\nSample web UI for faultline\n\nhttps://github.com/faultline/faultline-webui\n\n![Web UI](docs/webui.png)\n\n## Architecture\n\n\"Architecture of faultline\" document is [here](docs/architecture.md) :book: .\n\n## Run test\n\n``` sh\n$ docker-compose up -d\n$ npm run test\n```\n\n### Docker for Mac\n\n``` sh\n$ TMPDIR=/private$TMPDIR docker-compose up -d\n$ npm run test\n```\n\n## Contribute\n\nPRs accepted.\n\n## License\n\nMIT © Ken\u0026#39;ichiro Oyama\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffaultline%2Ffaultline","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffaultline%2Ffaultline","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffaultline%2Ffaultline/lists"}