forked from apache/ozhera
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'apache:master' into master
- Loading branch information
Showing
148 changed files
with
1,028 additions
and
560 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
---` | ||
|
||
name: Bug Report | ||
|
||
about: If you would like to report an issue to Apache OzHera(Incubating), please use this template. | ||
` | ||
--- | ||
|
||
### Ⅰ. Issue Description | ||
|
||
|
||
### Ⅱ. Describe what happened | ||
|
||
If there is an exception, please attach the exception trace: | ||
|
||
``` | ||
Just paste your stack trace here | ||
``` | ||
|
||
|
||
### Ⅲ. Describe what you expected to happen | ||
|
||
|
||
### Ⅳ. How to reproduce it (as minimally and precisely as possible) | ||
|
||
1. xxx | ||
2. xxx | ||
3. xxx | ||
|
||
Minimal yet complete reproducer code (or URL to code): | ||
|
||
|
||
|
||
### Ⅴ. Anything else we need to know? | ||
|
||
|
||
### Ⅵ. Environment: | ||
|
||
- JDK version (e.g. `java -version`): | ||
- Apache OzHera(Incubating) version: | ||
- Kubernetes version: | ||
- OS (e.g. `uname -a`): | ||
- Others: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
name: Feature Request | ||
|
||
about: Suggest an idea for Apache OzHera(Incubating) | ||
|
||
--- | ||
|
||
## Why you need it? | ||
Is your feature request related to a problem? Please describe in details | ||
|
||
|
||
## How it could be? | ||
A clear and concise description of what you want to happen. You can explain more about input of the feature, and output of it. | ||
|
||
|
||
## Other related information | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
|
||
name: Major Project Proposal | ||
|
||
about: Use this template to report major proposal on the Apache OzHera(Incubating) project. | ||
|
||
--- | ||
|
||
### Ⅰ. Proposal Summary | ||
|
||
Provide a brief overview of the significant proposal or change in the project. | ||
|
||
### Ⅱ. Details of the Proposal | ||
|
||
Explain the proposal in detail. Include any relevant context or background information: | ||
|
||
- What changed? | ||
- Why was this update necessary? | ||
|
||
### Ⅲ. Expected Impact | ||
|
||
Describe the expected impact of this proposal, including but not limited to: | ||
|
||
- Performance improvements | ||
- API changes or additions | ||
- New features or functionalities | ||
- Changes to project dependencies | ||
|
||
### Ⅳ. Implementation Details | ||
|
||
Provide specific details on how the update was implemented: | ||
|
||
1. Key steps or phases | ||
2. Codebase changes (include links if possible) | ||
3. Testing procedures or verification methods | ||
|
||
### Ⅴ. Next Steps or Follow-Up Actions | ||
|
||
List any further actions or next steps following this update, such as: | ||
|
||
- Future improvements or adjustments | ||
- Additional testing or validation needs | ||
- Related updates or dependencies to track | ||
|
||
### Ⅵ. Related Documentation | ||
|
||
Attach any related documentation, guides, or links to further information for the community. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<!-- Please make sure you have read and understood the contributing guidelines --> | ||
|
||
### Ⅰ. Describe what this PR did | ||
|
||
|
||
### Ⅱ. Does this pull request fix one issue? | ||
<!-- If that, add "fixes #xxx" below in the next line, for example, fixes #97. --> | ||
|
||
|
||
### Ⅲ. Why don't you add test cases (unit test/integration test)? | ||
|
||
|
||
### Ⅳ. Describe how to verify it | ||
|
||
|
||
### Ⅴ. Special notes for reviews | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
# Contributing to the Apache OzHera(incubating) Project | ||
|
||
If you’re interested in identifying vulnerabilities or improving the Apache OzHera(incubating) project, we warmly welcome your involvement. Below is a guide to help you get started with contributing. | ||
|
||
[[Chinese Contributing Document](./CONTRIBUTING_CN.md)] | ||
|
||
## Topics | ||
|
||
* [Reporting Security Issues](#reporting-security-issues) | ||
* [Reporting General Issues](#reporting-general-issues) | ||
* [Code and Documentation Contributions](#code-and-documentation-contributions) | ||
* [Test Case Contributions](#test-case-contributions) | ||
* [Participating in Any Way](#participating-in-any-way) | ||
* [Code Style](#code-style) | ||
|
||
## Reporting Security Issues | ||
|
||
Security issues are handled with top priority. Please avoid public discussions of security vulnerabilities. If you discover a security issue in Apache OzHera(incubating), report it confidentially via email to [[email protected]](mailto:[email protected]). | ||
|
||
## Reporting General Issues | ||
|
||
User feedback is crucial to Apache OzHera(incubating)'s growth. After using Apache OzHera(incubating), feel free to share your suggestions or issues by creating a [New Issue](https://github.com/apache/ozhera/issues/new/choose). To improve communication efficiency, we encourage you to search for similar issues before opening a new one. Add your details to an existing issue when relevant rather than creating a duplicate. | ||
|
||
Consider opening a new issue for: | ||
|
||
* Bug Reports | ||
* Feature Requests | ||
* Performance Issues | ||
* Functional Enhancements or Design Suggestions | ||
* Testing Improvements | ||
* Incomplete Documentation | ||
* Other project-related inquiries | ||
|
||
When reporting issues, please ensure to remove sensitive information such as passwords, keys, or private business data. | ||
|
||
## Code and Documentation Contributions | ||
|
||
We welcome all contributions that improve the Apache OzHera(incubating) project. On GitHub, all enhancements can be implemented through Pull Requests (PRs): | ||
|
||
* If you spot typos or mistakes, please correct them! | ||
* If you identify areas for improvement, submit an enhancement! | ||
* If documentation is inaccurate or incomplete, update it! | ||
|
||
> We look forward to your PR. | ||
Please review Apache OzHera(incubating)'s guidelines on submitting PRs: | ||
|
||
* [Workspace Preparation](#workspace-preparation) | ||
* [Branch Definitions](#branch-definitions) | ||
* [Commit Guidelines](#commit-guidelines) | ||
* [PR Descriptions](#pr-descriptions) | ||
|
||
### Workspace Preparation | ||
|
||
Please fork the project and clone it to your local machine for development. Once you set up the remote repository, you can easily sync your code with upstream branches. | ||
|
||
### Branch Definitions | ||
|
||
The Apache OzHera(incubating) project uses the following branch types: | ||
|
||
* **Development Branch**: For developing all new features and improvements | ||
* **Release Branch**: Created when a version is officially released | ||
* **Hotfix Branch**: Used to address urgent issues in the release version | ||
|
||
### Commit Guidelines | ||
|
||
We emphasize high-quality commits, which includes: | ||
|
||
* Commit Messages: Use clear and specific commit messages, such as `docs: Update installation guide` | ||
* Commit Content: Ensure each commit is complete and reviewable, and that it is linked to your GitHub ID | ||
|
||
### PR Descriptions | ||
|
||
PRs are the main way to make changes to Apache OzHera(incubating). We recommend using the [PR template](./.github/PULL_REQUEST_TEMPLATE.md) to describe your changes. | ||
|
||
## Test Case Contributions | ||
|
||
The Apache OzHera(incubating) project prioritizes functional test case contributions. We recommend using JUnit for unit tests and Mockito for integration tests. | ||
|
||
## Participating in Any Way | ||
|
||
Apache OzHera(incubating) collaborates on GitHub, and we encourage contributions in various ways: | ||
|
||
* Answer others’ questions | ||
* Help review others’ PR designs and code | ||
* Discuss project improvement suggestions | ||
* Write blogs or share experiences about Ozhera | ||
|
||
## Code Style | ||
|
||
The Apache OzHera(incubating) project adheres to the Alibaba Java Coding Guidelines. | ||
|
||
### Guidelines | ||
|
||
[Alibaba Java Coding Guidelines](https://alibaba.github.io/Alibaba-Java-Coding-Guidelines/) | ||
|
||
### Optional IDE Plugin Installation | ||
|
||
* **IDEA**: [p3c-idea-plugin installation](https://github.com/alibaba/p3c/blob/master/idea-plugin/README.md) | ||
* **Eclipse**: [p3c-eclipse-plugin installation](https://github.com/alibaba/p3c/blob/master/eclipse-plugin/README.md) | ||
|
||
In summary, **any help is a contribution**. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
# 为 Apache OzHera(incubating) 做贡献 | ||
|
||
如果您有兴趣寻找关于 Apache OzHera(incubating) 的漏洞,或是希望帮助提升项目质量,我们会非常欢迎您的加入。以下是为您提供的贡献指南列表。 | ||
|
||
[[English Contributing Document](./CONTRIBUTING.md)] | ||
|
||
## 目录 | ||
|
||
* [报告安全问题](#报告安全问题) | ||
* [报告一般问题](#报告一般问题) | ||
* [代码和文档贡献](#代码和文档贡献) | ||
* [测试用例贡献](#测试用例贡献) | ||
* [参与帮助任何事项](#参与帮助任何事项) | ||
* [代码风格](#代码风格) | ||
|
||
## 报告安全问题 | ||
|
||
安全问题是我们最关注的事情。我们建议您不要公开讨论或发布任何关于 Apache OzHera(incubating) 的安全漏洞。如果您发现安全问题,请直接发送电子邮件至 [[email protected]](mailto:[email protected]) 以保密的方式报告。 | ||
|
||
## 报告一般问题 | ||
|
||
用户的反馈是项目进步的重要来源。在使用 Apache OzHera(incubating) 后,您可以通过 [NEW ISSUE](https://github.com/apache/ozhera/issues/new/choose) 提交您的问题或建议。为确保沟通效率,我们建议先搜索是否已存在相关问题,然后在已有问题下添加您的详细信息,而不是创建新问题。 | ||
|
||
当您遇到以下情况,可以新建一个问题: | ||
|
||
* 错误报告 | ||
* 功能请求 | ||
* 性能问题 | ||
* 功能设计或改进建议 | ||
* 测试改进 | ||
* 文档不完整 | ||
* 其他项目相关的问题 | ||
|
||
请注意,提交问题时请删除任何敏感数据,例如密码、密钥、网络地址等。 | ||
|
||
## 代码和文档贡献 | ||
|
||
我们欢迎一切可以让 Apache OzHera(incubating) 项目更好的贡献。在 GitHub 上,所有的改进都可以通过 PR(Pull Request)实现: | ||
|
||
* 如果您发现错别字或错误,请修复它! | ||
* 如果发现功能可以优化,请提交改进! | ||
* 如果文档不准确或不完整,欢迎您进行更新! | ||
|
||
> 我们期待您的任何PR。 | ||
请注意 Apache OzHera(incubating) 项目对 PR 的要求,并在以下指南下提交: | ||
|
||
* [工作区准备](#工作区准备) | ||
* [分支定义](#分支定义) | ||
* [提交规则](#提交规则) | ||
* [PR说明](#PR说明) | ||
|
||
### 工作区准备 | ||
|
||
请首先 Fork 项目,然后克隆到本地计算机进行开发。设置远程仓库后,您可以轻松地与上游分支同步代码。 | ||
|
||
### 分支定义 | ||
|
||
Apache OzHera(incubating) 项目使用以下几种分支类型: | ||
|
||
* **开发分支**:用于所有新功能和改进的开发 | ||
* **发布分支**:发布版本时创建 | ||
* **热修复分支**:用于修复发布版本中的紧急问题 | ||
|
||
### 提交规则 | ||
|
||
我们非常重视提交的质量,包括: | ||
|
||
* 提交消息:请确保使用明确的提交信息,例如 `docs: update installation guide` | ||
* 提交内容:提交应包含完整且可审查的内容,并与 GitHub ID 相关联 | ||
|
||
### PR说明 | ||
|
||
PR 是更改 Apache OzHera(incubating) 项目文件的主要方式。我们建议使用 [PR 模板](./.github/PULL_REQUEST_TEMPLATE.md) 来描述更改内容。 | ||
|
||
## 测试用例贡献 | ||
|
||
Apache OzHera(incubating) 项目优先接收功能测试用例贡献。推荐使用 JUnit 进行单元测试,并使用 Mockito 进行集成测试。 | ||
|
||
## 参与帮助任何事项 | ||
|
||
Apache OzHera(incubating) 项目通过 GitHub 进行协作,我们鼓励贡献者通过以下方式参与: | ||
|
||
* 回答他人的问题 | ||
* 帮助审查他人的 PR 设计和代码 | ||
* 讨论项目改进建议 | ||
* 撰写关于 Apache OzHera(incubating) 的博客或分享使用经验 | ||
|
||
## 代码风格 | ||
|
||
Apache OzHera(incubating) 项目遵循阿里巴巴 Java 编码指南。 | ||
|
||
### 指南 | ||
|
||
[阿里巴巴 Java 代码指南](https://alibaba.github.io/Alibaba-Java-Coding-Guidelines/) | ||
|
||
### IDE 插件安装(可选) | ||
|
||
* **Idea IDE**:[p3c-idea-plugin 安装](https://github.com/alibaba/p3c/blob/master/idea-plugin/README.md) | ||
* **Eclipse IDE**:[p3c-eclipse-plugin 安装](https://github.com/alibaba/p3c/blob/master/eclipse-plugin/README.md) | ||
|
||
总之,**任何帮助都是贡献**。 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# ozhera-app | ||
Ozhera-app is a microservice that manages the basic data of monitoring applications and is the data service center of the entire ozhera monitoring system. | ||
ozhera-app is a microservice that manages the basic data of monitoring applications and is the data service center of the entire Apache OzHera(incubating) monitoring system. | ||
Provides unified application data for link tracing, logs, and metric monitoring, and manages global configuration information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# ozhera-app | ||
ozhera-app 是管理监控应用基础数据的微服务,是整个ozhera监控体系的数据服务中心, | ||
ozhera-app 是管理监控应用基础数据的微服务,是整个Apache OzHera(incubating)监控体系的数据服务中心, | ||
为链路追踪、日志、指标监控提供一致性的统一应用数据,同时管理着全局的配置信息。 |
Oops, something went wrong.