@cloudcare/guance-front-tools 1.0.7 → 1.0.9

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 CloudCare
+Copyright (c) 2024 Guance Cloud for Observability
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/docs/en/grafana-guance-data-source.md

@@ -0,0 +1,37 @@
+---
+title: 'Grafana Guance Datasource'
+summary: 'Datasource source provided by Guance Cloud for integration with Grafana.'
+icon: 'icon/xxx/'
+---
+
+# Grafana Guance Datasource
+
+The purpose of this plugin is to display data from Guance Cloud in Grafana by providing a Datasource plugin.
+
+## Configuration {#config}
+
+1. [Click to download the plugin](https://static.guance.com/grafana-plugins/guance-guance-datasource.zip)
+
+2. Locate the Grafana configuration file. The default path can be found in the [official documentation](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#configuration-file-location).
+
+3. In the configuration file, find the plugin directory setting:
+
+```
+[paths]
+plugins = "/path/to/grafana-plugins"
+```
+
+4. Extract the downloaded file into the plugin directory:
+
+```
+unzip guance-guance-datasource.zip -d YOUR_PLUGIN_DIR/
+```
+
+5. Update the configuration file with the following setting:
+
+```
+[plugins]
+allow_loading_unsigned_plugins = guance-guance-datasource
+```
+
+6. Restart Grafana.

package/docs/en/quick-guide.md

@@ -0,0 +1,47 @@
+---
+title: 'Grafana Dashboard Import'
+summary: 'Grafana Dashboard Template Import Tool for Guance Cloud'
+icon: 'icon/xxx/'
+---
+
+# Grafana Dashboard Import Tool
+
+Guance Cloud provides a Node.js script to convert Grafana dashboard JSON templates into Guance Cloud dashboard JSON templates.
+
+## Configuration {#config}
+
+### Prerequisites {#requirement}
+
+Ensure that `nodejs` and `npm` are installed on the system with the following version requirements:
+
+1. node >= 12.7.0
+2. npm >= 6.10.0
+
+### Usage
+
+1. Install the script
+
+```bash
+$ npm install -g @cloudcare/guance-front-tools
+```
+
+2. View the script usage help
+
+```bash
+$ grafanaCovertToGuance
+```
+
+The specific script commands are:
+
+- `-d`: Path to the Grafana JSON file, e.g.: `./grafana/json/grafana.json`
+- `-o`: Output path for the Guance dashboard JSON file, e.g.: `./guance/json/guance.json`
+
+3. Execute the conversion command
+
+```bash
+$ grafanaCovertToGuance -d ./grafana/json/grafana.json -o ./guance/json/guance.json
+```
+
+4. Import the converted JSON file in the Guance Cloud console.
+
+5. Done.

package/docs/zh/grafana-guance-data-source.md

@@ -0,0 +1,37 @@
+---
+title: 'Grafana Guance Datasource'
+summary: 'Grafana 接入观测云数据提供的 Datasource 源'
+icon: 'icon/xxx/'
+---
+
+# Grafana Guance Datasource
+
+本插件目的为在 Grafana 中展示观测云数据，提供的 Datasource 插件。
+
+## 配置 {#config}
+
+1. [点击下载插件](https://static.guance.com/grafana-plugins/guance-guance-datasource.zip)
+
+2. 找到 Grafana 配置文件，默认路径参考[官方文档](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#configuration-file-location)
+
+3. 在配置文件中找到配置的插件目录
+
+```
+[paths]
+plugins = "/path/to/grafana-plugins"
+```
+
+4. 下载的文件解压放到插件目录
+
+```
+unzip guance-guance-datasource.zip -d YOUR_PLUGIN_DIR/
+```
+
+3. 修改配置项为：
+
+```
+[plugins]
+allow_loading_unsigned_plugins = guance-guance-datasource
+```
+
+4. 重启 Grafana

package/docs/zh/quick-guide.md

@@ -0,0 +1,46 @@
+---
+title: 'Grafana Dashboard Import'
+summary: 'Grafana Dashboard 模版导入观测云工具'
+icon: 'icon/xxx/' # 这里是该主题的 icon 目录，该目录下有多个图片文件
+---
+
+# Grafana Dashboard 导入工具
+
+观测云目前提供 grafana dashboard json 模版转换为观测云仪表板 json 模版的 node 脚本
+
+## 配置 {#config}
+
+### 前置条件 {#requirement}
+
+需要在系统中安装 `nodejs`、`npm`,版本要求如下：
+
+1. node >= 12.7.0
+2. npm >= 6.10.0
+
+### 使用方式
+
+1. 安装脚本
+
+```bash
+$ npm install -g @cloudcare/guance-front-tools
+```
+
+2. 查看脚本使用帮助
+
+```bash
+ $ grafanaCovertToGuance
+```
+
+具体脚本执行命令如下：
+`-d`: grafana json 文件的目录位置，例如：`./grafana/json/grafana.json`
+`-o`: 观测云仪表板 json 文件的输出位置，例如: `./guance/json/guance.json`
+
+3. 执行转换命令
+
+```bash
+$ grafanaCovertToGuance -d ./grafana/json/grafana.json -o ./guance/json/guance.json
+```
+
+4. 在观测云控制台导入转换后的 json 文件
+
+5. 完成