https://github.com/glowroot/glowroot
Easy to use, very low overhead, Java APM
https://github.com/glowroot/glowroot
Last synced: 5 days ago
JSON representation
Easy to use, very low overhead, Java APM
- Host: GitHub
- URL: https://github.com/glowroot/glowroot
- Owner: glowroot
- License: apache-2.0
- Created: 2014-01-29T05:25:58.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2025-01-30T20:14:01.000Z (2 months ago)
- Last Synced: 2025-04-03T22:25:13.750Z (12 days ago)
- Language: Java
- Homepage: https://glowroot.org
- Size: 33.5 MB
- Stars: 1,267
- Watchers: 55
- Forks: 311
- Open Issues: 272
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-java - Glowroot
README
Glowroot
=========
## Requirements
* Java 8+ for agent
* Java 17+ for glowroot-central
## Quick start
1. Download and unzip [glowroot-0.14.3-beta.5-dist.zip](https://github.com/glowroot/glowroot/releases/download/v0.14.3-beta.5/glowroot-0.14.3-beta.5-dist.zip)
2. Add `-javaagent:path/to/glowroot.jar` to your application's JVM args [[where are my application server's JVM args?](https://github.com/glowroot/glowroot/wiki/Where-are-my-application-server's-JVM-args%3F)]
3. Check that the user account that runs the JVM has write access to the glowroot folder
4. Start your application
5. Point your browser to http://localhost:4000
See the [wiki](https://github.com/glowroot/glowroot/wiki/Agent-Installation-(with-Embedded-Collector)) for optional post-installation steps.
## Please report any issues!
* [GitHub issue tracker](https://github.com/glowroot/glowroot/issues)
* [Google groups](https://groups.google.com/forum/#!forum/glowroot)
## Release announcements
* Follow [@glowroot](https://twitter.com/glowroot) on Twitter, or
* Subscribe to the [Google group](https://groups.google.com/forum/#!forum/glowroot)
## Building
The usual:
mvn clean install
Binary distribution is built under agent/dist/target.
Building requires Java 11+ and Maven 3.8.0+.
## Contributing
Glowroot uses [Immutables](https://immutables.github.io) annotation processing to eliminate maintenance on lots of boilerplate code. If you are using Eclipse, this requires installing the [m2e-apt](https://github.com/jbosstools/m2e-apt) plugin and changing Window > Preferences > Maven > Annotation Processing to "Automatically configure JDT APT".
To work on the UI, run org.glowroot.ui.sandbox.UiSandboxMain under a debugger inside your favorite IDE. This starts Glowroot and generates a variety of sample traces to give the UI something to display. Connect your browser to http://localhost:4000.
Also, Glowroot uses [Bower](http://bower.io) and [Grunt](http://gruntjs.com) to build its web assets (dependency management, Javascript concat/minify, LESS compile/uncss/minify, AngularJS template concat/minify, asset revving and more). The first time you run `mvn clean install`, Node, Bower and Grunt are installed locally under the `ui` directory (thanks to the [frontend-maven-plugin](https://github.com/eirslett/frontend-maven-plugin)).
If you are modifying web assets, you either need to run grunt to re-build them after each change, or (better) run `./grunt serve` from the `ui` directory and connect your browser to http://localhost:9000.
`./grunt serve` serves up the Glowroot web assets to the browser without the concat/minify/rev step, which makes testing/debugging much easier. It reverse proxies non- static resource requests to http://localhost:4000 to be handled by Glowroot. It also watches for changes to the files and performs live-reload of web assets inside the browser.
`./grunt serve:demo` does the same as above, except that it reverse proxies non- static resource requests to [https://demo.glowroot.org](https://demo.glowroot.org) instead of http://localhost:4000.
## Integration tests
Integration tests are run during Maven's standard `integration-test` lifecycle phase.
The Glowroot agent has an [integration test harness](agent/it-harness) which makes it easy to run sample application code and then validate the data captured by the agent. The integration test harness is able to run tests both using a custom weaving class loader (which is very convenient for running and debugging inside your favorite IDE), and by spawning a JVM with the -javaagent flag (which more correctly simulates real world conditions).
Browser-based integration tests are run using WebDriver. By default they run against Firefox. Thanks to [Sauce Labs](https://saucelabs.com), they also run against Chrome, IE (9, 10, 11) and Safari (6, 7, 8, 9) during every Travis CI build (see the jobs with TARGET=saucelabs).
## Microbenchmarks
Microbenchmarks are written using the excellent [JMH](http://openjdk.java.net/projects/code-tools/jmh/) benchmark harness. The microbenchmarks can be built and run under [agent/benchmarks](agent/benchmarks):
mvn clean package
java -jar target/benchmarks.jar -jvmArgs -javaagent:path/to/glowroot.jar
## Code quality
[SonarQube](http://www.sonarqube.org) is used to check Java coding conventions, code coverage, duplicate code, package cycles and much more. See analysis at [https://sonarcloud.io](https://sonarcloud.io/dashboard?id=org.glowroot%3Aglowroot-parent).
[Checker Framework](http://types.cs.washington.edu/checker-framework/) is used to eliminate fear of *null* with its rigorous [Nullness Checker](http://types.cs.washington.edu/checker-framework/current/checker-framework-manual.html#nullness-checker). It is run as part of every Travis CI build (see the job with TARGET=checker) and any violation fails the build.
## Dependency shading
All third party java libraries used by the agent are shaded under the org.glowroot.agent.shaded package to ensure there are no jar version conflicts with the application being monitored.
## License
Glowroot source code is licensed under the Apache License, Version 2.0.
See [Third Party Software](https://github.com/glowroot/glowroot/wiki/Third-Party-Software) for license detail of third party software included in the binary distribution.