ascend-robot【双合】【docs】修复WinLibs - GCC+MinGW-w64 compiler for Windows下载连接打不开的问题

开发指南

1. MindStudio-Insight开发软件

软件名	用途
Webstorm(推荐)	编写&启动前端
CLion(推荐)	编写&启动C++后端

2. 开发环境配置

软件名	版本要求	用途
Node.js	v18.20.8+	前端
Python	3.11+	工具脚本
MinGW	10.0+ （msvcrt版本）	执行编译程序
git	无	代码的拉取与提交
cmake	3.16~3.20	后端项目构建与编译

3. 开发步骤

3.1 代码下载及环境配置

3.1.1 fork代码到自己仓库，并使用git从自己远程仓库clone代码到本地

MindStudio-Insight

3.1.2 使用CLion或其他软件打开MindStudio-Insight文件夹下的server文件夹

Cli_to_server_path

3.1.3 配置CLion设置

1. 点击右上角的设置按钮选择设置选项

Cli_setting

2. 选择构建、执行、部署中的工具链选项，并且将工具集*中的路径指向自己下载好的MinGW工具中

toolchain_setting

3. 选择构建、执行、部署中的CMake选项，并且将工具链指向自己下载好的MinGW

CMake_toolchain_setting

3.2 第三方库的下载与执行编译

3.2.1 下载第三方库与预运行第三方库

在server文件夹下新建一个新的终端，在终端中运行如下代码，成功执行如下图3-1 download_third_party_success，图3-2 预运行成功所示注：在执行此步骤之前请保证网络畅通

cd build
python download_third_party.py
python preprocess_third_party.py

图3-1 download_third_party_success

download_third_party_success

图3-2 预运行成功

preload_success

3.2.2 CMake编译

点击右下角的CMake按钮，选择重新加载CMake项目

reload_CMake

如CMake重载成功则如下图所示

图3-3 重新加载CMake成功

reload_CMake_success

3.3 CLion中的Main函数配置与启动，后端开发者测试

3.3.1 Main函数的配置

打开profiler_server旁的更多选项，选择编辑选项

edit_options

选择profiler_server选项，并且将参数修改为 --wsPort=9000 后点击确定保存
- 提示：端口可以设置为其他端口，以避免和其他端口冲突
- 警告：如果您的开发机器中已打开了Insight桌面端应用，请确认设置wsPort不会与已开启的insight产生端口冲突（Insight应用默认为9000, 但多开时将从9000端口逐个+1绑定占用，建议设置为9050~9099），否则可能导致前后端连接问题或其他未预期的异常，建议本地开发调试时，关闭所有已开启的Insight应用。

add_port

3.3.2 启动构建profiler_server

点击右上角的启动按钮，启动构建profiler_server

start_build

构建成功如下图所示

build_complete

3.3.3 后端开发者测试

测试框架：GoogleTest
覆盖率：后端覆盖率的要求是行覆盖率达到80%，分支覆盖率达到60%。Linux系统上，运行如下代码即可生成覆盖率，覆盖率文件位置是build_llt/output/cpp_coverage/result/index.html。

cd build
bash cpp_coverage.sh

新增开发者测试：后端合入新特性代码时，要求同时补充DT，DT代码位置是server/src/test。在CLion设置的构建、执行、部署中的CMake选项中添加环境变量DEV_TYPE=true，然后重新加载CMake，就可以构建insight_test可执行文件。构建完成后，如果测试用例名称为TEST_F(TestSuit, TestCase)，那么执行如下命令就可以只执行TestSuit测试套件的用例，更多用法可以参考GoogleTest官方文档：

./insight_test --gtest_filter=TestSuit.*

3.4. 在WebStorm启动前端

3.4.1 安装前端依赖

安装pnpm依赖

npm install -g pnpm

打开WebStorm进入modules文件夹下，执行安装指令

pnpm install

成功安装结果如下图所示

setup_finished

3.4.2 拉起前端模块服务

MindStudio-Insight采用模块设计，其中framework模块为基础功能模块，其他模块可按需启动加载

文件夹名称	对应模块
cluster	概览（summary）、通信（communication）
compute	算子调优
framework	基础功能
leaks	内存泄露检查
memory	内存
operator	算子
reinforcement-learning	强化学习
statistic	服务化调优
timeline	时间线

进入模块项目中，在该模块的package.json文件中执行npm run start命令即可启动该模块

start_module

模块启动成功如下图所示

start_success

请注意，请确保framework模块启动成功，否则无法启动网页端MindStudio-Insight

3.4.3 开发者环境下运行MindStudio-Insight

在浏览器中输入localhost:5174启动网页端
网页端启动成功如下图所示

insight_start_success

3.5. 预冒烟测试

预冒烟测试可以在Linux或Windows上进行

3.5.1 在Linux上进行预冒烟测试

在Linux上进行预冒烟测试推荐使用docker
要安装测试框架Playwright及其相关依赖，建议使用Playwright官方镜像，参考Playwright官网，镜像tag为v1.57.0-jammy
从镜像创建容器后，需要安装前端和后端需要的其它依赖，在容器中，执行build目录下的mindstudio_insight_gui_set_environment.sh脚本安装依赖

bash build/mindstudio_insight_gui_set_environment.sh

bash build/mindstudio_insight_gui_run.sh

以进行预冒烟测试，并查看结果

3.5.2 在Windows上进行预冒烟测试

在Windows上进行预冒烟测试，安装依赖参考GUI指导文档
在e2e目录下，执行

npm run test:smoke

以进行预冒烟测试，并查看结果

4 新增模块开发

此部分只展示架构部分开发以及接入，具体模块实现逻辑请根据实际情况设计开发

前端部分

添加新模块目录

在 modules 目录创建新的模块

    .
    ├── modules
    │   ├── framework
    │   ├── new_module
    │   └── package.json

新模块可参考如下目录结构

    .
    ├── new_module
    │   ├── src
    │   │   ├── assets
    │   │   ├── components
    │   │   ├── connection
    │   │   ├── store
    │   │   ├── theme
    │   │   ├── units
    │   │   ├── App.tsx
    │   │   ├── index.tsx
    │   │   └── index.css
    │   ├── craco.config.js
    │   ├── tsconfig.json
    │   └── package.json

构建配置

craco.config.js

const { webpackCfg, configureConfig } = require("../build-config");

const path = require("path");

const libPath = path.resolve(__dirname, "../lib/src");
const echartsPath = require.resolve("echarts");

module.exports = {
  devServer: {
    port: 3001,
    open: false,
    client: {
      overlay: {
        runtimeErrors: (error) => {
          // 禁止界面展示错误：ResizeObserver loop completed with undelivered notifications
          return !error?.message.includes("ResizeObserver");
        },
      },
    },
  },
  webpack: {
    alias: webpackCfg.alias,
    configure: (webpackConfig) => {
      return configureConfig(webpackConfig, [libPath, echartsPath]);
    },
  },
};

基础 scripts 配置

package.json

{
    "scripts": {
         "start": "cross-env NODE_OPTIONS=--openssl-legacy-provider craco start",
         "build": "cross-env NODE_OPTIONS=--openssl-legacy-provider NODE_ENV=production GENERATE_SOURCEMAP=false CI=false craco build",
         "build:dev": "cross-env GENERATE_SOURCEMAP=true CI=false craco build",
        ... // 自定义配置
    }
}

src 中必要模块

theme： 主题

theme/index.ts

export { themeInstance } from "@insight/lib/theme";
export type { ThemeItem } from "@insight/lib/theme";

connection： 通信

connection/index.ts

import { ClientConnector } from "@insight/lib/connection";
export default new ClientConnector({
  getTargetWindow: (): any[] => [window.parent],
  module: [new_module_request_name],
});

其他部分根据新模块的实际需求自定义

在主服务中加入新模块（微服务）

framework 模块的 moduleConfig.ts 中，在 modulesConfig 中配置新模块

{
     name: [new_module],   // 新模块的微服务名，自定义
     requestName: [new_module_request_name], // 前后端交互的模块名，与后端协定
     attributes: {
         src: isDev ? 'http://localhost:[new_port]/' : './plugins/[new_module]/index.html', // 本地开发端口自行分配
     },
     isDefault: true, // 默认是否显示该微服务
     ... // 其他配置条件
 }

代码来源： build/build.py

新增模块的构建后清理

def clean():
    out = os.path.join(PROJECT_PATH, Const.OUT_DIR)
    if os.path.exists(out):
        shutil.rmtree(out)
    ascend_insight = os.path.join(PROJECT_PATH, Const.PRODUCT_DIR)
    if os.path.exists(ascend_insight):
        shutil.rmtree(ascend_insight)
    framework_dist = os.path.join(PROJECT_PATH, Const.MODULES_DIR, Const.FRAMEWORK_DIR, 'build')
    if os.path.exists(framework_dist):
        shutil.rmtree(framework_dist)
    # 需在此处添加你的新增模块
    modules = ['cluster', 'memory', 'timeline', 'compute', 'jupyter', 'operator', 'lib', 'statistic', 'leaks',
               'reinforcement-learning']
    for module in modules:
        build_dir = os.path.join(PROJECT_PATH, Const.MODULES_DIR, module, Const.BUILD_DIR)
        if os.path.exists(build_dir):
            shutil.rmtree(build_dir)

代码来源： build/build.py

新增模块的名称以及构建

# 在这里添加你的模块以及对应的模块名称
MODULES_MAP = {
    'cluster': 'Cluster',
    'reinforcement-learning': 'RL',
    'memory': 'Memory',
    'operator': 'Operator',
    'compute': 'Compute',
    'statistic': 'Statistic',
    'leaks': 'Leaks',
    'timeline': 'Timeline',
}

代码来源： modules/framework/src/components/TabPane/Index.tsx

该函数用于根据输入的数据对象 data 更新场景信息，并将更新后的场景信息传递给 updateSession 函数。主要目的是收集和处理各种场景标志，用于后续的会话管理或数据处理。

export function updateDataScene(data: Record<string, any>): void {
    const sceneInfo = {
        // 在此处添加新增模块，对应数据更新
        isCluster: data.isCluster ?? false,
        isReset: data.reset ?? false,
        isIpynb: data.isIpynb ?? false,
        isBinary: data.isBinary ?? false,
        hasCachelineRecords: data.hasCachelineRecords ?? false,
        isOnlyTraceJson: data.isOnlyTraceJson ?? false,
        instrVersion: data.instrVersion ?? -1,
        isLeaks: data.isLeaks ?? false,
        isIE: data.isIE ?? false,
        isRL: false,
        isHybridParse: data.isCluster && data.isIE,
    };
    updateSession(sceneInfo);
}

// 在此处添加新增模块，对应页签改变的处理
useEffect(() => {
    // 删除工程的场景：不改变页签
    if (session.isBinary === null && session.isCluster === null) {
        return;
    }
    setScene(session.scene);
    setDataCompose({ hasCachelineRecords: session.hasCachelineRecords, isRL: session.isRL });
}, [session.isBinary, session.isCluster, session.hasCachelineRecords, session.isOnlyTraceJson, session.isIE, session.isLeaks, session.isRL, session.isHybridParse]);

代码来源： modules/framework/src/entity/session.ts

在此处添加新增模块对应的导入数据场景

// 在此处添加新增模块对应的导入数据场景
// Scene：数据场景：默认、集群、算子调优、Leaks、只trace.json文件
export type Scene = 'Default' | 'Cluster' | 'Compute' | 'OnlyTraceJson' | 'IE' | 'Leaks' | 'RL' | 'HybridParse';

export class Session {
    // 需添加新模块至场景中
    // 场景
    isCluster: boolean | null = false;
    isBinary: boolean | null = false;
    isIE: boolean | null = false;
    isReset: boolean = false;
    isFullDb: boolean = false;
    isOnlyTraceJson: boolean = false;
    isLeaks: boolean = false;
    isRL: boolean = false;
    isHybridParse: boolean = false;
    hasCachelineRecords: boolean = false;
    instrVersion: number = -1;

    // 需添加新模块至场景中
    // 导入数据场景：默认、集群、算子调优、只trace.json
    get scene(): Scene {
        let scene: Scene;
        if (this.isHybridParse) {
            scene = 'HybridParse';
        } else if (this.isOnlyTraceJson) {
            scene = 'OnlyTraceJson';
        } else if (this.isLeaks) {
            scene = 'Leaks';
        } else if (this.isBinary) {
            scene = 'Compute';
        } else if (this.isCluster) {
            scene = 'Cluster';
        } else if (this.isIE) {
            scene = 'IE';
        } else {
            scene = 'Default';
        }
        return scene;
    }
    ....
}

代码来源： modules/framework/src/moduleConfig.ts

需添加新模块至模块设置中

