Skip to content

Commit

Permalink
real-time errors
Browse files Browse the repository at this point in the history
  • Loading branch information
boristane committed Sep 20, 2023
1 parent c24a62a commit 575eaa9
Show file tree
Hide file tree
Showing 17 changed files with 83 additions and 4 deletions.
2 changes: 2 additions & 0 deletions analysing-data/baselime-ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ order: 2

# Baselime AI

---

Baselime AI provides explanations for any chart, log, event, metric or trace on Baselime. It enables you to identify patterns and anomalies in your systems, providing deeper insights into your system performance and behavior.

---
Expand Down
74 changes: 74 additions & 0 deletions analysing-data/errors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
label: Real-Time Error Tracking
order: 5
---

# Real-Time Error Tracking in Baselime


Baselime automatically tracks all errors occuring in your applications and notifies you with those that need your attention in real-time.

---

## Errors

The **Errors** page displays errors in your applications, across your services. You can filter errors by service or search using case-sensitive search.

![](../assets/images/illustrations/analyzing-data/errors/errors.png)

When you connect your cloud account to Baselime, your applications send logs, metrics, traces and wide events to Baselime. On each event, Baselime determines if it's an error. This is typically determined by:
- The log level: anything above `error` or `critical` log level
- The status of the span: every span with an error (from both OpenTelemetry and AWS X-Ray)
- If the event has a root level property `level` set to `error` or `critical`.

Baselime then computes the fingerpring of the error. The fingerprit is based on multiple variables, such as the service name, the environment, the route, the error message or cause, the serverless function name or the container id. Errors are uniquely represented and grouped by their fingerprint. If a similar error with the same fingerpring occurs, you will not get notified, the occurences counter will increase instead.

The occurences counter is refreshed after 30 days since the first occurence of the error, and you and your team will be notified again.

---

## Error status

Errors can have a status in Baselime:
- **Active**
- **Ignored**
- **Resolved**

You can change the status of any error from the [Baselime console](https://console.baselime.io). The status reflects the behaviour of the error fingerprint when the same error is occurs again in your architecture.

### Active errors

This is the default status of all errors when they are detected. When an error in **Active** state occurs, you will get notified only the first time it happens. You will not not get notified again until the fingerprint expires 30 days after the first occurence of the error. As such, if the error is not resolved within 30 days and it occurs again, you will get notified.

### Ignored errors

When an error in **Ignored** state occurs, you will not get ever. This is useful for expected errors, where they occur in your applications, but no action is required.

### Resolved errors

When an error is marked as **Resolved**, you will get notified the first time it happens again, and it will be automatically marked as **Active**. This is helpful for when you have resolved an error in your applications, but it happens again for a set of edge-cases. You will know about it as soon as it happens again.

---

## Assigning Errors

You can assign an error to any of your member of your team to facilitate error triage.

---


## Error details

The error details page gives you an overview of the error and enables you to dig deeper into the data and understand why the error occured.

It displays the first and last time the error was seen in your telemetry datam the number of occurences in the past 30 days, the cloud account the error originates from, and the dataset. From this screen it is also possible to directly change the status of an error or assign it to a member of your team.

![](../assets/images/illustrations/analyzing-data/errors/details.png)

For each error, the errors details screen also displays:
- A sample request
- A sample trace
- A sample error event
- The 30-day History of occurences

From this screen you can click on the **Investigate** button to hop into the [query builder](./queries.md) to dig deeper in the issues.
2 changes: 1 addition & 1 deletion analysing-data/home.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
label: Service Home
order: 3
order: 4
---

# Service Home
Expand Down
2 changes: 1 addition & 1 deletion analysing-data/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
label: Troubleshooting
order: 4
order: 6
---

# Troubleshooting in Baselime
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/illustrations/analyzing-data/overview/logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/illustrations/analyzing-data/overview/trace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/illustrations/sending-data/opentelemetry/trace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/logos/vercel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ You can add an environment by connecting your cloud account, or by creating an e

## Step 3: Send a log event (optional)

If you created anenvironment manually, execute this `cURL` command to send your first log event to Baselime.
If you created an environment manually, execute this `cURL` command to send your first log event to Baselime.

Replace your `BASELIME_API_KEY` with the API key your got from step 2.

Expand Down
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

To get started, read the [quick start guide](./quick-start.md).

This documentation highlights what Baselime is, how to get it working with your stack and how it can help you discover, investigate, and resolve issues faster.
This documentation highlights what Baselime is, how to get it working with your stack and how it can help you discover, investigate, and resolve errors faster.

[!ref Quick Start](./quick-start.md)
[!ref](./sending-data/index.md)
Expand Down
3 changes: 3 additions & 0 deletions sending-data/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ Baselime supports a variety of data sources, including logs, metrics, traces, an
[!ref icon="../assets/images/logos/logo_cloudtrail.png"](./aws/cloudtrail.md)
[!ref icon="../assets/images/logos/logo_cloudwatch.png"](./aws/cloudwatch-metrics.md)

### Vercel
[!ref icon="../assets/images/logos/vercel.png"](./vercel.md)

### Other Sources
[!ref icon="../assets/images/logos/http_flat@3x.png"](./events-api.md)
[!ref icon="../assets/images/logos/s3_flat@3x.png"](./s3-rehydration.md)
Expand Down

0 comments on commit 575eaa9

Please sign in to comment.