Permalink
Browse files

move to github

  • Loading branch information...
fstab committed May 23, 2017
0 parents commit 1ad1d1ec9c515b6523f7df2a9d1953c8fc9967d3
Showing with 2,185 additions and 0 deletions.
  1. +4 −0 .gitignore
  2. +1 −0 AUTHORS
  3. +177 −0 LICENSE
  4. +13 −0 NOTICE
  5. +4 −0 NOTICE.template
  6. +160 −0 README.md
  7. +55 −0 pom.xml
  8. +15 −0 promagent-agent/pom.xml
  9. +114 −0 promagent-agent/src/main/java/io/promagent/agent/ClassLoaderCache.java
  10. +175 −0 promagent-agent/src/main/java/io/promagent/agent/Hook.java
  11. +26 −0 promagent-agent/src/main/java/io/promagent/agent/HookException.java
  12. +52 −0 promagent-agent/src/main/java/io/promagent/agent/HookFactory.java
  13. +28 −0 promagent-agent/src/main/java/io/promagent/agent/Promagent.java
  14. +31 −0 promagent-agent/src/main/java/io/promagent/agent/annotations/After.java
  15. +31 −0 promagent-agent/src/main/java/io/promagent/agent/annotations/Before.java
  16. +31 −0 promagent-agent/src/main/java/io/promagent/agent/annotations/Hook.java
  17. +61 −0 promagent-dist/pom.xml
  18. +35 −0 promagent-dist/src/assembly/dist.xml
  19. +31 −0 promagent-exporter/pom.xml
  20. +43 −0 promagent-exporter/src/main/java/io/promagent/exporter/PromagentExporterServlet.java
  21. +41 −0 promagent-internal/pom.xml
  22. +49 −0 promagent-internal/src/main/java/io/promagent/internal/BuiltInServer.java
  23. +122 −0 promagent-internal/src/main/java/io/promagent/internal/Promagent.java
  24. +68 −0 promagent-internal/src/main/java/io/promagent/internal/PromagentAdvice.java
  25. +56 −0 promagent-internal/src/main/java/io/promagent/internal/hooks/Context.java
  26. +169 −0 promagent-internal/src/main/java/io/promagent/internal/hooks/JdbcHook.java
  27. +124 −0 promagent-internal/src/main/java/io/promagent/internal/hooks/ServletHook.java
  28. +36 −0 promagent-internal/src/main/java/io/promagent/internal/metrics/Counter.java
  29. +23 −0 promagent-internal/src/main/java/io/promagent/internal/metrics/CounterMBean.java
  30. +41 −0 promagent-internal/src/main/java/io/promagent/internal/metrics/Exporter.java
  31. +19 −0 promagent-internal/src/main/java/io/promagent/internal/metrics/ExporterMBean.java
  32. +46 −0 promagent-internal/src/main/java/io/promagent/internal/metrics/Gauge.java
  33. +27 −0 promagent-internal/src/main/java/io/promagent/internal/metrics/GaugeMBean.java
  34. +36 −0 promagent-internal/src/main/java/io/promagent/internal/metrics/Histogram.java
  35. +23 −0 promagent-internal/src/main/java/io/promagent/internal/metrics/HistogramMBean.java
  36. +112 −0 promagent-internal/src/main/java/io/promagent/internal/metrics/MetricsUtil.java
  37. +47 −0 promagent-internal/src/main/java/io/promagent/internal/metrics/PromagentCollectorRegistry.java
  38. +36 −0 promagent-internal/src/main/java/io/promagent/internal/metrics/Summary.java
  39. +23 −0 promagent-internal/src/main/java/io/promagent/internal/metrics/SummaryMBean.java
  40. BIN screenshot.png
