Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update log-viewer manual #356

Merged
merged 1 commit into from
Jan 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
263 changes: 84 additions & 179 deletions application/assets/deepin-log-viewer/log-viewer/en_US/log-viewer.md
100644 → 100755

Large diffs are not rendered by default.

Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file modified application/assets/deepin-log-viewer/log-viewer/zh_CN/fig/syslog.png
100755 → 100644
Diff not rendered.
150 changes: 27 additions & 123 deletions application/assets/deepin-log-viewer/log-viewer/zh_CN/log-viewer.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@

日志收集工具是负责收集程序运行时所产生日志的小工具,如操作系统和应用程序在启动、运行等过程中的相关信息。您可以通过分析详细日志信息,快速地找到故障原因并解决问题。



## 使用入门

您可以通过以下方式运行或关闭日志收集工具,或者创建快捷方式
您可以通过以下方式运行、关闭日志收集工具,或创建快捷方式

### 运行日志收集工具

Expand All @@ -27,134 +25,37 @@

## 操作介绍

> ![attention](../common/attention.svg)日志收集工具支持多种日志类型的展示。由于系统版本或架构的不同,可查看的日志类型可能有所差异,具体功能请以最终页面显示内容为准。
>
> ![attention](../common/attention.svg) 由于日志类型的不同,提供的筛选项、是否能在文件管理器中显示及是否支持清除日志的功能也有所区别,具体功能请参照最终页面的显示内容。
>
> 下文将以系统日志和内核日志 **为例** ,介绍日志收集工具的操作方式。

### 搜索日志

1. 在日志收集工具搜索框中,单击 ![search](../common/search.svg)。
2. 输入关键字,实时显示搜索结果。
3. 单击 ![close_icon](../common/close_icon.svg) ,则清空搜索内容。


![search_log](fig/search_log.png)

### 筛选日志

您可以通过 **周期**、**级别**、**状态**、**应用列表** 或 **事件类型** 来筛选日志。
<table border="1">
<tr>
<th>类型</th>
<th>说明 </th>
</tr>
<tr>
<td>按周期筛选</td>
<td>按日志生成的时间顺序进行筛选。
<ul>
<li>选项包括:全部、今天、近三天、近一周、近一个月、近三个月,默认选项为全部。</li>
<li>适用类型:除了启动日志没有显示时间外,其他类型的日志都支持按周期筛选。</li>
</ul>
</td>
</tr>
<tr>
<td>按级别筛选</td>
<td>按照事件的级别高低进行筛选。
<ul>
<li>选项包括:全部、紧急、严重警告、严重、错误、警告、注意、信息、调试,默认选项为信息。</li>
<li>适用类型:系统日志、应用日志。</li>
</ul>
<tr>
<td>按状态筛选</td>
<td>
<ul>
<li>选项包括:全部、OK、Failed,默认选项为全部。</li>
<li>适用类型:仅适用于启动日志。</li>
</ul>
<tr>
<td>按应用列表筛选</td>
<td>
适用类型:仅适用于应用日志,对应用程序的log文件进行筛选,默认选项为第一个应用程序。 </td>
<tr>
<td>按事件类型筛选</td>
<td>
<ul>
<li>选项包括:全部、登录、开机、关机,默认选项为全部。</li>
<li>适用类型:仅适用于开关机事件。</li>
</ul>
</td>
</tr>
</table>
1. 在日志收集工具顶部筛选栏中,选择需要筛选的选项。
2. 点击或选择筛选项后,日志收集工具将立即展示筛选结果。

![filter_log](fig/filter_log.png)

### 查看日志

#### 查看系统日志

1. 在日志收集工具界面,单击 **系统日志**。
2. 查看系统日志的级别、进程、时间和信息。
3. 选中某条日志后,可查看该日志的详细信息,包括进程、时间、主机名、进程号、级别和详细信息。
1. 在日志收集工具界面,单击 需要查看的日志类型菜单,工具右侧列表会展示当前日志类型下所有的日志。
3. 鼠标左键单击某条日志后,可在工具下方查看该日志的详细信息。

![rsylog](fig/syslog.png)

#### 查看内核日志

1. 在日志收集工具界面,单击 **内核日志**。
2. 弹出“密码认证”窗口,输入用户登录密码后单击 **确定**。
3. 查看内核日志的时间、主机名、进程和信息。
4. 选中某条日志后,可查看该日志的详细信息,包括进程、时间、主机名和详细信息。

![kernlog](fig/kernlog.png)

#### 查看启动日志

1. 在日志收集工具界面,单击 **启动日志**。
2. 弹出“密码认证”窗口,输入用户登录密码后单击 **确定**。
3. 查看启动日志的状态和信息。
4. 选中某条日志后,可查看该日志的详细信息,包括主机名、状态和详细信息。

![bootlog](fig/bootlog.png)

#### 查看dpkg日志

1. 在日志收集工具界面,单击 **dpkg日志**。
2. 查看dpkg日志的时间和信息。
3. 选中某条日志后,可查看该日志的详细信息,包括时间、主机名、动作和详细信息。

![dpkglog](fig/dpkglog.png)

#### 查看Xorg日志

