- Getting Started
- Managing Stacks
- Manual Stacking
- Filtering & Searching
- Bulk Actions
- Project Settings
- Reference Ids
- User Sessions
- Log Levels
- Event De-Duplication
- API Usage
- Custom Exceptionless Clients
- .NET Client
- Self Hosting
Custom Exceptionless Clients
This guide will focus on the concepts necessary to successfully implement your custom client. Building a client in Exceptionless requires three main things:
- Understanding of the data models
- Usage of the correct API endpoints
One of the key things to understand when creating a custom client (or when using the Exceptionless API) is the security implications of the API token generated and used. Exceptionless has two types of API tokens:
Think of a user-scoped key as the master key for that particular user. It allows for EVERYTHING. This includes password resets, deleting organizations, deleting users, and more. This is not the type of key you want to generate with your custom client. You also don't want to manually generate and use these types of keys within your client.
Instead, you should use a client-scoped key. A client-scoped key only has access to very specific endpoints and provides a significantly increased level of security compared to using a user-scoped key.
In the Exceptionless UI, you can create a project API key by going to a project's settings page. To do so, click on the project dropdown in the top-menu, hover over the project's name, and then click the gear icon. On the settings page, you'll see an API Keys tab. Click that and you can generate a new client-scoped key.
This is the key that will need to be passed into the configuration settings of your custom client.
Understanding the Data Models #
Exceptionless is designed to be as flexible as possible. In fact, you can send in almost any data you want with an event. We will display some pieces of data better than others, and if you make use of well-known keys, we can use those to make sure your events are stacked properly and displayed in a usable way within your dashboard.
However, before you can begin to throw any and everything at Exceptionless, it's important to understand the basic structure of an event. Let's take a look at the event model:
"source": "code.js line 655",
"message": "some event message",
"geo": "stringified lat and long values separated by a comma",
"tags": ["string", "string", "string"],
Let's take each of these properties and explain them one-by-one.
The type property is an important one because it tells Exceptionless how to treat your event. Remember that Exceptionless is not just for errors. If you look at your Dashboard, you'll see categories like Exceptions, Logs, and Feature Usage. We group events into these categories for you based on the
type value you pass in.
You can pass in any type value you'd like as long as it is a string value. However, we recommend the following type values:
These values are pretty self-explanatory. If you have an error, use the
error value, if you are logging an event, use
log, and so on and so forth.
The source value should be a string representing where the error happened in your code. This usually comes from the error object in whatever programming language you are writing in. This should be a string value representing the error location.
The reference id is an identifier you can pass in in order to use later. For example, if you know that you will have other events that reference this one, you can make use of the reference identifier you pass in. This identifier can be any unique string value. UUID is good option here, but as long as the value is unique, you'll be good to go.
The message can mean different things depending on the type of event you're passing through. If it's an error event, you may want to pick off the error message from the error object you receive, or you may want to create a custom error message. For a log event, you can simply pass in whatever message makes sense for the event.
Whatever message you send through, just make sure it is a string value.
If you are capturing ip information, you may have location-based information. If so, and if you want to capture that alongside your events, you can pass that as a value for the
geo property. This needs to be a string value, so you should pass in the longitude followed by a comma then the latitude.
The value property is an open-ended integer field that allows you capture additional information about your events. This could be number of ice cream scoops served before the event happened, it could be number of dogs walked, or any other arbitrary piece of information.
The tags property is a string array of values you want to use to categorize your events. We have some built-in understanding of how certain tags should work. For example, events with a "critical" tag will be labels and handled as such in the interface.
The tags array takes string values only, and all tags will be visibile on the event details page.
This is the most flexible of the properties that you send into Exceptionless. It is a dictionary object containing key/value pairs of any bits of information you want. That said, there are some know keys that will help Exceptionless better display information in this data dictionary:
@error - this indicates to Exceptionless that the event is an error. We will handle the event as such.
@simple_error - this, like @error, indicates that the event is in an error. However, a simple error is less complex and the event object itself fits more neatly into what we've defined here so far.
@request - Events from a web server will have a request object. Here is an example of how this data should be formed.
@environment - This would be a string environment about your user's environment. Here is an example of how that model should be formed.
@user - This is an object that can contain the following:
identity: string value,
name: string value,
data: any value.
@user_description - This is an object that can contain the following:
email_address: string value,
description: string value,
data: any value.
@level - This is designed for log events to represent the log level. It can also be used to prevent logs from being captured depending on your log level settings in Exceptionless.
@submission_method - Many apps have both global event listeners and specific areas where an event can be captured manually or ad hoc. To separate the submission methods of events, you can pass in whether an event was captured in a global listener, ad hoc, or however you want to describe the capturing of the event.
@stack - This is the stringified error stack for an exception.
When providing data to the Exceptionless server, there are specific data models dependent on the information you're trying to provide. We'll cover those models here.
Using the API #
When building your custom client, the consumers of your client will be calling methods you create, but you, of course, will be wiring up those methods to reach out to the Exceptionless API. The API is well-documented with auto-generating docs for each endpoint. To get started, you can take a look at our API Usage docs here.
Wrapping Up #
A custom client gives you full flexibility. While the two clients provided by Exceptionless do all of the above work for you, extending them would require forking the code. If you want extended capabilities or client support for additional programming languages, building a custom client might be the right move for you.
We can't way to see what you build.