// 需添加新模块至模块设置中
export interface ModuleConfig {
    name: string;
    requestName: Lowercase<string>;
    attributes: IframeHTMLAttributes<HTMLIFrameElement>;
    isDefault?: boolean;
    isCluster?: boolean;
    isCompute?: boolean;
    isLeaks?: boolean;
    isIE?: boolean;
    isRL?: boolean;
    hasCachelineRecords?: boolean;
    isOnlyTraceJson?: boolean;
    isHybridParse?: boolean;
}
// 需添加新模块至模块设置中，下为模块样例，注意端口号不要与其他模块冲突
{
    name: 'xxx',
    requestName: 'xxx',
    attributes: {
        src: isDev ? 'http://localhost:3000/xxx' : './plugins/xxx/index.html',
    },
    isXXX: true,
},

代码来源： modules/lib/src/connection/index.ts

// 新增模块的查询接口要写在connection中

代码来源： modules/lib/src/i18n/index.ts

新增模块的中英文切换由公共模块统一管理

// 新增模块的中英文切换由公共模块统一管理
import xxxEn from './leaks/en.json';
import xxxZh from './leaks/zh.json';

export const resources = {
    enUS: {
        ...en,
        ...frameworkEn,
        ...xxxEn,
    },
    zhCN: {
        ...zh,
        ...frameworkZh,
        ...xxxZh,
    },
};

后端部分

后端开发结构对应

server ├── src │ ├── modules │ │ ├── xxx_module │ │ │ ├── database │ │ │ │ ├── xxxBase.h │ │ │ │ └── xxxBase.cpp │ │ │ ├── handler │ │ │ └── protocol

后端代码层面

代码来源： server/msinsight/include/base/ProtocolUtil.h

JSON的协议处理，Response的传递在这里编写

struct JsonResponse : public Response {
    explicit JsonResponse(const std::string &command) : Response(command) {}
    [[nodiscard]] virtual std::optional<document_t> ToJson() const = 0;
};
struct Event : public ProtocolMessage {
    explicit Event(const std::string &e) : event(e)
    {
        type = ProtocolMessage::Type::EVENT;
    }
    ~Event() override = default;
    std::string event;
    bool result = false;
};
struct JsonEvent : public Event {
    explicit JsonEvent(const std::string &e) : Event(e) {}
    [[nodiscard]] virtual std::optional<document_t> ToJson() const = 0;
};
class ProtocolUtil {
public:
    ProtocolUtil() = default;
    virtual ~ProtocolUtil() = default;

    void Register();
    void UnRegister();

    std::unique_ptr<Request> FromJson(const json_t &requestJson, std::string &error);
    std::optional<document_t> ToJson(const Response &response, std::string &error);
    std::optional<document_t> ToJson(const Event &event, std::string &error);

    // set base info
    // request
    static bool SetRequestBaseInfo(Request &request, const json_t &json);
    // response
    static void SetResponseJsonBaseInfo(const Response &response, document_t &json);
    // event
    static void SetEventJsonBaseInfo(const Event &event, document_t &json);

    // common json to request
    template <class SubRequest>
    static std::unique_ptr<Request> BuildRequestFromJson(const json_t &json, std::string &error)
    {
        static_assert(std::is_same_v<std::unique_ptr<Request>, decltype(SubRequest::FromJson(json, error))>,
                      "SubRequest must have a static FromJson method returning std::unique_ptr<Request>");
        return SubRequest::FromJson(json, error);
    }
    // response to json
    static std::optional<document_t> CommonResponseToJson(const Response &response)
    {
        try {
            const auto& jsonResponse = dynamic_cast<const JsonResponse&>(response);
            return jsonResponse.ToJson();
        } catch (const std::bad_cast& e) {
            return std::nullopt;
        }
    }
    ...
}

代码来源： server/src/CMakeLists.txt

CMake中要编译的新模块要添加在这里

# new Module
include_directories(${SRC_HOME_DIR}/modules/xxx)
include_directories(${SRC_HOME_DIR}/modules/xxx/xxx)

# new Module
aux_source_directory(${SRC_HOME_DIR}/modules/xxx xxx_xxx_SRC)

list(APPEND DIC_MODULES_SRC_LIST
        ${DIC_MODULES_XXX_SRC}
        ${DIC_MODULES_XXX_XXX_SRC}
)

代码来源： server/src/modules/Plugins.cpp

在此处添加新模块的相关信息

