You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by "ButterBright (via GitHub)" <gi...@apache.org> on 2026/03/31 14:46:05 UTC
[PR] Add documentation for Trace model [skywalking-banyandb]
ButterBright opened a new pull request, #1040:
URL: https://github.com/apache/skywalking-banyandb/pull/1040
<!--
⚠️ Please make sure to read this template first, pull requests that don't accord with this template
maybe closed without notice.
Texts surrounded by `<` and `>` are meant to be replaced by you, e.g. <framework name>, <issue number>.
Put an `x` in the `[ ]` to mark the item as CHECKED. `[x]`
-->
<!-- ==== 🐛 Remove this line WHEN AND ONLY WHEN you're fixing a bug, follow the checklist 👇 ====
### Fix <bug description or the bug issue number or bug issue link>
- [ ] Add a unit test to verify that the fix works.
- [ ] Explain briefly why the bug exists and how to fix it.
==== 🐛 Remove this line WHEN AND ONLY WHEN you're fixing a bug, follow the checklist 👆 ==== -->
<!-- ==== 🆕 Remove this line WHEN AND ONLY WHEN you're adding a new feature, follow the checklist 👇 ====
### <Feature description>
- [ ] If this is non-trivial feature, paste the links/URLs to the design doc.
- [ ] Update the documentation to include this new feature.
- [ ] Tests(including UT, IT, E2E) are added to verify the new feature.
- [ ] If it's UI related, attach the screenshots below.
==== 🆕 Remove this line WHEN AND ONLY WHEN you're adding a new feature, follow the checklist 👆 ==== -->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add documentation for Trace model [skywalking-banyandb]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #1040:
URL: https://github.com/apache/skywalking-banyandb/pull/1040#discussion_r3016717495
##########
docs/operation/observability.md:
##########
@@ -294,7 +298,7 @@ Check out the [BanyanDB Cluster Dashboard](grafana-cluster.json) for monitoring
### Native
-If the `observability-modes` flag is set to `native`, the self-observability metrics provider will be enabled. The some of metrics will be displayed in the dashboard of [banyandb-ui](http://localhost:17913/)
+If the `observability-modes` flag is set to `native`, the self-observability metrics provider will be enabled. The some of metrics will be displayed in the dashboard of [banyandb-ui](http://localhost:17913/)
Review Comment:
Grammar: “the some of metrics” is incorrect/unclear English and reads like a typo. Please rephrase (e.g., “some of the metrics …” or “some metrics …”).
```suggestion
If the `observability-modes` flag is set to `native`, the self-observability metrics provider will be enabled. Some of the metrics will be displayed in the dashboard of [banyandb-ui](http://localhost:17913/)
```
##########
docs/operation/troubleshooting/query.md:
##########
@@ -22,10 +22,15 @@ groups: ["measure-default"]
tagProjection:
tagFamilies:
- name: "default"
- tags: ["last_update_time_bucket", "represent_service_id", "represent_service_instance_id"]
+ tags:
+ [
+ "last_update_time_bucket",
+ "represent_service_id",
+ "represent_service_instance_id",
+ ]
- name: "storage_only"
tags: ["address"]
Review Comment:
The YAML example for `tags` is not valid YAML: flow sequences (`[...]`) don’t allow trailing commas, and this format is likely to break copy/paste. Please switch to a standard YAML list (one item per line with `-`) or a single-line flow sequence without trailing commas.
```suggestion
- "last_update_time_bucket"
- "represent_service_id"
- "represent_service_instance_id"
- name: "storage_only"
tags:
- "address"
```
##########
docs/operation/troubleshooting/query.md:
##########
@@ -6,9 +6,9 @@ If you encounter issues with query results in BanyanDB, follow these troubleshoo
### Mandatory Fields Missing
-The query's mandatory fields are `time_range`, `name` and `groups`. If any of these fields are missing, the query will fail. Ensure that the query includes all the required fields and that the syntax is correct.
+The query's mandatory fields are `time_range`, `name` and `groups`. If any of these fields are missing, the query will fail. Ensure that the query includes all the required fields and that the syntax is correct.
-For `Stream`, the `tag_projection` field is mandatory. For `Measure`, either `tag_projection` or `field_projection` is required.
+For `Stream` and `Trace`, the `tag_projection` field is mandatory. For `Measure`, either `tag_projection` or `field_projection` is required.
Review Comment:
The statement that `tag_projection` is mandatory for `Trace` queries appears incorrect. The Trace QueryRequest (`api/proto/banyandb/trace/v1/query.proto`) defines `tag_projection` as optional, and the trace query option validation does not require it (unlike Stream, which does require `projection`). Please update this troubleshooting guidance to only mark Stream's projection as mandatory (and describe Trace's projection as optional).
```suggestion
For `Stream`, the `tag_projection` field is mandatory. For `Trace`, the `tag_projection` field is optional. For `Measure`, either `tag_projection` or `field_projection` is required.
```
##########
docs/operation/troubleshooting/query.md:
##########
@@ -51,7 +56,7 @@ Please refer to the [Troubleshooting No Data Issue](./no-data.md) guide to ident
### Duplicate Data
-`Stream` and `Measure` handles duplicate data differently:
+`Stream`, `Measure` and `Trace` handles duplicate data differently:
Review Comment:
Grammar: since the subject is plural (multiple models), this should be “handle duplicate data differently”, not “handles”.
```suggestion
`Stream`, `Measure` and `Trace` handle duplicate data differently:
```
##########
docs/concept/clustering.md:
##########
@@ -93,11 +93,11 @@ The comparison between using a storage system and application-level replication
**Complexity**: With the storage system handling replication, the complexity is abstracted away from the user. The user need not concern themselves with the details of how replication is handled. Managing replication at the application level can be complex. It requires careful configuration, monitoring, and potentially significant engineering effort to maintain.
-Futhermore, the storage system might be cheaper. For instance, S3 can be more cost-effective because it eliminates the need for additional resources required for application-level replication. Application-level replication also requires ongoing maintenance, potentially increasing operational costs.
+Futhermore, the storage system might be cheaper. For instance, S3 can be more cost-effective because it eliminates the need for additional resources required for application-level replication. Application-level replication also requires ongoing maintenance, potentially increasing operational costs.
Review Comment:
Spelling: “Futhermore” should be “Furthermore”.
```suggestion
Furthermore, the storage system might be cheaper. For instance, S3 can be more cost-effective because it eliminates the need for additional resources required for application-level replication. Application-level replication also requires ongoing maintenance, potentially increasing operational costs.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add documentation for Trace model [skywalking-banyandb]
Posted by "codecov-commenter (via GitHub)" <gi...@apache.org>.
codecov-commenter commented on PR #1040:
URL: https://github.com/apache/skywalking-banyandb/pull/1040#issuecomment-4163735570
## [Codecov](https://app.codecov.io/gh/apache/skywalking-banyandb/pull/1040?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
:white_check_mark: All modified and coverable lines are covered by tests.
:white_check_mark: Project coverage is 47.98%. Comparing base ([`3530dd9`](https://app.codecov.io/gh/apache/skywalking-banyandb/commit/3530dd9b5cefaa4fef60eec91ecbfbdfcaf243c5?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)) to head ([`7a21c09`](https://app.codecov.io/gh/apache/skywalking-banyandb/commit/7a21c09667c59a7289e93b16e5a839efd0b0dbb7?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)).
:warning: Report is 183 commits behind head on main.
<details><summary>Additional details and impacted files</summary>
```diff
@@ Coverage Diff @@
## main #1040 +/- ##
==========================================
+ Coverage 45.97% 47.98% +2.00%
==========================================
Files 328 403 +75
Lines 55505 65502 +9997
==========================================
+ Hits 25520 31429 +5909
- Misses 27909 31113 +3204
- Partials 2076 2960 +884
```
| [Flag](https://app.codecov.io/gh/apache/skywalking-banyandb/pull/1040/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Coverage Δ | |
|---|---|---|
| [banyand](https://app.codecov.io/gh/apache/skywalking-banyandb/pull/1040/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `50.01% <ø> (?)` | |
| [bydbctl](https://app.codecov.io/gh/apache/skywalking-banyandb/pull/1040/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `82.35% <ø> (?)` | |
| [fodc](https://app.codecov.io/gh/apache/skywalking-banyandb/pull/1040/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `70.47% <ø> (?)` | |
| [integration-distributed](https://app.codecov.io/gh/apache/skywalking-banyandb/pull/1040/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `80.00% <ø> (?)` | |
| [pkg](https://app.codecov.io/gh/apache/skywalking-banyandb/pull/1040/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `31.15% <ø> (?)` | |
Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#carryforward-flags-in-the-pull-request-comment) to find out more.
</details>
[:umbrella: View full report in Codecov by Sentry](https://app.codecov.io/gh/apache/skywalking-banyandb/pull/1040?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
:loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
<details><summary> :rocket: New features to boost your workflow: </summary>
- :snowflake: [Test Analytics](https://docs.codecov.com/docs/test-analytics): Detect flaky tests, report on failures, and find test suite problems.
- :package: [JS Bundle Analysis](https://docs.codecov.com/docs/javascript-bundle-analysis): Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add documentation for Trace model [skywalking-banyandb]
Posted by "hanahmily (via GitHub)" <gi...@apache.org>.
hanahmily merged PR #1040:
URL: https://github.com/apache/skywalking-banyandb/pull/1040
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org