inspectIT Ocelot
inspectIT Ocelot是一个零配置Java代理,用于动态收集应用性能、跟踪和行为数据,基于OpenTelemetry SDK进行跟踪和OpenCensus库进行指标导出。尽管具有零配置能力,它还提供了强大的配置功能,可以全面深入地自定义所有功能。使用inspectIT Ocelot时,无需触碰、更改或修改目标应用的源代码,甚至不需要访问实际源代码。它会自动注入所有必需的组件并自行执行必要的操作。
与之前的inspectIT相比,Ocelot采取了专注于与其他优秀开源工具兼容和交互的方法。为此,该代理包含了用于Prometheus、Zipkin或Jaeger等工具和框架的数据导出器。这使我们能够使用和交互知名且成熟的工具,如Elasticsearch、InfluxDB或Grafana,从而减少需要引入现有基础设施或需要熟悉的组件数量。
收集的数据
inspectIT Ocelot Java代理收集了许多不同的数据,即指标和跟踪。您可以通过配置完全自定义想要收集的指标和跟踪。为了实现零配置目标,该代理已经附带了默认配置,为您捕获有用的数据。
例如,默认情况下会捕获以下系统和JVM指标:
- CPU(使用率和核心数)
- 磁盘空间(已用、可用和总量)
- 内存(堆或非堆等各种区域的已用和可用)
- 线程(数量和状态)
- 垃圾回收(暂停时间和收集统计)
- 类加载(已加载和未加载数量)
此外,还会收集发送和接收的HTTP请求的响应时间,并标记相关信息,如响应代码或HTTP方法。
Ocelot还收集服务之间远程调用的响应时间和调用次数。在这里,会自动检测调用是针对内部还是外部服务。然后可以使用Grafana Service Graph Panel等工具可视化结果指标:
此外,该代理还提供开箱即用的跟踪支持,甚至可以跨JVM边界。您可以轻松记录跟踪,并用运行时从应用程序中提取的元数据丰富它们:
查看文档了解如何提取自定义指标和跟踪。
演示
想看inspectIT Ocelot Java代理的实际运行效果吗?没问题!我们准备了一个不错的容器化演示,展示代理的功能。演示包括两个不同的场景,我们希望强调代理的灵活性,因此每个场景使用不同的工具集。
您只需下载演示存档并使用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
查看文档的演示部分了解每个场景的详细信息。
安装
开始使用inspectIT Ocelot Java代理非常简单!
首先,您需要下载Java代理。您可以在此存储库的发布部分找到所有已发布版本:https://github.com/inspectIT/inspectit-ocelot/releases
使用inspectIT Ocelot Java代理最简单的方法是在启动Java应用程序时附加它。这可以通过使用JVM的-javaagent
命令行选项并引用代理Jar来实现:
$ java -javaagent:"/path/to/inspectit-ocelot-agent.jar" -jar my-java-program.jar
将代理附加到正在运行的JVM
我们还支持将inspectIT Ocelot Java代理附加到已经运行的JVM。在这种情况下,指标和跟踪的收集将从附加点开始。请阅读文档了解如何实现这一点。
配置
inspectIT Ocelot Java代理提供了全面的配置能力,允许您根据自己的需求自定义所有属性。此外,代理还支持配置的热重载,这使得在运行时修改单个配置设置成为可能,而无需重启应用程序,这通常是必要的。
配置热重载功能还允许您以一种"待机状态"启动代理,禁用某些功能,并在稍后的时间点激活这些功能。 目前,可以使用环境变量、系统属性或配置文件来设置配置值。 这允许您通过例如使用Puppet设置特定属性或使用Ansible部署更新的配置文件(随后将热重载)来向代理传递配置值。
有关配置的详细信息,请参阅文档的相关部分。
文档
详细的用户文档可在以下网址找到:http://docs.inspectit.rocks/
需要早期版本的文档?没问题!所有已发布的文档都可以在这里找到。
如果您等不及下一个稳定版本,想要使用基于当前master分支的代理,相应的文档可以在这里找到。
贡献和开发
如果您想为这个项目做出任何贡献,欢迎提交拉取请求或与我们联系! 一个好的起点是CONTRIBUTING.md。
如果您需要有关inspectIT Ocelot实际实现的额外或深入信息,请查看此存储库子项目中的README文件。
感谢所有已经做出贡献的人!
如何发布
首先要检查的重要任务是dependencyUpdates
或dependencyUpdates[Major|Minor]
以查看较新的(补丁、次要、主要)版本,outdated
任务用于检查node模块,以及dependencyCheckAnalyze
或dependencyCheckAggregate
用于检查所使用依赖项(包括node模块)中的安全问题。
所有依赖版本都维护在一个catalog文件中。任务versionCatalogUpdate[ConfigServerLibs] --interactive
会创建一个包含所有版本更新的catalog文件副本。这个文件也可以手动编辑,并通过versionCatalogApplyUpdates[ConfigServerLibs]
应用。
常见问题
是发音为inspect-"IT"还是"it"?
它的发音像"inspect it"而不是信息技术中的IT。 /ɪnˈspektɪt/
:)
我可以在使用Java 6的应用程序上使用该代理吗?
不可以。Java代理是针对Java 8开发的,因此,您想要附加代理的应用程序必须使用运行在Java 8或更高版本的JVM。
代理是否需要特定的JVM才能正常运行?
不需要。只要支持javaagent
参数并提供Java 8或更高版本,该代理就可以与任何类型的JVM(Oracle JVM、OpenJDK、IBM JVM等)兼容并使用。
我的应用程序已经在使用OpenCensus。我还能使用这个代理吗?
是的,即使您已经使用OpenCensus库,也可以使用inspectIT Ocelot Java代理。 然而,为了确保顺利运行,需要考虑一些要点。 请阅读文档中的相应部分。
我如何使用inspectIT Ocelot Java代理启动我的应用程序?
我们在文档中有一个详细的章节关于这个主题。
最简单的方法是像上面描述的那样将javaagent
参数添加到您的Java命令中。
当我使用代理时,我的Java应用程序不启动或立即退出。
在这种情况下,检查您的Java命令,确保您没有意外删除您的应用程序。
您很可能有一个像java -javaagent:inspectit-ocelot-agent.jar
或java -javaagent:inspectit-ocelot-agent.jar -version
这样的命令。
启动Java时没有应用程序但有代理是可以的,但没有意义,因为代理会初始化自己,然后JVM会正常关闭,因为它没有要执行的应用程序。
这就像只执行java
一样。
幕后
inspectIT Ocelot主要由Novatec Consulting GmbH驱动,这是一家专门从事软件性能的德国咨询公司。