-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
32 changed files
with
220 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
--- | ||
label: Service Home | ||
order: 3 | ||
--- | ||
|
||
# Service Home | ||
|
||
--- | ||
|
||
Every service in Baselime has a service home. The service home is where you get both a high-level overview of your service as well as the ability to drill down and investigate issues quickly. | ||
|
||
--- | ||
|
||
## Requests | ||
|
||
The requests view displays a summary of your requests and the list of the requests within the selected timeframe in chronological order. | ||
|
||
![](../assets/images/illustrations/analyzing-data/home/requests.png) | ||
|
||
### Summary | ||
|
||
The summary includes three charts: | ||
- **Number of events**: the total number of events your service emitted | ||
- **Errors**: the total number of errors in your telemetry data | ||
- **Request latencies** the 90th percentile latencies of requests and traces | ||
|
||
![](../assets/images/illustrations/analyzing-data/home/summary.png) | ||
|
||
You can drill down on any of these charts by clicking on the chart. It opens the Baselime query builder where you can slice and dice your data further. | ||
|
||
### List of requests | ||
|
||
Below the summary charts, there is a search bar, a filter button and the list of requests. | ||
|
||
You can search for any string or regular expression using the search bar. Baselime will search through all the events (logs, spans, span events and wide events) from your service and display the requests where at least one event matches the search criteria. | ||
|
||
You can filter by any high-dimensionality field in your data using the filter button. Baselime fill filter through all the events (logs, spans, span events and wide events) from your service and display the requests where at least one event matches the applied filters. | ||
|
||
If you add simultaneously a search criteria and filters, Baselime will find events that matches all searches and filters and displat the corresponding requests. | ||
|
||
![](../assets/images/illustrations/analyzing-data/home/requests-filters.png) | ||
|
||
You can expand each request and view the logs and the trace of the request. Also, to facilitace filtering, it's possible to filter directly from the logs or the trace of a request. Use the option menu at the end of each line in the events JSON. | ||
|
||
![](../assets/images/illustrations/analyzing-data/home/request-logs.png) | ||
|
||
!!! | ||
The menu inside the JSON event is available across Baselime, wherever an event is displayed. This enables you to quickly go from an event to investigating further, without loosing the context of the event. | ||
!!! | ||
|
||
--- | ||
|
||
## Events | ||
|
||
The events view displays all the events your service emitted during the selected timeframe. The events comprise all logs, spans, span events, wide-events and metrics sent to Baselime. | ||
|
||
You can search for events and filter events from this view. You can zoom in on the bar chart of the event volume. | ||
|
||
![](../assets/images/illustrations/analyzing-data/home/events.png) | ||
|
||
--- | ||
|
||
## Traces | ||
|
||
The traces view displays the traces found in your service within the selected timeframe. It includes a trace scatter plot, where the y-axis is the duration of the traces and the x-axis is the timestamp. In addition to the scatter plot, the trace view displays a list of traces from your service in chronological order. | ||
|
||
You can search and filter traces using the search bar and the filter button. | ||
|
||
The scatter plot is color-coded: | ||
|
||
- Red: traces with at least one span with an error | ||
- Green: succesful traces | ||
- Blue: Traces where there is a cold-start (for serverless functions) | ||
|
||
You can click on any of the dots in the scatter plot to display the trace. | ||
|
||
You can also click on any of the traces in the list to display the complete trace. | ||
|
||
Once you're viewing a trace, you can click on any of the spans to view the the span the logs of the traces, the span events, and the span details. | ||
|
||
![](../assets/images/illustrations/analyzing-data/home/traces.png) | ||
![](../assets/images/illustrations/analyzing-data/home/trace.png) | ||
![](../assets/images/illustrations/analyzing-data/home/trace-timeline.png) | ||
![](../assets/images/illustrations/analyzing-data/home/trace-logs.png) | ||
|
||
--- | ||
|
||
## Errors | ||
|
||
The error view displays a list of all errors that have occured in your service, alongside metadata about the error. | ||
|
||
You can search for, or filter errors that match a set of criteria. | ||
|
||
Once you've identified an error you want to investigate further, click on the "Investigate" button to quickly get the context around the error, for example the requests or traces the error occured in, or more metadata around the error. | ||
|
||
!!! | ||
Baselime automatically detects errors from your telemetry data. | ||
!!! | ||
|
||
![](../assets/images/illustrations/analyzing-data/home/errors.png) | ||
|
||
--- | ||
|
||
## Inventory | ||
|
||
The inventory view displays a set of lists of cloud-resources available in your service. Currently, the available resources are: | ||
|
||
- AWS Lambda Functions | ||
- Amazon ECS Services | ||
- Amazon DynamoDB Tables | ||
|
||
We're continiously adding more cloud services to the inventory view. | ||
|
||
![](../assets/images/illustrations/analyzing-data/home/inventory.png) | ||
|
||
From the inventory view, you can navigate to any individual cloud resource. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
--- | ||
label: Troubleshooting | ||
order: 4 | ||
--- | ||
|
||
# Troubleshooting in Baselime | ||
|
||
--- | ||
|
||
Baselime enables you to troubleshoot your systems and find issues faster. You can search, slice and dice your data against any dimension to get answers to your questions. | ||
|
||
## Search | ||
|
||
Once you've created an environment in Baselime and sent data (logs, metrics, traces or wide events), you can search for any string or regular expression in your data. | ||
|
||
- Click on your environment | ||
- Click on one of the discovered services (or the `default` service) | ||
- Enter your search expression | ||
|
||
Baselime will surface all the requests where the search expression is found. This search is performed on logs, spans, span events and wide events. | ||
|
||
![Search in Baselime](../assets/images/illustrations/analyzing-data/overview/search.png) | ||
|
||
Expand each request to view the logs and the trace of the specific request. | ||
|
||
--- | ||
|
||
## Filter | ||
|
||
From any screen on Baselime with telemetry data, you can filter the data by any of the fields persent in the data. | ||
|
||
Baselime supports high cardinality and high dimensionality. This means you can send data with as many nested fields as you want, and those fields can have as many possible values as you want. For example, in your logs or traces, you can send a `requestId` to Baselime, which can have millions of unique values; and you will be able to filter by any of these values. | ||
|
||
![Filter in Baselime](../assets/images/illustrations/analyzing-data/overview/filter.png) | ||
|
||
--- | ||
|
||
## View requests and traces | ||
|
||
Once you've searched an/or applied filters to your telemetry data, you can drill down into a single request or trace, view all the logs, spans and span events related to the request. | ||
|
||
![Request logs in Baselime](../assets/images/illustrations/analyzing-data/overview/logs.png) | ||
![Trace map in Baselime](../assets/images/illustrations/analyzing-data/overview/trace.png) | ||
![Trace timeline in Baselime](../assets/images/illustrations/analyzing-data/overview/trace-timeline.png) | ||
|
||
--- | ||
|
||
## Compute aggregates | ||
|
||
Sometimes you want to troubleshoot an issue that impacts more than one user. For example, you might want to count the number of requests that returned an error status code and group them by route, or you might want to compute the latency of your requests. | ||
|
||
This is where the Baselime query builder shines. | ||
|
||
Baselime has an internal tab system. Start a new tab by clicking on the `+` at the top of the screen, select `Start new query` and `Start from scratch`. | ||
|
||
- Add a visualisation `COUNT` | ||
- Add a filter `$baselime.error` `EXISTS` | ||
- Add a group by `@message` or `@message.message` | ||
- Add a order by | ||
- Click `Run query` | ||
|
||
![Baselime query builder](../assets/images/illustrations/analyzing-data/overview/query.png) | ||
|
||
You'll see a count of all the events where there was an error, grouped by the error message. You can zoom: | ||
|
||
- zoom in on the chart | ||
- view the requests and traces associated with these events | ||
- view the raw data (the list of events) that match the filters | ||
- add more visualisations, filters, and group bys | ||
- add a search expression | ||
|
||
!!! | ||
The Baselime query builder is the most powerful way to explore your data in Baselime. It gives your the tools to keep drilling down and surface insights from your telemetry data. | ||
!!! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
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.
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.
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.
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 added
BIN
+368 KB
assets/images/illustrations/analyzing-data/overview/trace-timeline.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.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters