Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inspectit/inspectit-ocelot
inspectIT Ocelot - Java agent for collecting application performance, tracing and behavior data
https://github.com/inspectit/inspectit-ocelot
agent apm application-monitoring end-user-monitoring hacktoberfest java-agent jvm monitoring observability openapm opencensus opentelemetry
Last synced: about 1 month ago
JSON representation
inspectIT Ocelot - Java agent for collecting application performance, tracing and behavior data
- Host: GitHub
- URL: https://github.com/inspectit/inspectit-ocelot
- Owner: inspectIT
- License: apache-2.0
- Created: 2018-12-03T07:19:51.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-21T12:25:13.000Z (about 2 months ago)
- Last Synced: 2024-09-26T07:01:57.935Z (about 2 months ago)
- Topics: agent, apm, application-monitoring, end-user-monitoring, hacktoberfest, java-agent, jvm, monitoring, observability, openapm, opencensus, opentelemetry
- Language: Java
- Homepage: http://www.inspectit.rocks/
- Size: 90.1 MB
- Stars: 202
- Watchers: 20
- Forks: 69
- Open Issues: 167
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# inspectIT Ocelot
[](https://jitpack.io/#inspectit/inspectit-ocelot)
[](https://codecov.io/gh/inspectIT/inspectit-ocelot)
[](https://github.com/inspectIT/inspectit-ocelot/actions?query=workflow%3A"Java+Agent+Tests")
[](https://github.com/inspectIT/inspectit-ocelot/actions?query=workflow%3A"Configuration+Server+Tests")
[](https://github.com/inspectIT/inspectit-ocelot/actions/workflows/configuration_ui_test.yml?query=workflow%3A"Configuration+UI+Tests")
[inspectIT Ocelot](https://inspectit.rocks/) is a zero-configuration Java agent for dynamically collecting application performance,
tracing and behavior data based on the [OpenTelemetry SDK](https://github.com/open-telemetry/opentelemetry-java) for Tracing and [OpenCensus library](https://opencensus.io/) for Metrics-Export.
Despite the zero-configuration capability, it provides a powerful configuration feature
which enables a full and in-depth customization of all features.
In order to use inspectIT Ocelot, the source code of the target application does
**not** have to be touched, changed or modified - even access to the actual source code is not required.
It automatically injects all required components and executes the necessary actions by itself.
Compared to the former [inspectIT](https://github.com/inspectIT/inspectIT),
Ocelot follows the approach of focusing on compatibility and interaction with other awesome open source tools.
For this purpose the agent includes data exporters for tools and frameworks like [Prometheus](https://prometheus.io/), [Zipkin](https://zipkin.io/) or [Jaeger](https://www.jaegertracing.io/).
This allows us to use and interact with well-known and established tools like [Elasticsearch](https://www.elastic.co/products/elasticsearch), [InfluxDB](https://www.influxdata.com/) or [Grafana](https://grafana.com/),
reducing the amount of components which have to be introduced into an existing infrastructure or which need to be familiarized with.
## Collected Data
The inspectIT Ocelot Java agent collects a lot of different data, namely metrics and traces.
You can fully customize the metrics and traces you want to collect via the [configuration](https://inspectit.github.io/inspectit-ocelot/docs/next/instrumentation/instrumentation).
With respect to our zero-configuration goal, the agent already ships with a default configuration capturing useful data for you.
For example, the following system and JVM metrics are captured by default:
* CPU (usage and number of cores)
* Disk Space (used, free and total)
* Memory (used and available for various regions like heap or non-heap)
* Threads (counts and states)
* Garbage Collection (pause times and collection statistics)
* Class Loading (loaded and unloaded counts)
In addition, the response times for sent and received HTTP requests are collected
and tagged with relevant information such as the response code or the HTTP method.
Ocelot also collects response times and invocation counts for remote calls between your services.
Hereby, it is automatically detected whether the call was made to an internal or external service.
The resulting metric can then then be visualized for example
using the [Grafana Service Graph Panel](https://github.com/NovatecConsulting/novatec-service-dependency-graph-panel):
In addition, the agent provides out-of-the-box support for tracing, even across JVM borders.
You can easily record your traces and enrich them with metadata extracted from your application at runtime:
Checkout the [documentation](https://inspectit.github.io/inspectit-ocelot/) to find out how you can extract custom metrics and traces.
## Demo
You want to see the inspectIT Ocelot Java agent in action?
No problem!
We've prepared a nice containerized demo to show what the agent is capable of.
The demo consists of two different scenarios, whereby we would like to emphasize the flexibility of the agent and therefore each scenario uses a different set of tools.
All you have to do is to download the [demo archive](https://github.com/inspectIT/inspectit-ocelot/releases/latest) and start it with docker-compose:
* `$ docker-compose -f docker-compose-prometheus-jaeger.yml up`
* `$ docker-compose -f docker-compose-influxdb-jaeger.yml up`
* `$ docker-compose -f docker-compose-influxdb-zipkin.yml up`
Check out the [documentation's demo section](https://inspectit.github.io/inspectit-ocelot/docs/getting-started/docker-examples) for detailed information on each scenario.
## Installation
Getting started with the inspectIT Ocelot Java agent is very easy!
First of all, you have to download the Java agent.
You can find all released versions in the release section of this repository: https://github.com/inspectIT/inspectit-ocelot/releases
The easiest way to use the inspectIT Ocelot Java agent is to attach it to your Java application during startup.
This can be achieved using the `-javaagent` command-line option of your JVM and referencing the agent Jar:
$ java -javaagent:"/path/to/inspectit-ocelot-agent.jar" -jar my-java-program.jar
#### Attaching the Agent to a Running JVM
We also support attaching the inspectIT Ocelot Java agent to an already running JVM.
In such a scenario the collection of metrics and traces will start from the point of the attachment.
Please read the [documentation](https://inspectit.github.io/inspectit-ocelot/docs/getting-started/installation#attaching-the-agent-to-a-running-jvm) how this can be achieved.
## Configuration
The inspectIT Ocelot Java agent offers a comprehensive configuration capability which allows you to customize all properties to your own needs.
In addition, the agent also supports **hot reloading** for its configuration which makes it possible to modify individual configuration settings during runtime without having to restart the application, which is usually the case.
The configuration hot reloading feature also allows you to start the agent in a kind of "standby state" with deactivated features and activate these at a later point in time.
Currently, the configuration values can be set using [environment variables, system properties](https://inspectit.github.io/inspectit-ocelot/docs/configuration/configuration-sources#java-system-properties) or [configuration files](https://inspectit.github.io/inspectit-ocelot/docs/configuration/external-configuration-sources#file-based-configuration).
This allows you to pass configuration values to the agents by, for example, using Puppet to set specific properties or using Ansible to roll out updated configuration files which then will be hot reloaded.
For detailed information about the configuration see the [related section of the documentation](https://inspectit.github.io/inspectit-ocelot/docs/configuration/configuration-sources).
## Documentation
A detailed user documentation can be found at: http://docs.inspectit.rocks/
You need a documentation of an earlier version? No problem! All the released documentation can be found [here](https://inspectit.github.io/inspectit-ocelot/versions).
If you cannot wait for the next stable release and want to use an agent based on the current master branch, the corresponding documentation can be found [here](https://inspectit.github.io/inspectit-ocelot/docs/next/doc1).
## Contribution and Development
If you want to contribute anything to this project, feel free to open a pull request or reach out to us!
A good starting point is the [CONTRIBUTING.md](CONTRIBUTING.md).
If you need additional or in-depth information on the actual implementation of inspectIT Ocelot, check out the README files in the child projects of this repository.
#### Thanks to all people who have already contributed!
## How to Release
Important tasks to check first are `dependencyUpdates` or `dependencyUpdates[Major|Minor]` for newer (patch, minor, major)
versions, the `outdated` task for node modules and `dependencyCheckAnalyze` or `dependencyCheckAggregate` for security issues in the used dependencies (including node modules).
All dependency versions are maintained in one [catalog](gradle/libs.version.toml) file. The task `versionCatalogUpdate[ConfigServerLibs] --interactive` creates a copy of the catalog file with all version
updates. This file can also be edited manually and be applied with `versionCatalogApplyUpdates[ConfigServerLibs]`.
## FAQ
#### Is it pronounced inspect-"IT" or "it"?
It's like "inspect it" and not like IT in information technology. `/ɪnˈspektɪt/` :)
#### Can I use the agent on an application using Java 6?
No. The Java agent is developed against Java 8, thus, the application which you want to attach the agent to have to be using a JVM running on Java 8 or higher.
#### Does the agent require a specific JVM in order to run properly?
No. The agent is compatible to and can be used with any kind of JVM (Oracle JVM, an OpenJDK, an IBM JVM, ...), as long as it supports the `javaagent` argument and provides Java 8 or higher.
#### My application is already using OpenCensus. Can I use the agent anyway?
Yes, you can use the inspectIT Ocelot Java agent if you already use the OpenCensus library.
However, there are a few points that need to be considered to ensure a smooth operation.
Please read the [corresponding section in the documentation](https://inspectit.github.io/inspectit-ocelot/docs/next/configuration/open-census-configuration).
#### How can I start my application with the inspectIT Ocelot Java agent?
We have a [detailed section in the documentation](https://inspectit.github.io/inspectit-ocelot/docs/next/getting-started/installation) about this topic.
The easiest way is to add the `javaagent` argument to your Java command like [described above](#installation).
#### My Java application does not start or it exits immediately when I use the agent.
In this case, check your Java command and ensure that you have not accidentally removed your application.
You'll most likely have a command like `java -javaagent:inspectit-ocelot-agent.jar` or `java -javaagent:inspectit-ocelot-agent.jar -version`.
Starting Java without an application but the agent will work but does not make sense because the agent will initialize itself and then the JVM will properly shut down because it has no application to execute.
It's like executing just `java`.
## Behind the Scenes
inspectIT Ocelot is mainly driven by [Novatec Consulting GmbH](https://www.novatec-gmbh.de/), a German consultancy firm that specializes in software performance.