/*
 * -------------------------------------------------------------------------
 * This file is part of the MindStudio project.
 * Copyright (c) 2025 Huawei Technologies Co.,Ltd.
 *
 * MindStudio is licensed under Mulan PSL v2.
 * You can use this software according to the terms and conditions of the Mulan PSL v2.
 * You may obtain a copy of Mulan PSL v2 at:
 *
 *          http://license.coscl.org.cn/MulanPSL2
 *
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
 * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
 * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 * See the Mulan PSL v2 for more details.
 * -------------------------------------------------------------------------
 */
#include "AdvisorPlugin.h"
#include "GlobalPlugin.h"
#include "MemoryPlugin.h"
#include "OperatorPlugin.h"
#include "SourcePlugin.h"
#include "SummaryPlugin.h"
#include "TimelinePlugin.h"
#include "JupyterPlugin.h"
#include "CommunicationPlugin.h"
#include "IEPlugin.h"
#include "MemoryDetailPlugin.h"
// 在此处添加新模块相关信息
namespace Dic::Module {
    Core::PluginRegister ADVISOR_PLUGIN(std::make_unique<Advisor::AdvisorPlugin>());
    Core::PluginRegister GLOBAL_PLUGIN(std::make_unique<Global::GlobalPlugin>());
    Core::PluginRegister MEMORY_PLUGIN(std::make_unique<Memory::MemoryPlugin>());
    Core::PluginRegister OPERATOR_PLUGIN(std::make_unique<Operator::OperatorPlugin>());
    Core::PluginRegister SOURCE_PLUGIN(std::make_unique<Source::SourcePlugin>());
    Core::PluginRegister SUMMARY_PLUGIN(std::make_unique<Summary::SummaryPlugin>());
    Core::PluginRegister TIMELINE_PLUGIN(std::make_unique<Timeline::TimelinePlugin>());
    Core::PluginRegister JUPYTER_PLUGIN(std::make_unique<Jupyter::JupyterPlugin>());
    Core::PluginRegister COMM_PLUGIN(std::make_unique<Communication::CommunicationPlugin>());
    Core::PluginRegister IE_PLUGIN(std::make_unique<IE::IEPlugin>());
    Core::PluginRegister MEMORY_DETAIL_PLUGIN(std::make_unique<MemoryDetail::MemoryDetailPlugin>());
}

代码来源： server/src/modules/defs/ProtocolDefs.h

在此处添加新模块信息

// 在此处添加新模块信息
const std::string MODULE_XXX = "xxx";

const std::string MODULE_SUMMARY = "summary";
const std::string MODULE_COMMUNICATION = "communication";
const std::string MODULE_MEMORY = "memory";
const std::string MODULE_MEMORY_DETAIL = "memory_detail";
const std::string MODULE_OPERATOR = "operator";
const std::string MODULE_SOURCE = "source";
const std::string MODULE_ADVISOR = "advisor";

代码来源： server/src/modules/full_db/database/FullDbParser.cpp

如果涉及全量db查询，请将在此添加查询，例如如下方法中：

// 如果涉及全量db查询，请将在此添加查询，例如如下方法中：
void FullDbParser::Reset()

void FullDbParser::BuildProfilingInitTask(std::shared_ptr<std::vector<std::future<void>>> &futures, std::string &dbId,std::unique_ptr<ThreadPool> &pool)

5 DB场景新增泳道

前端部分

配置DB场景显示模块

framework/src/moduleConfig.ts


 [
    {
       name: 'Timeline',
       requestName: 'timeline',
       attributes: {
          src: isDev ? 'http://localhost:3000/' : './plugins/Timeline/index.html',
       },
       isIE: true,
    },
    {

       name: 'Statistic',
       requestName: 'statistic',
       attributes: {
          src: isDev ? 'http://localhost:3006/' : './plugins/Statistic/index.html',
       },
       isIE: true,
    }
 ]

导入DB文件

选择DB文件并发送解析指令import/action

async function handleProjectAction({ action, project, isConflict, selectedFileType, selectedFilePath, selectedRankId }:
{action: ProjectAction;project: Project;isConflict: boolean;selectedFileType?: LayerType;selectedFilePath?: string;selectedRankId?: string}): Promise<void> {
   ...
   runInAction(async() => {
       ...
       const res = await addDataPath(newProject, action, isConflict, session);
       ...
   });
   ...
}

