# hawkular-apm

**Repository Path**: trf.com/hawkular-apm

## Basic Information

- **Project Name**: hawkular-apm
- **Description**: Distributed Tracing and Application Performance Management
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2016-12-30
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Hawkular-APM
============

[![Travis](https://travis-ci.org/hawkular/hawkular-apm.svg?branch=master)](https://travis-ci.org/hawkular/hawkular-apm)
[![Jira Issues](https://img.shields.io/badge/Jira-issues-blue.svg)](https://issues.jboss.org/projects/HWKAPM/issues)
[![Join the chat at freenode:hawkular](https://img.shields.io/badge/irc-freenode%3A%20%23hawkular-blue.svg)](http://webchat.freenode.net/?channels=%23hawkular)

is the **Application Performance Management** solution offering:

* Distributed Tracing (e.g. for microservices)
* Application Performance Management
* Business Transaction Management (currently only using JVM javaagent based approach)

Applications can be instrumented, using a non-intrusive Java agent approach for JVM based applications, or through
[Zipkin client libraries](http://zipkin.io/pages/existing_instrumentations.html) (for polyglot environment).

In other words Hawkular APM provides the capabilities to monitor the flow of invocations
across servers, tiers, on-premises and in the cloud. It also enables detailed
performance analysis to be performed of the individual components that make up an
application.

Running the latest version in OpenShift
---

A Docker image with the latest released version of Hawkular APM is published to Docker Hub. Additionally,
we keep a set of files that can be used in conjunction with OpenShift, to enable a quick and easy way to
start a new Hawkular APM instance. If you want to start this way, this is what you'll need:

```shell
docker-machine create -d virtualbox --virtualbox-memory 8192 --virtualbox-cpu-count 4 --engine-insecure-registry 172.30.0.0/16 openshift
oc cluster up --docker-machine=openshift
oc create -f https://raw.githubusercontent.com/jboss-dockerfiles/hawkular-apm/master/openshift-templates/hawkular-apm-server-deployment.yml
```
Note: you should be able to start with a simple `oc cluster up`, but allocating more power to the underlying `docker-machine` is a good idea.

Build & Run
-----------

To build and run execute:

```shell
$ mvn clean install -Pdev -DskipTests [-Pitest]
$ dist/target/hawkular-apm-${version}/bin/standalone.sh [-Djboss.http.port=9411]

-> go to http://localhost:[8080|9411]/ and log in with jdoe:password
```

The parameters to these commands are:

* `-Djboss.http.port=9411` - bind APM port to [Zipkin](http://zipkin.io/) 9411 port. Default APM port is 8080.
* `-Pdev` - create user jdoe:password
* `-Pitest` - run integration tests

Add non-intrusive Java instrumentation to instrument your applications ([doc](https://hawkular.gitbooks.io/hawkular-apm-user-guide/content/installation/JVMAGENT.html)):
```shell
$ source dist/target/hawkular-apm-${version}/apm/setenv.sh <APM server port>

-> restart your Java applications
```

Documentation
-------------

Project documentation can be found [here](https://hawkular.gitbooks.io/hawkular-apm-user-guide/content/).

REST API documentation can be generated using `-Pdocgen` profile. The doc is generated under `rest/target` folder.

```shell
$ mvn clean install -Pdocgen
```

Project Structure
-----------------

The project is divided into several areas:

Folder | Description
---- | ----
**api** | This module contains the Java interfaces for services and processors, as well as the information model for exchanging business transaction information.
**client** | This folder contains the modules used to collector information from an execution environment.
**dist** | This module builds a distribution containing a pre-packaged Hawkular server with APM installed.
**examples** | This folder contains example applications.
**server** | This folder contains the modules related to the server.
**tests** | This folder contains the integration tests.
**ui** | The angularjs based user interface.

Related Repositories
--------------------
* [Hawkular-APM OpenTracing JavaScript](https://github.com/hawkular/hawkular-apm-opentracing-javascript)
* [Docker images](https://github.com/jboss-dockerfiles/hawkular-apm)
* [Documentation](https://github.com/hawkular/hawkular-apm-user-guide)

License
-------

Hawkular-APM is released under Apache License, Version 2.0 as described in the [LICENSE](LICENSE) document

```
   Copyright 2015-2016 Red Hat, Inc.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
```