1. 在日志收集工具界面,单击 **Xorg日志**。
2. 查看Xorg日志的时间和信息。
3. 选中某条日志后,可查看该日志的详细信息,包括时间、主机名和详细信息。

![xorglog](fig/xorglog.png)

#### 查看应用日志

1. 在日志收集工具界面,单击 **应用日志**。
2. 查看应用日志的级别、时间、来源和信息。
3. 选中某条日志后,可查看该日志的详细信息,包括来源、时间 、主机名、级别和详细信息。

![applog](fig/applog.png)

#### 查看开关机事件

1. 在日志收集工具界面,单击 **开关机事件**。
2. 查看开关机事件的事件类型、用户名、时间和信息。
3. 选中某条日志后,可查看该日志的详细信息,包括时间、主机名、事件类型、用户名和详细信息。

![power_event](fig/power_event.png)

#### 查看其它日志

1. 在日志收集工具界面,单击 **其它日志**。
2. 其它日志以文件列表方式展示日志文件的文件名称、修改日期。同类日志文件以文件夹方式展示。
3. 选中某个文件后,可查看该文件的详细内容。拖拽文件列表和详细内容分界线,可以同步调整两区域大小。

![otherslog](fig/otherslog.png)



### 自定义日志

自定义日志功能是将日志文件添加至日志收集工具进行查看、导出。自定义日志兼容Gsettings配置和Dconfig配置。
自定义日志功能允许您将日志文件添加到日志收集工具中进行查看和导出。自定义日志兼容Gsettings配置和Dconfig配置。

**Gsettings配置**

Expand Down Expand Up @@ -185,42 +86,47 @@ dde-dconfig --set -a org.deepin.log.viewer -r org.deepin.log.viewer -k customLog
2. 如果弹出密码认证窗口,输入用户登录密码后单击 **确定**。
3. 在弹出的窗口中,选择存储位置,单击 **保存**。

>![icon](../common/notes.svg) 说明:您也可以单击标题栏上的全部导出按钮 ![icon](../common/export.svg),将系统日志、内核日志、启动日志、dpkg日志、Xorg日志、应用日志和开关机事件的日志全部导出。
>![icon](../common/notes.svg) 说明:您也可以单击标题栏上的全部导出按钮 ![icon](../common/export.svg),将全量的日志导出。

![export_log](fig/export_log.png)

### 刷新日志

刷新日志分为手动刷新和自动刷新,如果是自动刷新日志,还可以设置自动刷新的频率
刷新日志分为手动刷新和自动刷新,自动刷新日志的频率可以自定义

#### 手动刷新日志

单击标题栏上的立即刷新按钮 ![icon](../common/refresh.svg);或右键单击某一日志类型,选择 **刷新**,刷新日志。

![refresh_log](fig/refresh_log.png)

#### 自动刷新日志

1. 在日志收集工具界面,单击 ![icon_menu](../common/icon_menu.svg) > **刷新频率**。
2. 选择自动刷新的频率:**每10秒**、**每1分钟** 或 **每5分钟**, 刷新日志。

如果选择 **不刷新**,表示停止自动刷新日志。
2. 选择自动刷新的频率:**每10秒**、**每1分钟** 或 **每5分钟**, 刷新日志。选择 **不刷新** 即停止自动刷新日志。”

![auto_refresh](fig/auto_refresh.png)

### 在文件管理器中显示

在日志收集工具中仅内核日志、启动日志、dpkg日志、Xorg日志和应用日志支持 **在文件管理器中显示** 的功能。
通过 **在文件管理器中显示** 的功能,您可以查看部分日志的原始日志文件

1. 在日志收集工具左侧导航栏中,右键单击某一日志类型。
2. 选择 **在文件管理器中显示**,定位到当前日志的存储位置。


![right](fig/rightclick.png)

![show_in_fileManager](fig/show_in_fileManager.png)

### 清除日志

在日志收集工具中仅内核日志、启动日志、dpkg日志、Xorg日志和应用日志支持 **清除日志** 的功能。
1. 在日志收集工具左侧导航栏中,右键单击某一日志类型。
2. 选择 **清除日志**。
3. 弹出“确定清除日志”提示框,单击 **确定**。
4. 如果弹出密码认证窗口,输入用户登录密码后单击 **确定**。

![delete_log](fig/delete_log.png)


## 主菜单

Expand All @@ -233,7 +139,6 @@ dde-dconfig --set -a org.deepin.log.viewer -r org.deepin.log.viewer -k customLog
1. 在日志收集工具界面,单击 ![icon_menu](../common/icon_menu.svg)。
2. 选择 **主题**,选择一个主题颜色。


### 帮助

查看帮助手册,进一步了解和使用日志收集工具。
Expand All @@ -242,7 +147,6 @@ dde-dconfig --set -a org.deepin.log.viewer -r org.deepin.log.viewer -k customLog
2. 选择 **帮助**。
3. 查看日志收集工具的帮助手册。


### 关于

1. 在日志收集工具界面,单击 ![icon_menu](../common/icon_menu.svg)。
Expand Down
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file modified application/assets/deepin-log-viewer/log-viewer/zh_HK/fig/syslog.png
100755 → 100644
Diff not rendered.
Loading
Loading