代码来源： modules/framework/src/units/Project.tsx

主服务将解析结果发送给微服务

export const addDataPath = async function(project: Project, action: ProjectAction, isConflict: boolean, session: Session): Promise<boolean> {
   ...
   connector.send({
      event: 'remote/import',
      body: { dataSource: transformTimelineDataSource(project), importResult: res, switchProject },
      target: 'plugin',
   });
   ...
}

代码来源： modules/framework/src/centralServer/server.ts

微服务处理数据生成卡/泳道菜单

   export const importRemoteHandler: NotificationHandler = async (data): Promise<void> => {
      ...
      runInAction(() => {
         initUnitInfo(session, result, dataSource, isNeedResetRankId); // 根据解析结果初始化泳道信息
     });
     sendSessionUpdate(result, session);
      ...
   }

代码来源： modules/timeline/src/connection/handler.ts

微服务接收并处理卡解析结果

parse/success
```
export const parseSuccessHandler: NotificationHandler = (data): void => {
  ...
}
```
代码来源： modules/timeline/src/connection/handler.ts

微服务获取泳道数据并绘制泳道图

   const ThreadUnit = unit<ThreadMetaData>({
     name: 'Thread',
     pinType: 'copied',
     chart: chart()
   })

代码来源： modules/timeline/src/insight/units/AscendUnit.tsx

后端部分

创建一个profiler.db文件

create_profiler_db

创建表结构

1. slice

表示timeline的一个长方形色块，对应trace文档的ph为X的数据

structure_slice

建表语句

CREATE TABLE slice (id INTEGER PRIMARY KEY AUTOINCREMENT, timestamp INTEGER, duration INTEGER, name TEXT, depth INTEGER, track_id INTEGER, cat TEXT, args TEXT, cname TEXT, end_time INTEGER, flag_id TEXT);

2. process

表示timeline的非叶子泳道，对应trace文档的ph为M的数据

structure_process

建表语句 CREATE TABLE "process" ( "pid" TEXT, "process_name" TEXT, "label" TEXT, "process_sort_index" INTEGER, "parentPid" text, PRIMARY KEY ("pid") );

3. thread

表示timeline的叶子泳道，对应trace文档的ph为M的数据

structure_thread

4. counter

表示折线图或者直方图数据，对应ph为C的数据

structure_counter

建表语句 CREATE TABLE counter (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT, pid TEXT,timestamp INTEGER, cat TEXT, args TEXT);

5. flow

表示连线，对应ph为s，f，t的数据

structure_flow

建表语句 CREATE TABLE flow (id INTEGER PRIMARY KEY AUTOINCREMENT, flow_id TEXT, name TEXT, cat TEXT, track_id INTEGER, timestamp INTEGER, type TEXT);

6. dataTable

表示哪些表需要按照如下方式纯表展示

structure_dataTable 表字段说明

structure_filed_description

建表语句

CREATE TABLE "data_table" ( "id" INTEGER NOT NULL, "name" TEXT, "view_name" TEXT, PRIMARY KEY ("id") );

7. data_link

表示字段与某张表的某个字段的关联关系

structure_data_link

建表语句 CREATE TABLE "data_link" ( "source_name" TEXT NOT NULL, "target_table" TEXT NOT NULL, "target_name" TEXT NOT NULL, PRIMARY KEY ("source_name") );

8. translate

表示文本的中英文翻译

structure_translate

建表语句 CREATE TABLE "translate" ( "key" TEXT NOT NULL, "value_en" TEXT, "value_zh" TEXT, PRIMARY KEY ("key") );

添加非叶子泳道

在process表里添加二级泳道数据

add_non_leaf_lane

添加叶子泳道

add_leaf_lane

添加叶子泳道里的色块数据

add_color_block_data

添加色块关联关系

adding_color_block_associations

添加直方图数据

add_histogram_data

创建好的profiler.db拖入Insight即可看见新增泳道

6 开发者本地出包指南

Windows环境

环境依赖安装

依赖安装用户可以自行进行，如果对安装依赖有疑问，可以见文档附录

