> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/traceable/agent-docs/java.md).

# Java Agent

This section provides comprehensive documentation for the Traceable Java Agent, enabling you to secure and monitor your Java applications with minimal code changes.

## Getting Started

### Prerequisites

* Java 8 or later
* JVM-based application
* Network connectivity to Traceable Platform
* [Download the latest Java Agent](https://downloads.traceable.ai/)

### Supported Frameworks

| Library/Framework      | Versions      |
| ---------------------- | ------------- |
| Apache HttpAsyncClient | 4.1+          |
| Apache HttpClient      | 4.0+          |
| gRPC                   | 1.6+          |
| JAX-RS Client          | 2.0+          |
| Micronaut (via Netty)  | 1.0+          |
| Netty                  | 4.0+          |
| OkHttp                 | 3.0+          |
| Servlet                | 2.3, 3.0, 5.0 |
| Spark Web Framework    | 2.3+          |
| Spring Webflux         | 5.0+          |
| Vert.x                 | 3.0+          |
| Struts                 | 2.3+          |
| Undertow               | 1.4+          |

> Traceable also supports any framework that uses one of the above as an underlying framework.

### Quick Start

1. Download the latest Java Agent
2. Add the agent to your JVM startup parameters
3. Configure your environment variables
4. Start your application

Example:

```bash
java -javaagent:/path/to/traceable-java-agent.jar \
     -DTRACEABLE_AGENT_SERVICE_NAME=my-java-app \
     -DTRACEABLE_AGENT_ENVIRONMENT=production \
     -jar your-application.jar
```

## Installation Options

### VM-Based Installation

For standard JVM deployments:

* [Installation Guide](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/java/install-options/VM/InstallationSteps.md)
* [Configuration Reference](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/java/install-options/VM/Configuration.md)
* [Troubleshooting](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/java/install-options/VM/Troubleshooting.md)

## Verification

After installation, verify that:

1. The agent is loaded in your application logs
2. API calls appear in the Traceable dashboard
3. No errors are reported in the agent logs

## Troubleshooting

Troubleshooting guide is available [here](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/java/install-options/VM/Troubleshooting.md).

## Quick Links

* [VM Installation](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/java/install-options/VM/InstallationSteps.md)
* [Configuration Reference](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/java/install-options/VM/Configuration.md)
* [Troubleshooting Guide](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/java/install-options/VM/Troubleshooting.md)
* [Install Option](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/java/install-options/README.md)
* [K8s Installation](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/java/install-options/k8s/InstallationSteps.md)
* [Vulnerability Reports](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/java/vulnerability-reports/README.md)