diff --git a/analysing-data/baselime-ai.md b/analysing-data/baselime-ai.md index 7c0a26058..1b7d9c7c2 100644 --- a/analysing-data/baselime-ai.md +++ b/analysing-data/baselime-ai.md @@ -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. --- diff --git a/analysing-data/errors.md b/analysing-data/errors.md new file mode 100644 index 000000000..c64fcdf6f --- /dev/null +++ b/analysing-data/errors.md @@ -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. diff --git a/analysing-data/home.md b/analysing-data/home.md index c6d04427d..966635542 100644 --- a/analysing-data/home.md +++ b/analysing-data/home.md @@ -1,6 +1,6 @@ --- label: Service Home -order: 3 +order: 4 --- # Service Home diff --git a/analysing-data/overview.md b/analysing-data/overview.md index c6c1271ba..f5ac3274f 100644 --- a/analysing-data/overview.md +++ b/analysing-data/overview.md @@ -1,6 +1,6 @@ --- label: Troubleshooting -order: 4 +order: 6 --- # Troubleshooting in Baselime diff --git a/assets/images/illustrations/analyzing-data/errors/details.png b/assets/images/illustrations/analyzing-data/errors/details.png new file mode 100644 index 000000000..c278c3fb8 Binary files /dev/null and b/assets/images/illustrations/analyzing-data/errors/details.png differ diff --git a/assets/images/illustrations/analyzing-data/errors/errors.png b/assets/images/illustrations/analyzing-data/errors/errors.png new file mode 100644 index 000000000..978e67a0c Binary files /dev/null and b/assets/images/illustrations/analyzing-data/errors/errors.png differ diff --git a/assets/images/illustrations/analyzing-data/overview/filter.png b/assets/images/illustrations/analyzing-data/overview/filter.png index e658e045e..f062eb360 100644 Binary files a/assets/images/illustrations/analyzing-data/overview/filter.png and b/assets/images/illustrations/analyzing-data/overview/filter.png differ diff --git a/assets/images/illustrations/analyzing-data/overview/logs.png b/assets/images/illustrations/analyzing-data/overview/logs.png index fe67e494f..cf8d85212 100644 Binary files a/assets/images/illustrations/analyzing-data/overview/logs.png and b/assets/images/illustrations/analyzing-data/overview/logs.png differ diff --git a/assets/images/illustrations/analyzing-data/overview/search.png b/assets/images/illustrations/analyzing-data/overview/search.png index cad2bfc3b..cec8a368f 100644 Binary files a/assets/images/illustrations/analyzing-data/overview/search.png and b/assets/images/illustrations/analyzing-data/overview/search.png differ diff --git a/assets/images/illustrations/analyzing-data/overview/trace-timeline.png b/assets/images/illustrations/analyzing-data/overview/trace-timeline.png index dedab87f2..43318ade7 100644 Binary files a/assets/images/illustrations/analyzing-data/overview/trace-timeline.png and b/assets/images/illustrations/analyzing-data/overview/trace-timeline.png differ diff --git a/assets/images/illustrations/analyzing-data/overview/trace.png b/assets/images/illustrations/analyzing-data/overview/trace.png index 3fbab6a00..12f385ec1 100644 Binary files a/assets/images/illustrations/analyzing-data/overview/trace.png and b/assets/images/illustrations/analyzing-data/overview/trace.png differ diff --git a/assets/images/illustrations/sending-data/lambda-logs-illustration.png b/assets/images/illustrations/sending-data/lambda-logs-illustration.png index b5c5beb80..28ff7a955 100644 Binary files a/assets/images/illustrations/sending-data/lambda-logs-illustration.png and b/assets/images/illustrations/sending-data/lambda-logs-illustration.png differ diff --git a/assets/images/illustrations/sending-data/opentelemetry/trace.png b/assets/images/illustrations/sending-data/opentelemetry/trace.png index 04d6c01c0..7258c69b7 100644 Binary files a/assets/images/illustrations/sending-data/opentelemetry/trace.png and b/assets/images/illustrations/sending-data/opentelemetry/trace.png differ diff --git a/assets/images/logos/vercel.png b/assets/images/logos/vercel.png new file mode 100644 index 000000000..cba5ad1bb Binary files /dev/null and b/assets/images/logos/vercel.png differ diff --git a/quick-start.md b/quick-start.md index 99d38f1c4..5aba48981 100644 --- a/quick-start.md +++ b/quick-start.md @@ -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. diff --git a/readme.md b/readme.md index 235887827..db6726672 100644 --- a/readme.md +++ b/readme.md @@ -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) diff --git a/sending-data/index.md b/sending-data/index.md index b9f8ec6c6..46f26a7ad 100644 --- a/sending-data/index.md +++ b/sending-data/index.md @@ -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)