软件名称	版本	用途
rust	1.89	底座编译构建
windows11SDK	10.0.22000.0+	windows平台基础开发运行时
MSVC	v143	windows平台基础开发运行时
mingw	10.0+ （msvcrt版本）	后台编译器
Ninja	无要求	后台编译
cmake	3.16~3.20
nsis	无要求	安装包打包软件
nsProcess插件	unicode support	打包软件插件，用于检查是否有重复运行
node	v18.20.8+	前端构建
pnpm	无要求	前端构建
python	3.11+	集群工具打包

python requirements:

运行时requirements：

click
tabulate
networkx
jinja2
PyYaml
tqdm
prettytable
ijson
xlsxwriter>=3.0.6
sqlalchemy
numpy<=1.26.4
pandas<=2.3.2
psutil

开发时requirements：

pyinstaller

编译出包

1.进入项目根目录下server/build目录，执行python3 download_third_party.py && python3 preprocess_third_party.py

2.在Windows系统，MindStudio Insight会集成Python解释器。

第一步：在构建环境上手动安装Python解释器（同时包含pip），建议Python版本3.12.10；
第二步：设置环境变量 MINDSTUDIO_INSIGHT_PYTHON_INTERPRETER为Python解释器的安装目录，该目录需要包含解释器python.exe。示例：如果Python解释器的安装目录为D:\xxx\python，且该目录下包含解释器D:\xxx\python\python.exe，则设置环境变量 MINDSTUDIO_INSIGHT_PYTHON_INTERPRETER为D:\xxx\python。

3.进入项目根目录下build目录，执行python build.py即可，产物位于项目根目录out目录下

windows环境依赖安装附录

windows运行时安装（windows11SDK和MSVC）

下载Visual Studio Installer，双击打开, 进入安装界面，选择如下依赖（通常默认即可）：
mingw安装

从WinLibs - GCC+MinGW-w64 compiler for Windows下载对应的软件包，注意选择MSVCRT版本（>11.2）以确保编译出来的包具备更好的迁移性

下载后解压到任意目录下，然后修改系统中的PATH变量，向其中添加mingw64下bin目录路径，如下图所示，假设解压在C盘根目录下

nsProcess插件安装

首先需要安装NSIS，需要安装在C:\program (x86)目录下。从NsProcess plugin - NSIS上获取nsProcess的压缩包。把下载压缩包里面的Include/nsProcess.h 放到 C:\Program Files (x86)\NSIS\Include

把Plugin/nsProcess.dll 放到 C:\Program Files (x86)\NSIS\Plugins\x86-unicode中把Plugin/nsProcessw.dll 放到 C:\Program Files (x86)\NSIS\Plugins\x86-unicode中
Rust

安装方式：推荐使用官方工具 rustup 安装

官网：https://www.rust-lang.org

安装完成校验：
```
rustc --version
cargo --version
```
说明：用于底座代码的编译与构建，建议使用稳定版并保持版本不低于要求。
Ninja

安装方式：

Windows 可通过官网下载二进制文件，或使用包管理工具（如 Chocolatey、Scoop）安装

官网：https://ninja-build.org

安装完成校验：
```
ninja --version
```
说明：作为 CMake 的后台构建工具使用。
Node.js

安装方式：通过 Node.js 官方安装包安装

官网：https://nodejs.org

版本要求：v18.20.8 及以上（建议使用 LTS 版本）

安装完成校验：
```
node --version
npm --version
```
说明：用于前端工程的构建与依赖管理。
pnpm

安装方式：在已安装 Node.js 的前提下，通过 npm 全局安装
```
npm install -g pnpm
```
安装完成校验：
```
pnpm --version
```
说明：前端项目的包管理工具。
Python

安装方式：通过 Python 官方安装包安装

官网：https://www.python.org

版本要求：Python 3.11 及以上

安装完成校验：
```
python --version
pip --version
```
说明：用于集群工具及相关脚本的打包与运行，安装时请勾选“Add Python to PATH”。

Mac出包

环境依赖

软件名称	版本	用途
rust	1.89	底座编译构建
cargo-bundle	无要求
Ninja	无要求	后台编译
node	v18.20.8+	前端构建
pnpm	无要求	前端构建
python	3.11+	集群工具打包
clang	15
cmake	3.16~3.20

python requirements:

运行时requirements：

click
tabulate
networkx
jinja2
PyYaml
tqdm
prettytable
ijson
xlsxwriter>=3.0.6
sqlalchemy
numpy<=1.26.4
pandas<=2.3.2
psutil
dmgbuild

开发时requirements：

pyinstaller

编译出包

