{"id":20337955,"url":"https://github.com/runsidekick/sidekick-agent-java","last_synced_at":"2025-04-11T22:52:33.541Z","repository":{"id":59304833,"uuid":"529293620","full_name":"runsidekick/sidekick-agent-java","owner":"runsidekick","description":"Java agent for Sidekick open-source live application debugger","archived":false,"fork":false,"pushed_at":"2023-01-31T14:32:50.000Z","size":343,"stargazers_count":23,"open_issues_count":1,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-11T22:52:28.763Z","etag":null,"topics":["debugging","debugging-tool","logging","monitoring"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/runsidekick.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-08-26T14:39:10.000Z","updated_at":"2024-11-01T00:20:07.000Z","dependencies_parsed_at":"2023-02-16T20:15:50.796Z","dependency_job_id":null,"html_url":"https://github.com/runsidekick/sidekick-agent-java","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runsidekick%2Fsidekick-agent-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runsidekick%2Fsidekick-agent-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runsidekick%2Fsidekick-agent-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runsidekick%2Fsidekick-agent-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/runsidekick","download_url":"https://codeload.github.com/runsidekick/sidekick-agent-java/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248492965,"owners_count":21113161,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["debugging","debugging-tool","logging","monitoring"],"created_at":"2024-11-14T21:11:00.587Z","updated_at":"2025-04-11T22:52:33.520Z","avatar_url":"https://github.com/runsidekick.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg width=\"30%\" height=\"30%\" src=\"https://4750167.fs1.hubspotusercontent-na1.net/hubfs/4750167/Sidekick%20OS%20repo/logo-1.png\"\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  Sidekick Java Agent\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/runsidekick/sidekick\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/github/license/runsidekick/sidekick?style=for-the-badge\" alt=\"Sidekick Licence\" /\u003e\u003c/a\u003e\u0026nbsp;\n    \u003ca href=\"https://www.runsidekick.com/discord-invitation?utm_source=sidekick-java-readme\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/discord/958745045308174416?style=for-the-badge\u0026logo=discord\u0026label=DISCORD\" alt=\"Sidekick Discord Channel\" /\u003e\u003c/a\u003e\u0026nbsp;\n    \u003ca href=\"https://www.runforesight.com?utm_source=sidekick-java-readme\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/badge/Monitored%20by-Foresight-%239900F0?style=for-the-badge\" alt=\"Foresight monitoring\" /\u003e\u003c/a\u003e\u0026nbsp;\n    \u003ca href=\"https://app.runsidekick.com/sandbox?utm_source=sidekick-java-readme\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/badge/try%20in-sandbox-brightgreen?style=for-the-badge\" alt=\"Sidekick Sandbox\" /\u003e\u003c/a\u003e\u0026nbsp;\n    \n\u003c/p\u003e\n\n\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://github.com/runsidekick/sidekick\"\u003e\u003cstrong\u003eSidekick Main Repository »\u003c/strong\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#what-is-sidekick\"\u003eWhat is Sidekick?\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#sidekick-actions\"\u003eSidekick Actions\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#sidekick-java-agent\"\u003eSidekick Java Agent\u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#supported-jvms-and-languages\"\u003eSupported JVMs and Languages\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#download-the-agent\"\u003eDownload the Agent\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#build\"\u003eBuild the agent\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#build-command\"\u003eBuild command\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#official-sidekick-agents\"\u003eOfficial Sidekick Agents\u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#resources\"\u003eResources\u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#questions-problems-suggestions\"\u003eQuestions? Problems? Suggestions?\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n## What is Sidekick?\nSidekick is a live application debugger that lets you troubleshoot your applications while they keep on running.\n\nAdd dynamic logs and put non-breaking breakpoints in your running application without the need of stopping \u0026 redeploying.\n\nSidekick 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. \n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"70%\" height=\"70%\" src=\"https://4750167.fs1.hubspotusercontent-na1.net/hubfs/4750167/Sidekick%20OS%20repo/HowSidekickWorks.gif\"\u003e\n\u003c/p\u003e\n\n\n##### Sidekick Actions:\nSidekick has two major actions; Tracepoints \u0026 Logpoints.\n\n- A **tracepoint** is a non-breaking remote breakpoint. In short, it takes a snapshot of the variables when the code hits that line.\n- **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.\n\nSupported runtimes: Java, Python, Node.js\n\nTo learn more about Sidekick features and capabilities, see our [web page.](https://www.runsidekick.com/?utm_source=sidekick-java-readme)\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://app.runsidekick.com/sandbox?utm_source=github\u0026utm_medium=readme\" target=\"_blank\"\u003e\u003cimg width=\"345\" height=\"66\" src=\"https://4750167.fs1.hubspotusercontent-na1.net/hubfs/4750167/Sidekick%20OS%20repo/try(1)%201.png\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.runsidekick.com/discord-invitation?utm_source=sidekick-java-readme\" target=\"_blank\"\u003e\u003cimg width=\"40%\" height=\"40%\" src=\"https://4750167.fs1.hubspotusercontent-na1.net/hubfs/4750167/Sidekick%20OS%20repo/joindiscord.png\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://www.runsidekick.com/?utm_source=sidekick-java-readme\"\u003e\u003cstrong\u003eLearn More »\u003c/strong\u003e\u003c/a\u003e\n\u003c/div\u003e\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n## Sidekick Java Agent\n\nSidekick 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).\n\nTo 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\n- injects its hook call into the specified line at the bytecode level\n- intercepts the code execution just before the specified line\n- captures call stack snapshot (for tracepoint) or prints dynamic log message (for log point)\n- create events to be sent asynchronously\n- and then lets the code execution continue\n\n\nHere, 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.\n\n\nThe advantage of Sidekick over classical APM solutions is that, Sidekick\n- 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\n- has zero overhead when you don't have any tracepoint or log point but APMs have always\n- 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\n\n### Usage\n##### Supported JVMs and Languages\nJDK 8+ is supported\nJava (8+), Kotlin (1.3+) and Scala (2.10+) JVM languages are supported\n\n##### Download the agent\nDownload the latest Sidekick agent from this link [repo](https://repo.thundra.io/service/local/artifact/maven/redirect?r=sidekick-releases\u0026g=com.runsidekick.agent\u0026a=sidekick-agent-bootstrap\u0026v=LATEST)\n\nAgent configuration : https://docs.runsidekick.com/installation/installing-agents/java/configuration#configure-the-agent\n\nSource bundling: https://docs.runsidekick.com/installation/installing-agents/java/source-bundling\n\n### Build\n\n##### Prerequisites \n- Java 8+\n- Maven 3.x\n\n##### Build command:\n```mvn clean package```\n\n### Benchmarks\n- [Production Debuggers — 2022 Benchmark Results](https://medium.com/runsidekick/sidekick-blog-production-debuggers-2022-benchmark-results-part-1-ec173d0f8ccd?utm_source=sidekick-java-readme)\n\n##  Official Sidekick Agents\n\n- [Java](https://github.com/runsidekick/sidekick-agent-java)\n- [Node.js](https://github.com/runsidekick/sidekick-agent-nodejs)\n- [Python](https://github.com/runsidekick/sidekick-agent-python)\n\n## Resources:\n\n- [Documentation](https://docs.runsidekick.com/?utm_source=sidekick-java-readme)\n- [Community](https://github.com/runsidekick/sidekick/discussions)\n- [Discord](https://www.runsidekick.com/discord-invitation?utm_source=sidekick-java-readme)\n- [Contributing](https://github.com/runsidekick/sidekick/blob/master/CONTRIBUTING.md)\n- [Sidekick Main Repository](https://github.com/runsidekick/sidekick)\n\n## Questions? Problems? Suggestions?\n\nTo 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.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Contact\n\n[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.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frunsidekick%2Fsidekick-agent-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frunsidekick%2Fsidekick-agent-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frunsidekick%2Fsidekick-agent-java/lists"}