# Introduction

## Traffic-Hunter

**Traffic-Hunter** is APM (Application Performance Management)

* `Real-Time Monitoring`: Capture and visualize application metrics and transaction logs in real-time.
* `Easy Configuration`: Easily configure the agent using a simple YAML file, making setup straightforward and user-friendly.
* `Efficient Data Storage`: Leverages [**TimescaleDB**](https://www.timescale.com/) for efficient storage and querying of time-series data, enabling high-performance analytics on metrics and traces.
* `Visualization`: This APM leverages [**Grafana**](https://grafana.com/docs/grafana/latest/) for powerful and customizable visualization of metrics and transaction logs, enabling real-time insights and easy integration into your observability stack.
* `Zero-Code`: Traffic Hunter Agent uses **Java Instrumentation** to modify bytecode at runtime, requiring no code changes from users. Simply attach the agent, and it automatically tracks metrics and traces with zero configuration.

## Overview 

* **Application Metric** - cpu, heap memory, thread, web server, dbcp (database connection pool)

<figure><img src="https://github.com/user-attachments/assets/18866da9-8b64-4ea8-a703-18e23b61d756" alt=""><figcaption></figcaption></figure>

* **Trace** - Trace track application requests in real-time, recording executed methods and related information. (Support zipkin)

<figure><img src="/files/SmstpqvaMERKNbjUKoyQ" alt=""><figcaption></figcaption></figure>

* **Logs** - Logs from multiple applications can be centrally managed to enable efficient logging.

<figure><img src="/files/H8iiN161sEwTEujR2Pfp" alt=""><figcaption></figcaption></figure>

## Tech Stack

<table data-view="cards"><thead><tr><th></th><th></th><th data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td>TimescaleDB</td><td>Efficient Data Storage</td><td></td><td><a href="/files/JaaRfzYis2SbHevC4caR">/files/JaaRfzYis2SbHevC4caR</a></td></tr><tr><td>Grafana</td><td>Visualization</td><td></td><td><a href="/files/SOexI3tQoEnTaWWAfbBt">/files/SOexI3tQoEnTaWWAfbBt</a></td></tr><tr><td>Bytebuddy</td><td>Zero-Code</td><td></td><td><a href="/files/RsZXk5g0gw4KP7YXx9ug">/files/RsZXk5g0gw4KP7YXx9ug</a></td></tr><tr><td>OpenTelemetry</td><td>Observability</td><td><a href="https://opentelemetry.io/">https://opentelemetry.io/</a></td><td><a href="/files/cQZOo7bQppAmVqDpvnMs">/files/cQZOo7bQppAmVqDpvnMs</a></td></tr><tr><td>Zipkin</td><td>Trace Manger</td><td><a href="https://zipkin.io/">https://zipkin.io/</a></td><td><a href="/files/FOxNFFQsTD6Gol7J1KbM">/files/FOxNFFQsTD6Gol7J1KbM</a></td></tr></tbody></table>

## Supported instrumentation plugin

* The plugin attempts instrumentation with the following versions. If the version is too low, instrumentation may fail. If instrumentation is not attempted and a critical error occurs, please create a GitHub issue.

<table><thead><tr><th width="329.58203125">Instumentation plugin</th><th width="138.31640625">Version</th><th>Note</th></tr></thead><tbody><tr><td>Servlet</td><td>6.0.0+</td><td>Support jakarta,<br>Not Support javax</td></tr><tr><td>Spring web-mvc</td><td>6.2.0+</td><td></td></tr><tr><td>Spring Boot</td><td>3.2.0+</td><td>Support RestClinet<br>Not support RestTemplate</td></tr><tr><td>JDBC</td><td>Java 21+</td><td></td></tr><tr><td>HttpClient</td><td>Java 21+</td><td></td></tr><tr><td>HttpUrlConnection</td><td>Java 21+</td><td></td></tr><tr><td>Hibernate</td><td>6.0.0+</td><td>LikageError Issue, <br>Not Support</td></tr><tr><td>Logger</td><td>Java 21+</td><td>java.util.Logger</td></tr><tr><td>LogBack</td><td>1.5.0+</td><td>ch.qos.logback</td></tr></tbody></table>

## Architecture

* Traffic Hunter operates as a push model.

![Traffic Hunter Architecture](/files/5xTXYZv0CROQSxqYFaZH)

## License

```
The MIT License

Copyright (c) 2024 traffic-hunter.org

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://traffic-hunter.gitbook.io/traffic-hunter/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.