Step 1. 预处理构建依赖

cd server/build
python3 download_third_party.py && python3 preprocess_third_party.py

Step 2. 指定APP签名证书（可选）

注意：请您确保已阅读并知悉LICENSE要求。

步骤说明：Insight MacOS ARM版本在构建出包时，会对产物APP进行MacOS的开发者证书签名。您可以通过环境变量配置指定签名所用证书。如不指定，缺省时使用临时证书进行签名，可能导致您的insight产物无法通过网络进行分发（具体表现可能为将临时签名的产物通过网络分发到其他设备时，安装后无法打开），若您仅在本地进行调试运行，使用时不受影响，可跳过此步骤。
证书使用前置：要求为可用于签名的苹果开发者证书，并确保已正确导入钥匙串中（如登陆钥匙串~/Library/Keychains/login.keychain）。
通过环境变量配置证书，支持证书名或证书ID。

# 以证书名为"insight_cert"为例, 且使用前已将其导入了登陆钥匙串~/Library/Keychains/login.keychain
export INSIGHT_APP_SIGN="insight_cert"
# !注意执行如下钥匙串解锁命令后，您当前的交互式环境将可以访问该钥匙串下的证书/密钥，请确保环境的安全
security unlock-keychain -p {您当前用户的密码} ~/Library/Keychains/login.keychain

Step 3. 设置集成Python解释器的环境变量

在macOS系统，MindStudio Insight会集成Python解释器。
- 第一步：在构建环境上手动安装可移植的Python解释器（同时包含pip），建议Python版本3.12.10；
- 提示：“可移植”指将A机器上的Python文件夹拷贝到B机器上，在B机器上仍然可以直接使用。macOS上的某些Python版本，运行依赖绝对路径/Library下的动态库，当从A机器拷贝到B机器时，因为B机器/Library下无动态库，拷贝后的Python解释器无法运行。为了本地构建出的MindStudio Insight在其它机器上仍然可用，对macOS上安装的Python解释器要求可移植性。
- 第二步：设置环境变量 MINDSTUDIO_INSIGHT_PYTHON_INTERPRETER为Python解释器的安装目录，该目录需要包含解释器bin/python3，如果用户安装的Python解释器版本不为3.12，需手动修改server/build/build.py中变量version的值。示例：如果Python解释器的安装目录为/Users/xxx/python，且该目录下包含解释器/Users/xxx/python/bin/python3，则设置环境变量 MINDSTUDIO_INSIGHT_PYTHON_INTERPRETER为/Users/xxx/python。

Step 4. 执行出包脚本

进入项目根目录下build目录，执行python build.py即可，产物位于项目根目录out目录下

开发指南

1. MindStudio-Insight开发软件

2. 开发环境配置

3. 开发步骤

3.1 代码下载及环境配置

3.1.1 fork代码到自己仓库，并使用git从自己远程仓库clone代码到本地

3.1.2 使用CLion或其他软件打开MindStudio-Insight文件夹下的server文件夹

3.1.3 配置CLion设置

3.2 第三方库的下载与执行编译

3.2.1 下载第三方库与预运行第三方库

3.2.2 CMake编译

3.3 CLion中的Main函数配置与启动，后端开发者测试

3.3.1 Main函数的配置

3.3.2 启动构建profiler_server

3.3.3 后端开发者测试

3.4. 在WebStorm启动前端

3.4.1 安装前端依赖

3.4.2 拉起前端模块服务

3.4.3 开发者环境下运行MindStudio-Insight

3.5. 预冒烟测试

3.5.1 在Linux上进行预冒烟测试

3.5.2 在Windows上进行预冒烟测试

4 新增模块开发

前端部分

后端部分

后端开发结构对应

后端代码层面

5 DB场景新增泳道

前端部分

后端部分

创建一个profiler.db文件

创建表结构

添加非叶子泳道

添加叶子泳道

添加叶子泳道里的色块数据

添加色块关联关系

添加直方图数据

创建好的profiler.db拖入Insight即可看见新增泳道

6 开发者本地出包 指南

Windows环境

环境依赖安装

编译出包

windows环境依赖安装附录

Mac出包

环境依赖

编译出包

Step 1. 预处理构建依赖

Step 2. 指定APP签名证书（可选）

Step 3. 设置集成Python解释器的环境变量

Step 4. 执行出包脚本

6 开发者本地出包指南