Skip to content

Implement self-monitoring for BanyanDB via OAP Server and UI#13527

Merged
wankai123 merged 37 commits intoapache:masterfrom
firebor:master
Oct 27, 2025
Merged

Implement self-monitoring for BanyanDB via OAP Server and UI#13527
wankai123 merged 37 commits intoapache:masterfrom
firebor:master

Conversation

@firebor
Copy link
Copy Markdown
Contributor

@firebor firebor commented Sep 28, 2025

  • 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.

  • If this pull request closes/resolves/fixes an existing issue, replace the issue number. Closes #.

  • Update the CHANGES log.

@wu-sheng wu-sheng added backend OAP backend related. feature New feature labels Sep 29, 2025
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR implements self-monitoring capabilities for BanyanDB through integration with the OAP Server and UI dashboard. The implementation enables monitoring of BanyanDB performance metrics including CPU usage, memory utilization, disk usage, network activity, and database-specific operations.

Key changes:

  • Adds OTEL metric collection rules for BanyanDB monitoring
  • Creates a comprehensive UI dashboard template with 24 monitoring widgets
  • Implements end-to-end testing infrastructure for BanyanDB monitoring

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/Layer.java Adds BANYANDB layer enum for service categorization
oap-server/server-starter/src/main/resources/otel-rules/banyandb.yaml Defines metric transformation rules for BanyanDB Prometheus metrics
oap-server/server-starter/src/main/resources/application.yml Enables banyandb OTEL metrics processing
oap-server/server-starter/src/main/resources/ui-initialized-templates/banyandb/banyandb_service.json Creates comprehensive monitoring dashboard with performance widgets
test/e2e-v2/cases/banyandb/* Adds complete E2E testing infrastructure for BanyanDB monitoring
docs/en/changes/changes.md Documents the new feature in changelog
Comments suppressed due to low confidence (1)

oap-server/server-starter/src/main/resources/otel-rules/banyandb.yaml:1

  • There's a spelling error in the title. 'opeartion' should be 'operation'.
# Licensed to the Apache Software Foundation (ASF) under one or more

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@wu-sheng
Copy link
Copy Markdown
Member

You should follow code style provided in the root folder, and format the codes.

Comment thread test/e2e-v2/cases/banyandb/e2e.yaml
@wankai123
Copy link
Copy Markdown
Member

@firebor, please add your UI screenshot.

Comment thread docs/en/changes/changes.md Outdated

#### Project

* Implement self-monitoring for BanyanDB via OAP Server and UI
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not a project-level change. Project-level change is a highlight feature change. This feature is just an extension.
Please add the changes to OAP Server and UI sections separately.

Copy link
Copy Markdown
Contributor Author

@firebor firebor Sep 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OAP Server

  • Implement self-monitoring for BanyanDB via OAP Server.

UI

  • Implement self-monitoring for BanyanDB via UI.

Comment thread oap-server/server-starter/src/main/resources/application.yml Outdated
@wu-sheng
Copy link
Copy Markdown
Member

@firebor, please add your UI screenshot.

No UI menu YAML file changes have been added. How do you test this new page locally?

@firebor
Copy link
Copy Markdown
Contributor Author

firebor commented Sep 29, 2025

@firebor, please add your UI screenshot.

ui1 ui2 ui3

@wu-sheng
Copy link
Copy Markdown
Member

How do you open this menu without menu file change? From dashboard pages?

firebor and others added 3 commits September 29, 2025 11:12
…mplates/banyandb/banyandb_service.json


fix error name

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@firebor
Copy link
Copy Markdown
Contributor Author

firebor commented Sep 29, 2025

How do you open this menu without menu file change? From dashboard pages?

Manually import JSON files(banyandb_service.json)

@wu-sheng
Copy link
Copy Markdown
Member

This config should be initialized automatically and show up on the menu bar after metrics of BanyanDB collected.
manu.yaml should be updated.

@wu-sheng
Copy link
Copy Markdown
Member

And fix CI.

documentLink: https://skywalking.apache.org/docs/main/next/en/setup/backend/dashboards-so11y-go-agent/
i18nKey: self_observability_go_agent No newline at end of file
i18nKey: self_observability_go_agent
- title: BanyanDB Server
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please move this before Java agent.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And as i18nKey added, we need to update UI accordingly.

@firebor
Copy link
Copy Markdown
Contributor Author

firebor commented Oct 15, 2025

Why file changes are gone?

The code has been rolled back.

@firebor
Copy link
Copy Markdown
Contributor Author

firebor commented Oct 16, 2025

UI interface update
e3e0d363d021b5509e8e65d50563f49e
44c47403bbbebd60c7a3a44a03f8556e
a4c58af1f6c781b704e2f4859d9b4572
ba9227b8d4170bf7286401941628a6dd
d83916de8cd35b32953ff87e5d4c5f66
a3afc443fb2dab85810fae57f08cf0c2
1a2d0ff07fadf6c1833a3e2d6c9becbd

@wu-sheng
Copy link
Copy Markdown
Member

The BanyanDB menu item should have a description about what BanyanDB is?

@firebor
Copy link
Copy Markdown
Contributor Author

firebor commented Oct 25, 2025

Showcase UI display
1
2
3
4
5
6

Copy link
Copy Markdown
Member

@wankai123 wankai123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@wankai123 wankai123 merged commit eef702e into apache:master Oct 27, 2025
349 of 351 checks passed
@wu-sheng wu-sheng added this to the 10.3. milestone Apr 7, 2026
@wu-sheng wu-sheng modified the milestones: 10.3., 10.3.0 Apr 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backend OAP backend related. feature New feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants