This is an automated email from the ASF dual-hosted git repository.
jiacai2050 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/horaedb.git
The following commit(s) were added to refs/heads/main by this push:
new e360b4df chore: update community (#1582)
e360b4df is described below
commit e360b4dff71672253ebc253e08d9fedccfc8e0f3
Author: Jiacai Liu <[email protected]>
AuthorDate: Mon Oct 28 16:58:59 2024 +0800
chore: update community (#1582)
## Rationale
Sync with website
## Detailed Changes
- Add URL check ci
## Test Plan
CI
---
.github/workflows/links.yml | 45 ++++++
CONTRIBUTING.md | 4 +-
README-CN.md | 6 +-
README.md | 14 +-
docs/rfcs/20220702-prometheus-read-extension.md | 176 ++++++++++++------------
horaemeta/CONTRIBUTING.md | 8 +-
6 files changed, 147 insertions(+), 106 deletions(-)
diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml
new file mode 100644
index 00000000..f77fe20b
--- /dev/null
+++ b/.github/workflows/links.yml
@@ -0,0 +1,45 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you 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.
+
+name: Check markdown links
+
+on:
+ merge_group:
+ workflow_dispatch:
+ schedule:
+ - cron: '2 0 * * *'
+ push:
+ branches:
+ - main
+ - dev
+ pull_request:
+
+jobs:
+ url-check:
+ name: url-check
+ runs-on: ubuntu-latest
+ timeout-minutes: 20
+ steps:
+ - uses: actions/checkout@v4
+ - name: Install deps
+ run: |
+ pip3 install urlchecker
+ - name: Check markdown links
+ run: |
+ urlchecker check --file-types '*.md' \
+ --exclude-urls
'http://127.0.0.1:5440/sql,https://github.com/apache/horaedb/issues/new' \
+ .
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 2f9bd857..8492c80a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -24,7 +24,7 @@ For features, we don't plan to support we will close the
feature request ticket
## Contributing Changes
-HoraeDB is written mostly in idiomatic Rust—please see the [Style
Guide](https://horaedb.apache.org/dev/style_guide.html) for more details.
+HoraeDB is written mostly in idiomatic Rust—please see the [Style
Guide](https://horaedb.apache.org/docs/dev/style_guide/) for more details.
All code must adhere to the `rustfmt` format, and pass all of the `clippy`
checks we run in CI (there are more details further down this README).
### Making a PR
@@ -38,7 +38,7 @@ PR title.
For PRs that you consider ready for review, verify the following locally
before you submit it:
-* you have a coherent set of logical commits, with messages conforming to the
[Conventional
Commits](https://horaedb.apache.org/docs/dev/conventional_commit/)
specification;
+* you have a coherent set of logical commits, with messages conforming to the
[Conventional Commits](https://horaedb.apache.org/docs/dev/style_guide/)
specification;
* all the tests and/or benchmarks pass, including documentation tests;
* the code is correctly formatted and all `clippy` checks pass; and
* you haven't left any "code cruft" (commented out code blocks etc).
diff --git a/README-CN.md b/README-CN.md
index 81d1bad7..1cf9bba2 100644
--- a/README-CN.md
+++ b/README-CN.md
@@ -79,11 +79,7 @@ Drop TABLE `demo`
与来自世界各地的用户和开发人员一起在 Apache HoraeDB (incubating) 社区中茁壮成长。
-- [订阅邮箱参与讨论](mailto:[email protected])
([订阅](mailto:[email protected]?subject=(send%20this%20email%20to%20subscribe))
/
[取消订阅](mailto:[email protected]?subject=(send%20this%20email%20to%20unsubscribe))
/ [查看邮件历史记录](https://lists.apache.org/[email protected]))
-- 发送
[请求](mailto:[email protected]?subject=(Request%to%20join%20HoraeDB%20slack))
至 `[email protected]` 加入HoraeDB Slack
-- 通过[这里的链接](http://horaedb.apache.org/community/)，加入我们的社区。
-
-[如何参与贡献](CONTRIBUTING.md)
+- https://horaedb.apache.org/community/
## 致谢
diff --git a/README.md b/README.md
index 26ef706b..423838c1 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
-[](https://github.com/apache/incubator-horaedb/actions/workflows/ci.yml)
-[](https://github.com/apache/incubator-horaedb/issues)
+[](https://github.com/apache/horaedb/actions/workflows/ci.yml)
+[](https://github.com/apache/horaedb/issues)
[](https://hub.docker.com/r/apache/horaedb-server)
[](https://hub.docker.com/r/apache/horaemeta-server)
@@ -43,7 +43,7 @@ docker compose -f docker/docker-compose.yaml up
### Run from source code
-See details [here](https://horaedb.apache.org/dev/compile_run.html).
+Please read the [development
guide](https://horaedb.apache.org/docs/dev/compile_run/) guide for instructions
on how to build.
### Create Table and Write/Read data
Create Table.
@@ -95,11 +95,11 @@ Drop TABLE `demo`
Thrive together in Apache HoraeDB (incubating) community with users and
developers from all around the world.
-- Discuss at [dev mailing list](mailto:[email protected])
([subscribe](mailto:[email protected]?subject=(send%20this%20email%20to%20subscribe))
/
[unsubscribe](mailto:[email protected]?subject=(send%20this%20email%20to%20unsubscribe))
/ [archives](https://lists.apache.org/[email protected]))
-- Send
[request](mailto:[email protected]?subject=(Request%to%20join%20HoraeDB%20slack))
to `[email protected]` to join HoraeDB slack channel
-- Or you can join our community [here](http://horaedb.apache.org/community/)
+- Ask questions on [GitHub
Discussion](https://github.com/apache/horaedb/discussions).
+- Chat with developers/users on [Discord](https://discord.gg/h5r4kVMRYN) or
[DingTalk](https://horaedb.apache.org/images/dingtalk.jpg).
+- Mailing lists are a form of communication used by the Apache community. See
guide [here](http://horaedb.apache.org/community/) to subscribe to our list.
-Read our [Contributing Guide](CONTRIBUTING.md) and make your first
contribution!
+> Read our [Contributing Guide](CONTRIBUTING.md) and make your first
contribution!
## Acknowledgment
diff --git a/docs/rfcs/20220702-prometheus-read-extension.md
b/docs/rfcs/20220702-prometheus-read-extension.md
index b35c1dc2..e1044f95 100644
--- a/docs/rfcs/20220702-prometheus-read-extension.md
+++ b/docs/rfcs/20220702-prometheus-read-extension.md
@@ -1,18 +1,18 @@
-Prometheus read extension for HoraeDB
+Prometheus read extension for HoraeDB
---------------------------
- Feature Name: prometheus-read-extension
-- Tracking Issue: https://github.com/apache/incubator-horaedb/issues/90
+- Tracking Issue: https://github.com/apache/horaedb/issues/90
# Summary
Drop-in and full-featured Prometheus read extension for HoraeDB
# Motivation
-Prometheus and PromQL are wide used in monitoring scenarios. It would be great
if HoraeDB can be queried using PromQL.
+Prometheus and PromQL are wide used in monitoring scenarios. It would be great
if HoraeDB can be queried using PromQL.
HoraeDB has the ability to store and compute a large amount of data. But
PromQL contains some specific operators. Though HoraeDB supports a subset, it
is hard and infeasible to implement all of them.
-There are some brilliant distributed solutions like `Thanos` and `Cortex`. But
the computation ability is limited in aspects of distributed execution or
extensible (`Thanos` supports split query on time range
(https://thanos.io/tip/components/query-frontend.md/#splitting). Combining
`Prometheus` with `HoraeDB` can gain both high performance computation and the
ability to query in other forms like SQL.
+There are some brilliant distributed solutions like `Thanos` and `Cortex`. But
the computation ability is limited in aspects of distributed execution or
extensible (`Thanos` supports split query on time range
(https://thanos.io/tip/components/query-frontend.md/#splitting). Combining
`Prometheus` with `HoraeDB` can gain both high performance computation and the
ability to query in other forms like SQL.
This proposal aims to provide a way that:
@@ -110,7 +110,7 @@ Query Frontend has to feed PromQL and SQL to servers
separately because this int
1. `Query Frontend` accepts a PromQL.
2. `Query Frontend` splits the original PromQL into two sub queries and
assigns a `TaskID`.
-3. `Query Frontend` sends sub PromQL to `Prometheus` and sub SQL to HoraeDB.
+3. `Query Frontend` sends sub PromQL to `Prometheus` and sub SQL to HoraeDB.
4. `Prometheus` processes the sub PromQL. It will query the data source
(HoraeDB) for data.
5. `HoraeDB` receives a request from `Prometheus`, and a sub-SQL with the same
`TaskID` from `Query Frontend`.
6. `HoraeDB` processes and returns result to `Prometheus`.
@@ -137,48 +137,48 @@ Query_Frontend -> Client : response PromQL request
-->
```plaintext
-
,.-^^-._
- ,-.
|-.____.-|
- `-'
| |
- /|\
| |
- | ,--------------. ,----------.
| |
- / \ |Query_Frontend| |Prometheus|
'-.____.-'
- Client `------+-------' `----+-----'
HoraeDB
- | PromQL request | |
|
- | -----------------------> |
|
- | | |
|
- | | sub PromQL request with TaskID|
|
- | | ------------------------------>
|
- | | |
|
- | | sub SQL request with
TaskID |
- | |
--------------------------------------------------------------->
- | | |
|
- | | | remote
storage read with TaskID|
- | | |
------------------------------->
- | | |
|
- | | |
|----.
+
,.-^^-._
+ ,-.
|-.____.-|
+ `-'
| |
+ /|\
| |
+ | ,--------------. ,----------.
| |
+ / \ |Query_Frontend| |Prometheus|
'-.____.-'
+ Client `------+-------' `----+-----'
HoraeDB
+ | PromQL request | |
|
+ | -----------------------> |
|
+ | | |
|
+ | | sub PromQL request with TaskID|
|
+ | | ------------------------------>
|
+ | | |
|
+ | | sub SQL request with
TaskID |
+ | |
--------------------------------------------------------------->
+ | | |
|
+ | | | remote
storage read with TaskID|
+ | | |
------------------------------->
+ | | |
|
+ | | |
|----.
| | |
| | pull data and compute
- | | |
|<---'
- | | |
|
- | | | response
remote read request |
- | | |
<-------------------------------
- | | |
|
- | | |----.
|
- | | | |
compute |
- | | |<---'
|
- | | |
|
- | | response PromQL request |
|
- | | <------------------------------
|
- | | |
|
- | response PromQL request| |
|
- | <----------------------- |
|
- Client ,------+-------. ,----+-----.
HoraeDB
- ,-. |Query_Frontend| |Prometheus|
,.-^^-._
- `-' `--------------' `----------'
|-.____.-|
- /|\
| |
- |
| |
- / \
| |
-
'-.____.-'
+ | | |
|<---'
+ | | |
|
+ | | | response
remote read request |
+ | | |
<-------------------------------
+ | | |
|
+ | | |----.
|
+ | | | |
compute |
+ | | |<---'
|
+ | | |
|
+ | | response PromQL request |
|
+ | | <------------------------------
|
+ | | |
|
+ | response PromQL request| |
|
+ | <----------------------- |
|
+ Client ,------+-------. ,----+-----.
HoraeDB
+ ,-. |Query_Frontend| |Prometheus|
,.-^^-._
+ `-' `--------------' `----------'
|-.____.-|
+ /|\
| |
+ |
| |
+ / \
| |
+
'-.____.-'
```
### Separated HoraeDB cluster
@@ -216,50 +216,50 @@ Query_Frontend -> Client : response PromQL request
-->
```plaintext
-
,.-^^-._
+
,.-^^-._
,-.
|-.____.-|
`-'
| |
/|\
| |
| ,--------------. ,----------.
| |
/ \ |Query_Frontend| |Prometheus|
'-.____.-'
- Client `------+-------' `----+-----'
HoraeDB
- | PromQL request | |
|
- | -----------------------> |
|
- | | |
|
- | | sub PromQL request |
|
- | | ---------------------------->
|
- | | |
|
- | |----. |
|
- | | | store the sub SQL |
|
- | |<---' |
|
- | | |
|
- | | remote storage read |
|
- | | <----------------------------
|
- | | |
|
- | | query sub SQL using HoraeDB Client
|
- | |
------------------------------------------------>|
- | | |
|
- | | sub SQL query result
|
- | |
<------------------------------------------------|
- | | |
|
- | |----. |
|
- | | | transform data format |
|
- | |<---' |
|
- | | |
|
- | | response remote read request|
|
- | | ---------------------------->
|
- | | |
|
- | | |----.
|
- | | | | compute
|
- | | |<---'
|
- | | |
|
- | | response sub PromQL request |
|
- | | <----------------------------
|
- | | |
|
- | response PromQL request| |
|
- | <----------------------- |
|
- Client ,------+-------. ,----+-----.
HoraeDB
- ,-. |Query_Frontend| |Prometheus|
,.-^^-._
+ Client `------+-------' `----+-----'
HoraeDB
+ | PromQL request | |
|
+ | -----------------------> |
|
+ | | |
|
+ | | sub PromQL request |
|
+ | | ---------------------------->
|
+ | | |
|
+ | |----. |
|
+ | | | store the sub SQL |
|
+ | |<---' |
|
+ | | |
|
+ | | remote storage read |
|
+ | | <----------------------------
|
+ | | |
|
+ | | query sub SQL using HoraeDB Client
|
+ | |
------------------------------------------------>|
+ | | |
|
+ | | sub SQL query result
|
+ | |
<------------------------------------------------|
+ | | |
|
+ | |----. |
|
+ | | | transform data format |
|
+ | |<---' |
|
+ | | |
|
+ | | response remote read request|
|
+ | | ---------------------------->
|
+ | | |
|
+ | | |----.
|
+ | | | | compute
|
+ | | |<---'
|
+ | | |
|
+ | | response sub PromQL request |
|
+ | | <----------------------------
|
+ | | |
|
+ | response PromQL request| |
|
+ | <----------------------- |
|
+ Client ,------+-------. ,----+-----.
HoraeDB
+ ,-. |Query_Frontend| |Prometheus|
,.-^^-._
`-' `--------------' `----------'
|-.____.-|
/|\
| |
|
| |
@@ -268,13 +268,13 @@ Query_Frontend -> Client : response PromQL request
```
## Comparison
-Both ways can achieve our initial requirements and are able to implement
distributed execution in the future.
+Both ways can achieve our initial requirements and are able to implement
distributed execution in the future.
- Embedded `HoraeDB`
- Pros.
- `HoraeDB` feeds data to `Prometheus` directly, reducing some
computation and transmission.
- Cons.
- - Need to customize a `Prometheus` specific interface in `HoraeDB`.
+ - Need to customize a `Prometheus` specific interface in `HoraeDB`.
- The deployment may requires all three components bound together for
simplicity.
- Separated `HoraeDB` cluster
- Pros.
@@ -282,7 +282,7 @@ Both ways can achieve our initial requirements and are able
to implement distrib
- The deployment only requires one `Query Frontend` along with
`Prometheus` which is more lightweight and less invasive.
- States of `HoraeDB` and `Query Frontend` are simple and clear.
- Cons.
- - One more data transforming and forwarding in `Query Frontend` (pass
results from `HoraeDB` to `Prometheus`).
+ - One more data transforming and forwarding in `Query Frontend` (pass
results from `HoraeDB` to `Prometheus`).
# Drawbacks
Detailed in the "Comparison" section above.
diff --git a/horaemeta/CONTRIBUTING.md b/horaemeta/CONTRIBUTING.md
index 97aa18b2..e361cf0b 100644
--- a/horaemeta/CONTRIBUTING.md
+++ b/horaemeta/CONTRIBUTING.md
@@ -5,14 +5,14 @@ To make the process easier and more valuable for everyone
involved we have a few
## Submitting Issues and Feature Requests
-Before you file an
[issue](https://github.com/apache/incubator-horaedb-meta/issues/new), please
search existing issues in case the same or similar issues have already been
filed.
+Before you file an [issue](https://github.com/apache/horaedb/issues/new),
please search existing issues in case the same or similar issues have already
been filed.
If you find an existing open ticket covering your issue then please avoid
adding "👍" or "me too" comments; Github notifications can cause a lot of noise
for the project maintainers who triage the back-log.
However, if you have a new piece of information for an existing ticket and you
think it may help the investigation or resolution, then please do add it as a
comment!
You can signal to the team that you're experiencing an existing issue with one
of Github's emoji reactions (these are a good way to add "weight" to an issue
from a prioritisation perspective).
### Submitting an Issue
-The [New Issue]((https://github.com/apache/incubator-horaedb-meta/issues/new))
page has templates for both bug reports and feature requests.
+The [New Issue]((https://github.com/apache/horaedb/issues/new)) page has
templates for both bug reports and feature requests.
Please fill one of them out!
The issue templates provide details on what information we will find useful to
help us fix an issue.
In short though, the more information you can provide us about your
environment and what behaviour you're seeing, the easier we can fix the issue.
@@ -30,14 +30,14 @@ Please see the [Style Guide](docs/style_guide.md) for more
details.
To open a PR you will need to have a Github account.
Fork the `horaemeta` repo and work on a branch on your fork.
-When you have completed your changes, or you want some incremental feedback
make a Pull Request to HoraeDB
[here](https://github.com/apache/incubator-horaedb-meta/compare).
+When you have completed your changes, or you want some incremental feedback
make a Pull Request to HoraeDB
[here](https://github.com/apache/horaedb/compare).
If you want to discuss some work in progress then please prefix `[WIP]` to the
PR title.
For PRs that you consider ready for review, verify the following locally
before you submit it:
-* you have a coherent set of logical commits, with messages conforming to the
[Conventional
Commits](https://github.com/apache/incubator-horaedb-docs/blob/main/docs/src/en/dev/conventional_commit.md)
specification;
+* you have a coherent set of logical commits, with messages conforming to the
[Conventional
Commits](https://horaedb.apache.org/docs/dev/conventional_commit/)
specification;
* all the tests and/or benchmarks pass, including documentation tests;
* the code is correctly formatted and all linter checks pass; and
* you haven't left any "code cruft" (commented out code blocks etc).
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
