tombruijn / appsignal-elixir_js_plug

A plug for sending JavaScript errors to AppSignal

AppSignal for Elixir JavaScript Plug

⚠️ This Plug is deprecated. Please use the official AppSignal JavaScript front-end integration instead.

A plug for sending JavaScript errors to AppSignal. Works for Phoenix and Plug-only apps.

Note: This is not an official AppSignal package. It's is not supported by AppSignal. Use at your own risk.

• AppSignal.com website
• AppSignal for Elixir documentation
• AppSignal for Front-end error handling (Beta) documentation Replaced with new JavaScript front-end integration.

Usage

Add the following parser to your endpoint.ex file.

plug Plug.Parsers,
  parsers: [:urlencoded, :multipart, :json],
  pass: ["*/*"],
  json_decoder: Poison

plug Appsignal.JSPlug # Above your app's router plug
plug MyExampleApp.Router

Now send the errors with a POST request to the /appsignal_error_catcher endpoint. An example JavaScript is provided on the AppSignal docs website in the Front-end error handling section.

For more information see the AppSignal Front-end error handling Beta docs.

Installation

Make sure to install the AppSignal for Elixir package first by following the installation guide.

After having successfully installed AppSignal add appsignal_js_plug to your list of dependencies in mix.exs.

# mix.exs
def deps do
  [
    {:appsignal, ">= 1.3.0"},
    {:appsignal_js_plug, "~> 0.2"}
  ]
end

Then run mix deps.get.

Configuration

filter_parameters

This package listens to the AppSignal for Elixir filter_parameters configuration option. If this option is set, all parameters values matching a key name from the configuration will be replaced with [FILTERED].

# config/appsignal.exs
config :appsignal, :config, filter_parameters: ["password"]

skip_session_data

This package listens to the AppSignal for Elixir skip_session_data configuration option. If this option is set to true, no session data will be added to the JavaScript errors.

# config/appsignal.exs
config :appsignal, :config, skip_session_data: true

Development

Testing

Package testing is done with ExUnit and can be run with the mix test command. You can also supply a path to a specific file path you want to test and even a specific line on which the test you want to run is defined.

mix deps.get
mix test
mix test test/appsignal/some_test.ex:123

Publishing new versions

1. Merge the develop branch to master if necessary.
2. Update the version number in mix.exs, e.g. 1.2.3
3. Commit the change.
4. Tag the commit with the version number: git tag 1.2.3
5. Push the changes: git push origin master 1.2.3
6. Publish the package: mix hex.publish

License

The AppSignal for Elixir JavaScript Plug package source code is released under the MIT License. Check the LICENSE file for more information.

appsignal-elixir_js_plug's Issues

IE11 "(no backtrace error)" issue

First of all, thanks for the library.

The plug sometimes throws an error when handling IE11 errors. Here is the elixir error I'm getting:

Protocol.UndefinedError: protocol Enumerable not implemented for "(no backtrace error)". This protocol is implemented for: Ecto.Adapters.SQL.Stream, Postgrex.Stream, Floki.HTMLTree, DBConnection.PrepareStream, DBConnection.Stream, Timex.Interval, Tensor, Scrivener.Page, Range, HashDict, List, GenEvent.Stream, Map, IO.Stream, HashSet, Stream, Function, Date.Range, File.Stream, MapSet
(elixir) /elixir_1.8.0-1/lib/elixir/lib/enum.ex:1: Enumerable.impl_for!/1
(elixir) /elixir_1.8.0-1/lib/elixir/lib/enum.ex:141: Enumerable.reduce/3
(elixir) lib/enum.ex:3015: Enum.map/2
(appsignal) lib/appsignal/transaction.ex:220: Appsignal.Transaction.set_error/4
(appsignal_js_plug) lib/appsignal_js_plug.ex:63: Appsignal.JSPlug.call/2

Looks like Appsignal expects backtrace value to be an array but in this case the value is a string.

Listen for session data filtering

Session data set here:

appsignal-elixir_js_plug/lib/appsignal_js_plug.ex

Line 125 in 3e2c7a6

c.private[:plug_session]

Should be filtered like so: https://github.com/appsignal/appsignal-elixir/blob/26f21efd7e5ae4af8b9f889b4ce3c1a6c5ceedeb/lib/appsignal/transaction.ex#L416-L424

For the documentation see:
https://docs.appsignal.com/elixir/configuration/session-data-filtering.html

Listen for request header filtering

Feature added in: appsignal/appsignal-elixir#327
To be released in AppSignal for Elixir package v1.6.0.