https://github.com/sourceplusplus/demo-groovy
https://github.com/sourceplusplus/demo-groovy
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sourceplusplus/demo-groovy
- Owner: sourceplusplus
- License: apache-2.0
- Created: 2022-10-09T14:16:48.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-11T01:17:56.000Z (almost 3 years ago)
- Last Synced: 2025-06-19T05:06:05.935Z (11 months ago)
- Language: Groovy
- Size: 152 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
## What is this?
This project holds Groovy-based feature demonstrations for [Source++](https://github.com/sourceplusplus/sourceplusplus),
the continuous feedback platform for developers. These demonstrations are meant to be used as a reference for how to use
Source++ in your own projects.
## How to use?
Install the Source++ plugin via the JetBrains Marketplace by searching for: `Source++`.
Alternatively, you can download the Source++ plugin directly
from [here](https://plugins.jetbrains.com/plugin/12033-source-).
Once the plugin is installed, check out the demos below. Each demo contains instructions explaining how to use it.
> **Note**
>
> You do not need to run any code for these demos. This application is hosted on our publicly accessible servers.
## Demo: Live Commands
> Live Commands allow you to execute user-defined actions. These commands have access to application runtime data and
> can be used to gather metrics, trigger alerts, or perform other actions.
#### [Add Breakpoint](./src/main/groovy/spp/demo/command/AddBreakpoint.groovy)
Command Preview
This demonstration shows how to add a "non-breaking breakpoint" to a running application. The **Add Breakpoint** command
is useful for debugging production applications without impacting the end user.
#### [Add Log](./src/main/groovy/spp/demo/command/AddLog.groovy)
Command Preview
This demonstration shows how to add a log statement to a running application. The **Add Log** command is useful for
increasing the verbosity of a running application with logs that output directly into the IDE.
#### [Tail Logs](./src/main/groovy/spp/demo/command/TailLogs.groovy)
Command Preview
This demonstration shows how to follow existing logs from a running application. The **Tail Logs** command works with
most logging frameworks, including Log4j, Logback, and SLF4J.
#### [View Activity](./src/main/groovy/spp/demo/command/ViewActivity.groovy)
Command Preview
This demonstration shows how to view the activity of an endpoint. The **View Activity** command is useful for
monitoring the throughput, latency, and error rate of a given endpoint.
#### [View Traces](./src/main/groovy/spp/demo/command/ViewTraces.groovy)
Command Preview
This demonstration shows how to view the traces of an endpoint. The **View Traces** command is useful for exploring
the execution path of a given endpoint.
## Demo: Live Indicators
> Live Indicators allow you to automatically display user-defined metrics in the IDE. These metrics can be used to
> monitor the health of your application or provide insight into the current state of the application.
#### [Failing Endpoint](./src/main/groovy/spp/demo/indicator/FailingEndpoint.groovy)
This demonstration shows how failing endpoints can be detected and displayed in the IDE. The **Failing Endpoint**
indicator is useful for identifying endpoints that are actively failing and require attention.
#### [High Load Endpoint](./src/main/groovy/spp/demo/indicator/HighLoadEndpoint.groovy)
This demonstration shows how high load endpoints can be detected and displayed in the IDE. The **High Load Endpoint**
indicator is useful for identifying endpoints that are experiencing high load and may require scaling.
#### [Slow Endpoint](./src/main/groovy/spp/demo/indicator/SlowEndpoint.groovy)
This demonstration shows how slow endpoints can be detected and displayed in the IDE. The **Slow Endpoint** indicator
is useful for identifying endpoints that are experiencing slow response times and may require optimization.
#### [Unused Endpoint](./src/main/groovy/spp/demo/indicator/UnusedEndpoint.groovy)
This demonstration shows how unused endpoints can be detected and displayed in the IDE. The **Unused Endpoint**
indicator is useful for identifying endpoints that are not being used and may be able to be removed.
## Bugs & Features
Bug reports and feature requests can be created [here](https://github.com/sourceplusplus/sourceplusplus/issues).