{"id":15415912,"url":"https://github.com/tombruijn/appsignal-elixir_js_plug","last_synced_at":"2025-04-19T14:23:33.847Z","repository":{"id":57478959,"uuid":"103755949","full_name":"tombruijn/appsignal-elixir_js_plug","owner":"tombruijn","description":"A plug for sending JavaScript errors to AppSignal","archived":false,"fork":false,"pushed_at":"2019-10-28T14:46:26.000Z","size":32,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-11T15:04:36.783Z","etag":null,"topics":["appsignal","elixir","error-monitoring","front-end","javascript","phoenix","plug"],"latest_commit_sha":null,"homepage":"https://docs.appsignal.com/front-end/error-handling.html","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tombruijn.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-16T13:58:21.000Z","updated_at":"2019-10-28T14:46:27.000Z","dependencies_parsed_at":"2022-09-17T04:41:57.572Z","dependency_job_id":null,"html_url":"https://github.com/tombruijn/appsignal-elixir_js_plug","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tombruijn%2Fappsignal-elixir_js_plug","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tombruijn%2Fappsignal-elixir_js_plug/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tombruijn%2Fappsignal-elixir_js_plug/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tombruijn%2Fappsignal-elixir_js_plug/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tombruijn","download_url":"https://codeload.github.com/tombruijn/appsignal-elixir_js_plug/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249711715,"owners_count":21314292,"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":["appsignal","elixir","error-monitoring","front-end","javascript","phoenix","plug"],"created_at":"2024-10-01T17:10:11.671Z","updated_at":"2025-04-19T14:23:33.815Z","avatar_url":"https://github.com/tombruijn.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AppSignal for Elixir JavaScript Plug\n\n\u003e ⚠️ This Plug is deprecated. Please use the official [AppSignal JavaScript front-end integration](https://appsignal.com/javascript/) instead.\n\nA plug for sending JavaScript errors to AppSignal. Works for Phoenix and\nPlug-only apps.\n\n**Note:** This is not an official AppSignal package. It's is not supported by\nAppSignal. Use at your own risk.\n\n- [AppSignal.com website](https://appsignal.com/)\n- [AppSignal for Elixir documentation](http://docs.appsignal.com/elixir/)\n- ~AppSignal for [Front-end error handling] (Beta) documentation~ Replaced with new JavaScript front-end integration.\n\n## Usage\n\nAdd the following parser to your endpoint.ex file.\n\n```elixir\nplug Plug.Parsers,\n  parsers: [:urlencoded, :multipart, :json],\n  pass: [\"*/*\"],\n  json_decoder: Poison\n\nplug Appsignal.JSPlug # Above your app's router plug\nplug MyExampleApp.Router\n```\n\nNow send the errors with a POST request to the `/appsignal_error_catcher`\nendpoint. An example JavaScript is provided on the AppSignal docs website in\nthe [Front-end error handling] section.\n\nFor more information see the AppSignal [Front-end error handling] Beta docs.\n\n## Installation\n\nMake sure to install the [AppSignal for Elixir] package first by following the\n[installation guide].\n\nAfter having successfully installed AppSignal add `appsignal_js_plug` to your\nlist of dependencies in `mix.exs`.\n\n```elixir\n# mix.exs\ndef deps do\n  [\n    {:appsignal, \"\u003e= 1.3.0\"},\n    {:appsignal_js_plug, \"~\u003e 0.2\"}\n  ]\nend\n```\n\nThen run `mix deps.get`.\n\n## Configuration\n\n### `filter_parameters`\n\nThis package listens to the AppSignal for Elixir [`filter_parameters`\nconfiguration option]. If this option is set, all parameters values matching a\nkey name from the configuration will be replaced with `[FILTERED]`.\n\n```elixir\n# config/appsignal.exs\nconfig :appsignal, :config, filter_parameters: [\"password\"]\n```\n\n### `skip_session_data`\n\nThis package listens to the AppSignal for Elixir [`skip_session_data`\nconfiguration option]. If this option is set to `true`, no session data will be\nadded to the JavaScript errors.\n\n```elixir\n# config/appsignal.exs\nconfig :appsignal, :config, skip_session_data: true\n```\n\n## Development\n\n### Testing\n\nPackage testing is done with ExUnit and can be run with the `mix test` command.\nYou can also supply a path to a specific file path you want to test and even a\nspecific line on which the test you want to run is defined.\n\n```sh\nmix deps.get\nmix test\nmix test test/appsignal/some_test.ex:123\n```\n\n### Publishing new versions\n\n1. Merge the `develop` branch to `master` if necessary.\n2. Update the version number in `mix.exs`, e.g. `1.2.3`\n3. Commit the change.\n4. Tag the commit with the version number: `git tag 1.2.3`\n5. Push the changes: `git push origin master 1.2.3`\n6. Publish the package: `mix hex.publish`\n\n## License\n\nThe AppSignal for Elixir JavaScript Plug package source code is released under\nthe MIT License. Check the [LICENSE](LICENSE) file for more information.\n\n[AppSignal for Elixir]: https://github.com/appsignal/appsignal-elixir\n[installation guide]: https://docs.appsignal.com/elixir/installation.html\n[Front-end error handling]: https://docs.appsignal.com/front-end/error-handling.html\n[`skip_session_data` configuration option]: https://docs.appsignal.com/elixir/configuration/options.html#appsignal_skip_session_data-skip_session_data\n[`filter_parameters` configuration option]: https://docs.appsignal.com/elixir/configuration/parameter-filtering.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftombruijn%2Fappsignal-elixir_js_plug","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftombruijn%2Fappsignal-elixir_js_plug","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftombruijn%2Fappsignal-elixir_js_plug/lists"}