# hinsight-core

**Repository Path**: qiaolq/hinsight-core

## Basic Information

- **Project Name**: hinsight-core
- **Description**: HInsight Core 是一个基于 Grafana 派生的开源可观测平台，当前重点是将前端从 React 迁移到 Vue，并尽量保持与 Grafana 兼容的行为和用户体验。
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-10
- **Last Updated**: 2026-05-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# HInsight

HInsight is an open-source project derived from Grafana. Its current focus is migrating the Grafana frontend from React to Vue while keeping user behavior, features, styling, themes, i18n, and accessibility as close to 1:1 with the original implementation as possible.

This is not an official Grafana Labs project and does not represent Grafana Labs. Grafana is a trademark of Grafana Labs. Grafana-related names, paths, and source files are retained where they are needed to describe upstream origin, preserve historical structure, or support migration parity work.

[中文说明](#中文说明)

## Disclaimer

This project is currently provided for testing, learning, and research purposes only. It is under active migration and development, and it is not guaranteed to be stable, complete, secure, or suitable for production use.

Use this project at your own risk. The maintainers and contributors do not provide any warranty, express or implied, including but not limited to warranties of merchantability, fitness for a particular purpose, availability, data integrity, or production reliability. The maintainers and contributors are not responsible for any direct or indirect loss, damage, service interruption, data loss, security incident, compliance issue, or other consequence arising from production deployment or any other use of this project.

Before using this project in any production, commercial, or regulated environment, you should perform your own technical review, security assessment, compliance review, and legal review.

## Current Status

- The default production build entry is Vue Host: `yarn build`
- The default development entry is Vue Host: `yarn start`
- Vue business implementation lives under `webrs/app/`
- `public/app/**` is retained as the React reference baseline and is not the default Vue Host compile, bundle, or runtime entry
- `packages/hjqy-app-vue/` mainly carries the Vue app build shell and artifacts
- `packages/hjqy-ui/src/vue/` carries Vue UI components

Migration details are documented in [MIGRATION.md](MIGRATION.md). Contribution rules are documented in [CONTRIBUTING.md](CONTRIBUTING.md) and [AGENTS.md](AGENTS.md).

HInsight has been developed with substantial assistance from Codex, primarily using GPT-5.2. See [ACKNOWLEDGEMENTS.md](ACKNOWLEDGEMENTS.md).

## Repository Layout

| Path                        | Purpose                                                                      |
| --------------------------- | ---------------------------------------------------------------------------- |
| `webrs/app/`                | Vue Mirror business implementation and the default production/dev app source |
| `public/app/`               | React reference source used for 1:1 migration parity                         |
| `packages/hjqy-ui/src/vue/` | Vue UI components                                                            |
| `packages/hjqy-app-vue/`    | Vue app build shell and artifacts                                            |
| `packages/`                 | Frontend workspace packages                                                  |
| `apps/`                     | Grafana/HInsight app-platform backend application modules                    |
| `docs/migration-vue/`       | Migration design notes, verification records, and audit material             |
| `scripts/webpack/`          | Vue Host development and production webpack configuration                    |
| `conf/`                     | Default and sample configuration                                             |

## Requirements

- Node.js: `>=22 <25`, Node 22.x is recommended
- Yarn: `4.11.0`, pinned through `.yarn/releases/yarn-4.11.0.cjs`
- Go: follow the version declared in `go.mod`

If your machine has multiple Node versions, switch first:

```bash
nvm use 22.12.0
```

## Quick Start

Install dependencies:

```bash
yarn install
```

Start the development server:

```bash
yarn start
```

Default URL:

```text
http://localhost:3001/
```

Build the Vue app:

```bash
yarn x:app-vue:build
```

Run the production build:

```bash
yarn build
```

## Migration Guards

Run at least the following during normal development:

```bash
yarn x:guard:dsc:hard
yarn x:app-vue:build
```

Quick verification:

```bash
yarn x:verify:dsc:quick
```

Full verification:

```bash
yarn x:verify:dsc:full
```

Core constraints:

- Vue Host and Mirror code must not import `react`, `react-dom`, or React runtime mounting mechanisms
- Runtime logic under `public/app/**` must not be changed by default
- Do not add local stubs or new `*.d.ts` files
- Do not commit empty Vue SFC shells under Mirror
- Vue styles must not use `<style scoped>` or hardcoded colors; use theme tokens / `useStyles2Vue` or existing equivalents

The full rule set is in [AGENTS.md](AGENTS.md).

## Open Source and License

The default license is [AGPL-3.0-only](LICENSE). Some directories retain upstream or third-party licenses; see [LICENSING.md](LICENSING.md).

This project is derived from Grafana. Upstream attribution and third-party notices are documented in [NOTICE.md](NOTICE.md). If you redistribute a derivative of this repository, keep the license, notices, and upstream attribution intact.

AI assistance acknowledgement is documented in [ACKNOWLEDGEMENTS.md](ACKNOWLEDGEMENTS.md). Human maintainers remain responsible for reviewed and accepted changes.

AGPL has source-availability obligations for network service distribution. Before commercial distribution, review your distribution model, trademark usage, and third-party dependency obligations with qualified legal counsel.

## Project Links

- Zhihu column (Chinese): [HInsight Core](https://www.zhihu.com/column/c_2033636608637916097)

## Support and Security

- Support: [SUPPORT.md](SUPPORT.md)
- Security reporting: [SECURITY.md](SECURITY.md)
- Contribution guide: [CONTRIBUTING.md](CONTRIBUTING.md)

---

# 中文说明

HInsight 是一个基于 Grafana 的开源派生项目，当前重点是将 Grafana 前端从 React 逐步迁移到 Vue，并保持用户操作、功能、样式、主题、i18n 和可访问性与原实现尽量 1:1 对齐。

本项目不是 Grafana Labs 官方项目，也不代表 Grafana Labs。Grafana 是 Grafana Labs 的商标；仓库中保留的 Grafana 相关名称、路径和源码主要用于说明上游来源、兼容历史结构以及迁移对照。

## 免责声明

本项目当前仅供测试、学习和研究使用。项目仍处于持续迁移和开发阶段，不保证稳定、完整、安全，也不保证适合生产环境使用。

使用本项目的全部风险由使用者自行承担。维护者和贡献者不提供任何明示或默示担保，包括但不限于适销性、特定用途适用性、可用性、数据完整性或生产可靠性等担保。对于因生产部署或以其他方式使用本项目而产生的任何直接或间接损失、损害、服务中断、数据丢失、安全事件、合规问题或其他后果，维护者和贡献者不承担责任。

在任何生产、商业或受监管环境中使用本项目前，请自行完成技术评估、安全评估、合规审查和法律审查。

## 当前状态

- 默认生产构建入口是 Vue Host：`yarn build`
- 默认开发入口也是 Vue Host：`yarn start`
- Vue 业务实现以 `webrs/app/` 下的 mirror 代码为准
- `public/app/**` 保留为 React 对照基线，默认不作为 Vue Host 编译、打包或运行入口
- `packages/hjqy-app-vue/` 当前主要承载 Vue app 构建配置与产物
- `packages/hjqy-ui/src/vue/` 承载 Vue 版 UI 组件实现

迁移细节见 [MIGRATION.md](MIGRATION.md)。贡献约束见 [CONTRIBUTING.md](CONTRIBUTING.md) 和 [AGENTS.md](AGENTS.md)。

HInsight 在开发过程中得到了 Codex 的大力协助，主要使用 GPT-5.2。详见 [ACKNOWLEDGEMENTS.md](ACKNOWLEDGEMENTS.md)。

## 目录说明

| 路径                        | 用途                                         |
| --------------------------- | -------------------------------------------- |
| `webrs/app/`                | Vue Mirror 业务实现，生产/开发入口以这里为准 |
| `public/app/`               | React 对照源码，迁移时用于 1:1 对齐          |
| `packages/hjqy-ui/src/vue/` | Vue UI 组件                                  |
| `packages/hjqy-app-vue/`    | Vue app 构建壳与产物                         |
| `packages/`                 | 前端 workspace 包                            |
| `apps/`                     | Grafana/HInsight app-platform 后端应用模块   |
| `docs/migration-vue/`       | 迁移设计、验收记录与审计资料                 |
| `scripts/webpack/`          | Vue Host 开发与生产 webpack 配置             |
| `conf/`                     | 默认配置与示例配置                           |

## 环境要求

- Node.js: `>=22 <25`，推荐 Node 22.x
- Yarn: `4.11.0`，仓库通过 `.yarn/releases/yarn-4.11.0.cjs` 固定版本
- Go: 以 `go.mod` 声明为准

如果本机有多个 Node 版本，建议先切换：

```bash
nvm use 22.12.0
```

## 快速开始

安装依赖：

```bash
yarn install
```

启动开发服务：

```bash
yarn start
```

默认访问地址：

```text
http://localhost:3001/
```

构建 Vue app：

```bash
yarn x:app-vue:build
```

生产构建：

```bash
yarn build
```

## 迁移门禁

日常开发至少执行：

```bash
yarn x:guard:dsc:hard
yarn x:app-vue:build
```

快速验证：

```bash
yarn x:verify:dsc:quick
```

完整验证：

```bash
yarn x:verify:dsc:full
```

核心硬约束：

- Vue Host 和 Mirror 代码不得引入 `react`、`react-dom` 或 React runtime 挂载机制
- 默认不得修改 `public/app/**` 运行时代码
- 不新增本地 stub，不新增 `*.d.ts`
- Mirror 下不得提交空壳 Vue SFC
- Vue 样式不得使用 `<style scoped>` 或硬编码颜色，应使用主题 token / `useStyles2Vue` 等既有机制

完整规则以 [AGENTS.md](AGENTS.md) 为准。

## 开源与许可证

本项目默认许可证为 [AGPL-3.0-only](LICENSE)。部分目录沿用上游或第三方许可证，详见 [LICENSING.md](LICENSING.md)。

本项目基于 Grafana，相关上游归属与第三方 notice 见 [NOTICE.md](NOTICE.md)。如果你基于本仓库继续发布二次发行版，请保留许可证、notice 和上游归属说明。

AI 协助致谢见 [ACKNOWLEDGEMENTS.md](ACKNOWLEDGEMENTS.md)。人工维护者仍对已审查和接受的变更负责。

AGPL 对网络服务分发有源代码提供义务。正式商用发布前请结合你的分发方式、商标使用和第三方依赖情况做一次法律审查。

## 项目链接

- 知乎专栏：[HInsight Core](https://www.zhihu.com/column/c_2033636608637916097)

## 支持与安全

- 使用问题见 [SUPPORT.md](SUPPORT.md)
- 安全漏洞披露见 [SECURITY.md](SECURITY.md)
- 贡献指南见 [CONTRIBUTING.md](CONTRIBUTING.md)