Skip to content

Commit

Permalink
Update name
Browse files Browse the repository at this point in the history
  • Loading branch information
laffra committed Apr 10, 2023
1 parent 1ac8e81 commit c50867c
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# microlog.ai

Microlog.ai is an AI-driven approach to observability and monitoring.
microlog.ai is an AI-driven approach to observability and monitoring.

# Installing Microlog.ai
# Installing microlog.ai

```bash
git clone https://github.com/laffra/microlog
```

# Enabling Microlog.ai
# Enabling microlog.ai

```python
import microlog
Expand All @@ -23,7 +23,7 @@ Microlog.ai is an AI-driven approach to observability and monitoring.
)
```

That's all you need to do to get going. Microlog.ai is an AI-driven monitoring solution that
That's all you need to do to get going. microlog.ai is an AI-driven monitoring solution that
will observe your code while it is running, analyze the metrics, and produce easy to use
dashboards for observing the health of your system, set SLOs, and register alerts.

Expand All @@ -47,7 +47,7 @@ Functions and methods can be traced with microlog using the `@trace` decorator:

# An Example

The Microlog.ai UI consist of four main sections: a status bar, a timeline, a flame graph, and spans. The status bar shows general information about the process and manually created log entries. The flame graph is generated automatically by microlog, without needing any instrumentation in the code. Finally, the span view show functions or methods that were annotated manually.
The microlog.ai UI consist of four main sections: a status bar, a timeline, a flame graph, and spans. The status bar shows general information about the process and manually created log entries. The flame graph is generated automatically by microlog, without needing any instrumentation in the code. Finally, the span view show functions or methods that were annotated manually.

![Example run of microlog](images/overview.png)

Expand All @@ -61,19 +61,19 @@ When hovering over a call, details are shown. In the case below, microlog detect
- All this resulted in the total CPU consumption during the call to be below 66%.
- For around 33% of the time, the process was waiting. Typically, this indicates bottlenecks elsewhere in the system, such as having to wait for data to arrive from a micro-service.

Automatic anomaly detection, call stack analysis, and process health indicators offered by Microlog.ai allow us to quickly debug perfomance issues.
Automatic anomaly detection, call stack analysis, and process health indicators offered by microlog.ai allow us to quickly debug perfomance issues.

![Example run of microlog](images/dialog.png)

The top bar shows general statistics for the process, such as CPU and number of modules:

![Microlog.ai logs](images/status.png)
![microlog.ai logs](images/status.png)

Log entries are shown as visual markers in the top bar. Because Microlog.ai shows log entries on the timeline, analyzing problems becomes much easier than with normal logs. No more scrolling page after page to find a stacktrace. With Microlog.ai they appear as easy to see stop signs:
Log entries are shown as visual markers in the top bar. Because microlog.ai shows log entries on the timeline, analyzing problems becomes much easier than with normal logs. No more scrolling page after page to find a stacktrace. With microlog.ai they appear as easy to see stop signs:

![Microlog.ai logs](images/error-log.png)
![microlog.ai logs](images/error-log.png)

Functions and methods can be traced. These traced spans are positioned along the timeline and are shown at the bottom. Parameters to the function or method being traced are automatically extracted by Microlog.ai and added to the log:
Functions and methods can be traced. These traced spans are positioned along the timeline and are shown at the bottom. Parameters to the function or method being traced are automatically extracted by microlog.ai and added to the log:

![Microlog.ai logs](images/span.png)
![microlog.ai logs](images/span.png)

0 comments on commit c50867c

Please sign in to comment.