清道夫

随着系统老化，由于需求和规格变更，越来越多未使用的代码（即"死代码"）会堆积起来。

清道夫项目起源于codekvast。 Codekvast是首个能够在Java中进行运行时死代码分析的工具。 清道夫提供了更加精细和清晰的用户界面，并通过重写大部分代码来完善了插桩逻辑。

组件

• 清道夫代理
  • 收集代码库并定期向收集器发送宿主应用程序的调用信息。
• 清道夫收集器
  • 将从代理接收到的数据存储在数据库中。
  • 清理垃圾数据。
• 清道夫API
  • 提供用于探索调用的API。
• 清道夫前端
  • 提供用户界面。
• 清道夫Python代理（测试版）
  • 上述清道夫代理的Python版本。

特性

• 无需更改代码即可分析运行时死代码。
• 支持基于JVM的语言。
  • 不再正式支持Java 1.7的代理。
    • 但如果无法避免，请使用旧版代理。
• 提供基于Web的界面，用于项目管理、调用快照和项目仪表板。
• 支持MySQL、Vitess和H2作为数据库。

下载

您可以在以下链接下载最新版本的清道夫。

• 收集器、API
  • https://github.com/naver/scavenger/releases
• Java代理
  • 从以下地址下载最新版本 https://repo1.maven.org/maven2/com/navercorp/scavenger/scavenger-agent-java/{VERSION}/scavenger-agent-java-{VERSION}.jar
    • 您可以在maven中央仓库中找到最新的VERSION
• 旧版Java代理（支持Java 1.7但不再维护）
  • 从以下地址下载最新版本 https://repo1.maven.org/maven2/com/navercorp/scavenger/scavenger-old-agent-java/{VERSION}/scavenger-old-agent-java-{VERSION}.jar
    • 您可以在maven中央仓库中找到最新的VERSION

文档

您可以在以下链接找到安装指南。

• https://github.com/naver/scavenger/blob/develop/doc/installation.md

您可以在以下链接找到用户指南。

• https://github.com/naver/scavenger/blob/develop/doc/user-guide.md

贡献？

清道夫欢迎用户的任何贡献。
拉取请求是提出代码库更改的最佳方式。我们积极欢迎您的拉取请求：

1. 从develop分支创建您的分支。
2. 如果您添加了应该测试的代码，请添加测试。
3. 确保测试套件通过。
4. 提交拉取请求！

版本控制

为了提高透明度和洞察我们的发布周期，并努力保持向后兼容性，清道夫将尽可能遵循语义版本控制指南。

版本号将按以下格式编号：

  `<主版本>.<次版本>.<修订版本>`

版本将根据以下指南构建：

• 破坏向后兼容性的更改会增加主版本号（并重置次版本号和修订版本号）
• 在不破坏向后兼容性的情况下添加新功能会增加次版本号（并重置修订版本号）
• Bug修复和小型增强更改会增加修订版本号

问答和Bug跟踪

发现明显的bug？有绝妙的改进想法？请在GitHub上创建一个问题，以便通知我们！

• https://github.com/naver/scavenger/issues

许可证

Copyright 2023-present NAVER Corp.

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.