Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hypertrace/javaagent
Hypertrace OpenTelemetry Java agent with payload/body and headers data capture.
https://github.com/hypertrace/javaagent
apm-agent apm-instrumentation javaagent opentelemetry opentelemetry-java-agent tracing
Last synced: about 1 month ago
JSON representation
Hypertrace OpenTelemetry Java agent with payload/body and headers data capture.
- Host: GitHub
- URL: https://github.com/hypertrace/javaagent
- Owner: hypertrace
- License: apache-2.0
- Created: 2020-10-08T11:12:36.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-23T12:33:29.000Z (3 months ago)
- Last Synced: 2024-11-15T22:40:44.674Z (about 1 month ago)
- Topics: apm-agent, apm-instrumentation, javaagent, opentelemetry, opentelemetry-java-agent, tracing
- Language: Java
- Homepage:
- Size: 1.64 MB
- Stars: 34
- Watchers: 4
- Forks: 15
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Hypertrace OpenTelemetry Java agent
Hypertrace distribution of [OpenTelemetry Java agent](https://github.com/open-telemetry/opentelemetry-java-instrumentation).
This agent supports [these frameworks](https://github.com/open-telemetry/opentelemetry-java-instrumentation#supported-java-libraries-and-frameworks)
and adds following capabilities:
* capture request and response headers
* capture request and response bodies
* server request headers/bodies evaluation in agent filter that can result in request blocking.
The filter implementation will be pluggable.
List of supported frameworks with additional capabilities:
| Library/Framework | Versions |
|--------------------------------------------------------------------------------------------------------|-----------------|
| [Apache HttpAsyncClient](https://hc.apache.org/index.html) | 4.1+ |
| [Apache HttpClient](https://hc.apache.org/index.html) | 4.0+ |
| [gRPC](https://github.com/grpc/grpc-java) | 1.6+ |
| [JAX-RS Client](https://javaee.github.io/javaee-spec/javadocs/javax/ws/rs/client/package-summary.html) | 2.0+ |
| [Micronaut](https://micronaut.io/) (basic support via Netty) | 1.0+ |
| [Netty](https://github.com/netty/netty) | 4.0+ |
| [OkHttp](https://github.com/square/okhttp/) | 3.0+ |
| [Servlet](https://javaee.github.io/javaee-spec/javadocs/javax/servlet/package-summary.html) | 3.0+ |
| [Spark Web Framework](https://github.com/perwendel/spark) | 2.3+ |
| [Spring Webflux](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/reactive/package-summary.html) | 5.0+ |
| [Vert.x](https://vertx.io) | 3.0+ (4 not supported yet) |
| [Struts](https://struts.apache.org/) | 2.3+ |
### Adding custom filter implementation
Custom filter implementations can be added via `FilterProvider` SPI (Java service loader).
The providers can be disabled at startup via `ht.filter.provider..disabled=true`.
## Build
```bash
make init-submodules build
```
The final artifact is in `javaagent/build/libs/hypertrace-agent--all.jar`
## Run & Configure
Download the [latest version](https://github.com/hypertrace/javaagent/releases/latest/download/hypertrace-agent-all.jar).
```bash
HT_REPORTING_ENDPOINT=http://localhost:4317 java -javaagent:javaagent/build/libs/hypertrace-agent--all.jar -jar app.jar
```
By default the agent uses Otlp exporter.
The configuration precedence order
1. OpenTelemetry Agent's trace config file `OTEL_TRACE_CONFIG`/`otel.trace.config`
2. OpenTelemetry system properties and env variables
3. Hypertrace configuration with the following precedence order:
1. system properties
2. environment variables, TODO add link to agent-config repo
3. [configuration file](./example-config.yaml), specified `HT_CONFIG_FILE=example-config.yaml`
### Disable instrumentation at startup
Instrumentations can be disabled by `-Dotel.instrumentation..enabled=false`.
The following instrumentation names disable only Hypertrace instrumentations, not core OpenTelemetry:
* `ht` - all Hypertrace instrumentations
* `servlet-ht` - Servlet, Spark Web
* `okhttp-ht` - Okhttp
* `grpc-ht` - gRPC
The Hypertrace instrumentations use also the core OpenTelemetry instrumentation names so for example
`-Dotel.instrumentation.servlet.enabled=false` disables all servlet instrumentations including core
OpenTelemetry and Hypertrace.
## Test
Tests use docker via Testcontainers.org.
When running tests from IDE set `SMOKETEST_JAVAAGENT_PATH` env variable.
```bash
make test
```
### Further Reference
Read more in our 'Introducing Hypertrace [Java Agent](https://blog.hypertrace.org/blog/introducing-hypertrace-java-agent/)' blog post.