Skip to content

Commit c85e01f

Browse files
committed
docs: add indicators
1 parent aac1e5f commit c85e01f

File tree

1 file changed

+33
-7
lines changed

1 file changed

+33
-7
lines changed

README.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,49 @@ in your own projects.
1414
## How to use?
1515

1616
Install the Source++ plugin via the JetBrains Marketplace by searching for: `Source++`.
17-
Alternatively, you can download the Source++ plugin directly from [here](https://plugins.jetbrains.com/plugin/12033-source-).
17+
Alternatively, you can download the Source++ plugin directly
18+
from [here](https://plugins.jetbrains.com/plugin/12033-source-).
1819

1920
Once the plugin is installed, check out the demos below. Each demo contains instructions explaining how to use it.
2021

2122
> **Note**
2223
>
2324
> You do not need to run any code for these demos. This application is hosted on our publicly accessible servers.
2425
25-
## Demos
26+
## Demo: Live Commands
2627

27-
### [Tail Logs](./src/main/kotlin/spp/demo/command/TailLogs.kt)
28+
> Live Commands allow you to execute user-defined actions. These commands have access to application runtime data and
29+
> can be used to gather metrics, trigger alerts, or perform other actions.
2830
29-
This demonstration shows how to tail logs from a running application. Logs can be filtered by individual statements,
30-
methods, and classes. The **Tail Logs** command works for any application that uses a logging framework that is
31-
supported by Source++.
31+
#### [Tail Logs](./src/main/kotlin/spp/demo/command/TailLogs.kt)
3232

33-
For more information, see the [TailLogs](./src/main/kotlin/spp/demo/command/TailLogs.kt) class.
33+
This demonstration shows how to follow existing logs from a running application. The **Tail Logs** command works with
34+
most logging frameworks, including Log4j, Logback, and SLF4J.
35+
36+
## Demo: Live Indicators
37+
38+
> Live Indicators allow you to automatically display user-defined metrics in the IDE. These metrics can be used to
39+
> monitor the health of your application or provide insight into the current state of the application.
40+
41+
#### [Failing Endpoint](./src/main/kotlin/spp/demo/indicator/FailingEndpoint.kt)
42+
43+
This demonstration shows how failing endpoints can be detected and displayed in the IDE. The **Failing Endpoint**
44+
indicator is useful for identifying endpoints that are actively failing and require attention.
45+
46+
#### [High Load Endpoint](./src/main/kotlin/spp/demo/indicator/HighLoadEndpoint.kt)
47+
48+
This demonstration shows how high load endpoints can be detected and displayed in the IDE. The **High Load Endpoint**
49+
indicator is useful for identifying endpoints that are experiencing high load and may require scaling.
50+
51+
#### [Slow Endpoint](./src/main/kotlin/spp/demo/indicator/SlowEndpoint.kt)
52+
53+
This demonstration shows how slow endpoints can be detected and displayed in the IDE. The **Slow Endpoint** indicator
54+
is useful for identifying endpoints that are experiencing slow response times and may require optimization.
55+
56+
#### [Unused Endpoint](./src/main/kotlin/spp/demo/indicator/UnusedEndpoint.kt)
57+
58+
This demonstration shows how unused endpoints can be detected and displayed in the IDE. The **Unused Endpoint**
59+
indicator is useful for identifying endpoints that are not being used and may be able to be removed.
3460

3561
## Bugs & Features
3662

0 commit comments

Comments
 (0)