Skip to content

exceptionless/Exceptionless

Repository files navigation

Exceptionless Exceptionless

Build Discord

The definition of the word exceptionless is: to be without exception. Exceptionless provides real-time error reporting for your JavaScript, Node, .NET Core, ASP.NET, Web API, WebForms, WPF, Console, and MVC apps. It organizes the gathered information into simple actionable data that will help your app become exceptionless!

⭐️ We appreciate your star, it helps!

Using Exceptionless

Refer to the Exceptionless documentation.

Hosting Options

We provide very reasonably priced hosting at Exceptionless. By using our hosted service, you are supporting the project and helping it get better! We also provide set up and support services.

Exceptionless can easily be run locally using Docker:

  • docker run --rm -it -p 5200:8080 exceptionless/exceptionless:latest
  • Open http://localhost:5200
  • Create an account. The first account in the system will automatically be an admin.

This will run a completely self-contained simple instance of Exceptionless. It is only suitable for testing purposes since it will not persist data. For more complete setups, check out the self hosting documentation. Also, if you want to support the project while self hosting you can send us a pull request or donation.

Contributing

In appreciation for anyone who submits a non-trivial pull request, we will give you a free Exceptionless paid plan for a year. After your pull request is accepted, simply send an email to team@exceptionless.io with the name of your organization and we will upgrade you to a paid plan.

  • Please read the contributing document
  • Requirements
  • Visual Studio Code
    • Open Visual Studio Code and then open the Exceptionless root folder
    • Go to the Terminal menu and select Run Task... and then select Start Elasticsearch (you can stop the service when you are done using the Stop Elasticsearch task)
    • Go to the Debug menu and select the Web launch configuration then click the Start Debugging button
    • A browser window should be automatically opened to https://localhost:5100/
    • When running locally in Development mode, a global administrator user test@localhost is automatically created with password tester. You can also click the Signup button to create a new account
  • Visual Studio
    • Open Visual Studio and then open the Exceptionless.sln solution in the root folder
    • Start Elasticsearch by either configuring multiple startup projects for the docker-compose and Exceptionless.Web projects or by running the start-services.ps1 script in the root folder
    • Run the Exceptionless.Web project
    • A browser window should be automatically opened to https://localhost:5100/
    • When running locally in Development mode, a global administrator user test@localhost is automatically created with password tester. You can also click the Signup button to create a new account

image

UI Only Development

The UI is a SPA application that runs against the Exceptionless API. The source is located in the src/Exceptionless.Web/ClientApp folder. The UI will automatically be started when running the whole project, but if you want to work on just the UI, then open Visual Studio Code to the src/Exceptionless.Web/ClientApp folder and run the npm run serve (use exceptionless api) task to start the UI pointing at the official Exceptionless API. You will need to login to your actual Exceptionless account.

API Only Development

You can work on just the API without running the SPA UI by selecting the Exceptionless API launch configuration in Visual Studio. You can then run requests using the exceptionless.http file. Make sure that you have the REST Client extension installed.

Thanks

Thanks to all the people who have contributed!

contributors

Thanks to JetBrains for a community WebStorm and ReSharper license to use on this project. It's the best JavaScript IDE/Visual Studio productivity enhancement hands down.

Thanks to Red Gate for providing an open source license for a .NET Developer Bundle. It's an indispensable tool when you need to track down a performance/memory issue.