Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/runsidekick/sidekick-agent-java
Java agent for Sidekick open-source live application debugger
https://github.com/runsidekick/sidekick-agent-java
debugging debugging-tool logging monitoring
Last synced: 3 months ago
JSON representation
Java agent for Sidekick open-source live application debugger
- Host: GitHub
- URL: https://github.com/runsidekick/sidekick-agent-java
- Owner: runsidekick
- License: agpl-3.0
- Created: 2022-08-26T14:39:10.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-01-31T14:32:50.000Z (about 2 years ago)
- Last Synced: 2023-03-08T23:35:21.329Z (almost 2 years ago)
- Topics: debugging, debugging-tool, logging, monitoring
- Language: Java
- Homepage:
- Size: 335 KB
- Stars: 20
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Sidekick Java Agent
Table of Contents
-
What is Sidekick?
-
Sidekick Java Agent
-
Usage
-
Build the agent
-
Official Sidekick Agents
-
Resources
- Questions? Problems? Suggestions?
- Contact
## What is Sidekick?
Sidekick is a live application debugger that lets you troubleshoot your applications while they keep on running.
Add dynamic logs and put non-breaking breakpoints in your running application without the need of stopping & redeploying.
Sidekick Open Source is here to allow self-hosting and make live debugging more accessible. Built for everyone who needs extra information from their running applications.
##### Sidekick Actions:
Sidekick has two major actions; Tracepoints & Logpoints.
- A **tracepoint** is a non-breaking remote breakpoint. In short, it takes a snapshot of the variables when the code hits that line.
- **Logpoints** open the way for dynamic(on-demand) logging to Sidekick users. Replacing traditional logging with dynamic logging has the potential to lower stage sizes, costs, and time for log searching while adding the ability to add new logpoints without editing the source code, redeploying, or restarting the application.
Supported runtimes: Java, Python, Node.js
To learn more about Sidekick features and capabilities, see our [web page.](https://www.runsidekick.com/?utm_source=sidekick-java-readme)
%201.png)
## Sidekick Java Agent
Sidekick Java agent allows you to inject tracepoints (non-breaking breakpoints) and log points dynamically to capture call stack snapshots (with variables) and add log messages on the fly without code modification, re-build and re-deploy. So it helps you, your team, and your organization to reduce MTTR (Minimum Time to Repair/Resolve).
To achieve this, the Sidekick Java agent has nothing to do with JDWP (Java Debug Wire Protocol), as it doesn't suspend the code execution, but hooks into code execution at the application layer by bytecode instrumentation. Under the hood, Sidekick agent
- injects its hook call into the specified line at the bytecode level
- intercepts the code execution just before the specified line
- captures call stack snapshot (for tracepoint) or prints dynamic log message (for log point)
- create events to be sent asynchronously
- and then lets the code execution continue
Here, to keep Sidekick agent overhead at a minimum (sub-millisecond on average), in addition to non-blocking event publishing, we apply many performance improvements like async snapshot taking, async call stack collecting, and fast serialization by reducing redundant memory copies.
The advantage of Sidekick over classical APM solutions is that, Sidekick
- can debug and trace any location (your code base or 3rd party dependency) in your application, not just the external (DB, API, etc ...) calls like APM solutions
- has zero overhead when you don't have any tracepoint or log point but APMs have always
- doesn't produce too much garbage data because it collects data only at the certain points you specified as long as that point (tracepoint/logpoint) is active
### Usage
##### Supported JVMs and Languages
JDK 8+ is supported
Java (8+), Kotlin (1.3+) and Scala (2.10+) JVM languages are supported
##### Download the agent
Download the latest Sidekick agent from this link [repo](https://repo.thundra.io/service/local/artifact/maven/redirect?r=sidekick-releases&g=com.runsidekick.agent&a=sidekick-agent-bootstrap&v=LATEST)
Agent configuration : https://docs.runsidekick.com/installation/installing-agents/java/configuration#configure-the-agent
Source bundling: https://docs.runsidekick.com/installation/installing-agents/java/source-bundling
### Build
##### Prerequisites
- Java 8+
- Maven 3.x
##### Build command:
```mvn clean package```
### Benchmarks
- [Production Debuggers — 2022 Benchmark Results](https://medium.com/runsidekick/sidekick-blog-production-debuggers-2022-benchmark-results-part-1-ec173d0f8ccd?utm_source=sidekick-java-readme)
## Official Sidekick Agents
- [Java](https://github.com/runsidekick/sidekick-agent-java)
- [Node.js](https://github.com/runsidekick/sidekick-agent-nodejs)
- [Python](https://github.com/runsidekick/sidekick-agent-python)
## Resources:
- [Documentation](https://docs.runsidekick.com/?utm_source=sidekick-java-readme)
- [Community](https://github.com/runsidekick/sidekick/discussions)
- [Discord](https://www.runsidekick.com/discord-invitation?utm_source=sidekick-java-readme)
- [Contributing](https://github.com/runsidekick/sidekick/blob/master/CONTRIBUTING.md)
- [Sidekick Main Repository](https://github.com/runsidekick/sidekick)
## Questions? Problems? Suggestions?
To report a bug or request a feature, create a [GitHub Issue](https://github.com/runsidekick/sidekick-agent-java/issues). Please ensure someone else has not created an issue for the same topic.
## Contact
[Reach out on the Discord](https://www.runsidekick.com/discord-invitation?utm_source=sidekick-java-readme). A fellow community member or Sidekick engineer will be happy to help you out.