@@ -0,0 +1,4 @@
.idea/
dependency-reduced-pom.xml
target/
**/*.iml
@@ -0,0 +1 @@
Fabian Stäber <fabian@fstab.de>
177 LICENSE
@@ -0,0 +1,177 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
13 NOTICE
@@ -0,0 +1,13 @@
Promagent includes the following libraries:
Byte Buddy (without dependencies) under The Apache Software License, Version 2.0
Java Servlet API under CDDL + GPLv2 with classpath exception
Promagent classes not visible on the boot class loader under Apache License, Version 2.0
Promagent classes visible on the boot class loader under Apache License, Version 2.0
Promagent parent under Apache License, Version 2.0
promagent.jar under Apache License, Version 2.0
promagent.war under Apache License, Version 2.0
Prometheus Java Simpleclient under The Apache Software License, Version 2.0
Prometheus Java Simpleclient Common under The Apache Software License, Version 2.0
This file is generated during the Maven build.
@@ -0,0 +1,4 @@
Promagent includes the following libraries:
#GENERATED_NOTICES#
This file is generated during the Maven build.
160 README.md
@@ -0,0 +1,160 @@
Promagent
=========
_Instrumenting Java Web applications without Modifying their Source Code._
Promagent is a Java agent providing [Prometheus](https://prometheus.io/) metrics for Java Web applications without modifying the application's source code.
Promagent uses the [Byte Buddy](http://bytebuddy.net/) bytecode manipulation library to insert Prometheus metrics during application startup.
The current Promagent version covers two metrics:
* HTTP: Number and duration of web requests.
* SQL: Number and duration of database queries.
The agent was tested with [Spring Boot](https://projects.spring.io/spring-boot/) and with the [Wildfly application server](http://wildfly.org/).
Example
-------
![screenshot](screenshot.png)
Some example Prometheus queries evaluating Promagent metrics:
* Top five most frequent SQL queries: `topk(5, sql_queries_total)`.
* Top five longest-running HTTP requests (median): `topk(5, http_request_duration{quantile="0.5"})`.
* If a database query is triggered within the context of an HTTP request, the HTTP `path` is added as a label to the `sql_*` metrics. That way, we can relate database queries to the corresponding HTTP requests:
* Time ratio spent on the database when processing an HTTP request: `sum(sql_query_duration{quantile="0.5"}) by (query,method,path) / on(method,path) group_left sum(http_request_duration{quantile="0.5"}) by (method,path)`.
* Which database queries are triggered how often for which HTTP request: `sum(sql_queries_total) by (method, path, query) / on(method, path) group_left sum(http_requests_total) by (method, path)`.
Customizing the Labels
----------------------
The Prometheus server internally stores one time series for each label value. Therefore, Promagent strips HTTP URLs and SQL queries to make sure that there are not too many different label values:
* For HTTP requests, path parameters are replaced with placeholders. Promagent aims to use REST resources like `/item/{id}` as labels, not in actual paths like `/item/123`.
* For SQL queries, values are stripped. Promagent aims to use the structure of the query like `INSERT INTO ITEMS (ID, NAME, PRICE) VALUES (...)` as a label, not in its values like `INSERT INTO ITEMS (ID, NAME, PRICE) VALUES (23, 'abc', 17.5)`.
Of course, replacing path parameters and SQL values is application specific. Promagent implements a very simple replacement in `ServletHook.stripPathParameters()` and `JdbcHook.stripValues()`, but you probably need to customize these methods for your application.
Spring Boot Demo
----------------
Download and compile the [Promagent](https://github.com/fstab/promagent).
```bash
git clone https://github.com/fstab/promagent.git
cd promagent
mvn clean package
cd ..
```
Download and compile a [Spring Boot Getting Started](https://spring.io/guides/gs/accessing-data-rest/) application.
```bash
git clone https://github.com/spring-guides/gs-accessing-data-rest.git
cd gs-accessing-data-rest/complete
mvn clean package
cd ../..
```
Run the Spring Boot application with the Promagent attached.
```bash
java \
-javaagent:promagent/promagent-dist/target/promagent.jar=port=9300 \
-jar gs-accessing-data-rest/complete/target/gs-accessing-data-rest-0.1.0.jar
```
Go to [http://localhost:8080](http://localhost:8080) to view the Spring Boot application,
go to [http://localhost:9300/metrics](http://localhost:9300/metrics) to view the Prometheus metrics.
Wildfly Demo
------------
Download and compile the [Promagent](https://github.com/fstab/promagent).
```bash
git clone https://github.com/fstab/promagent.git
cd promagent
mvn clean package
cd ..
```
Download and compile a [Wildfly Quickstart](https://github.com/wildfly/quickstart) application.
```bash
git clone https://github.com/wildfly/quickstart.git
cd quickstart/kitchensink
mvn clean package
cd ../..
```
Download and extract the [Wildfly application server](http://wildfly.org/).
```bash
curl -O http://download.jboss.org/wildfly/10.1.0.Final/wildfly-10.1.0.Final.tar.gz
tar xfz wildfly-10.1.0.Final.tar.gz
```
Run the Wildfly application server with the Promagent attached.
```bash
cd wildfly-10.1.0.Final
LOGMANAGER_JAR=$(find $(pwd) -name 'jboss-logmanager-*.jar')
export JAVA_OPTS="
-Xbootclasspath/p:${LOGMANAGER_JAR}
-Djboss.modules.system.pkgs=org.jboss.logmanager,io.promagent.agent
-Djava.util.logging.manager=org.jboss.logmanager.LogManager
-javaagent:../promagent/promagent-dist/target/promagent.jar=port=9300
"
./bin/standalone.sh
```
In a new Shell window, deploy the quickstart application.
```bash
cd wildfly-10.1.0.Final
./bin/jboss-cli.sh --connect --command="deploy ../quickstart/kitchensink/target/kitchensink.war"
```
Go to [http://localhost:8080/kitchensink](http://localhost:8080/kitchensink) to view the quickstart application,
go to [http://localhost:9300/metrics](http://localhost:9300/metrics) to view the Prometheus metrics.
Exposing Metrics
----------------
Promagent supports three different ways of exporting metrics for the Prometheus server:
* Pomagent has a built-in HTTP server. This is used in the examples above. The server is started when the
command line argument `port` is used, as for example `-javaagent:agent.jar=host=localhost,port=9300`.
The `host` argument is optional, it defaults to the wildcard IP address.
If `port` is omitted the built-in server is not started.
* The [promagent-exporter](https://github.com/fstab/promagent/tree/master/promagent-exporter) module implements
a simple Web application in WAR file format. If you deploy the _promagent-exporter/target/promagent.war_ on your
server, it will collect Promagent metrics via JMX and expose them under it's deployment URL,
like [http://localhost:8080/promagent](http://localhost:8080/promagent).
* All metrics are made available via JMX, so any JMX client can be used to access the metrics.
Status
------
This is a demo project. The main goal is to learn the internals of bytecode manipulation and class loading in Java application servers. I am planning to work on the following:
* Try it with more application servers ([Payara](http://www.payara.fish/), [TomEE](http://tomee.apache.org/)) and adjust the code if necessary.
* Add automated test, preferably integration tests that run an application server in a Docker container and check if the metrics are collected as expected.
* Write documentation about the internal implementation, mainly the bytecode manipulation and class loading aspects.
I am currently not planning to add a large number of out-of-the-box metrics. If you want to extend Promagent with your own metrics, do the following:
* Clone this project on [GitHub](https://github.com/fstab/promagent/).
* Copy the `ServletHook` or `JdbcHook` as a template for your own hook class.
* Add your hook class to the list of hooks in the `HookFactory`.
* In your hook class, adapt the `@Hook`, `@Before` and `@After` annotations as well as the `init()`, `before()` and `after()` methods.
* Of course, I am always happy to see people using this code. So if you like, please open a GitHub Issue and say "Hello" (GitHub Issues are not only for reporting problems, they are useful for any communication).
For examples of methods you might want to instrument, look at related projects, like [inspectIT](http://www.inspectit.rocks/) (hooks are configured [here](https://github.com/inspectIT/inspectIT/tree/master/inspectit.server/src/main/external-resources/ci/profiles/common)) or [stagemonitor](http://www.stagemonitor.org/).
Thank You ConSol
----------------
This project is supported as part of the R&D activities at [ConSol Software GmbH](https://www.consol.de/). See the [ConSol Labs Blog](https://labs.consol.de/) for more info.
Oops, something went wrong.

0 comments on commit 1ad1d1e

Please sign in to comment.