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

Added audit logs, runtime logs, and updated job management #1888

Merged
merged 3 commits into from
Jan 30, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Audit log

The NebulaGraph audit logs store all operations received by graph service in categories. Dashboard Enterprise Edition allows you to quickly view audit logs.
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved

!!! enterpriseonly

Only when the cluster you created or imported is the Enterprise Edition, this feature is available.

## Entry

1. At the top navigation bar of the Dashboard Enterprise Edition page, click **Cluster Management**.
2. On the right side of the target cluster, click **Detail**.
3. On the left-side navigation bar of the page, click **Information**->**Audit Log**.

!!! note

- To use the audit log for the first time, you need to jump to the **Config Management** page as prompts to enable the audit log and restart the graph service.
- For the description of audit log parameters, see [Configure audit logs](../../..//5.configurations-and-logs/2.log-management/audit-log.md).

## View audit log

In the upper corner of the page, you can filter services or search for the log name. Click **View Log** in the **Operation** column.

- Support copying all logs in the window with one click.
- Support copying the log file path.
- Support **Tail Mode** and **Range Mode** to view logs. You need to click **Refresh** after setting.
- Support searching logs by keywords (at least 3 characters).
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Job management

Users can manage the jobs in a specified graph space through the dashboard, including viewing, stopping, and recovering jobs, and supports viewing the details of a single job.
Users can manage the jobs in a specified graph space through the Dashboard, including viewing, stopping, and recovering jobs, and supports viewing the details of a single job.

!!! note

Expand All @@ -18,19 +18,19 @@ Users can manage the jobs in a specified graph space through the dashboard, incl

After you select the graph space, the page will display all the job information that has not expired by default. You can quickly find jobs through the filter box at the top of the page as follows:

- Select a job status for filtering. The status includes `QUEUE`, `RUNNING`, `FINISHED`, `FAILED`, and `STOPPED`. For the status description, see [Job manager and the JOB statements](../../../3.ngql-guide/4.job-statements.md).
- Select a job status for filtering. The status includes `QUEUE`, `RUNNING`, `FINISHED`, `FAILED`, `STOPPED`, and `SUCCEEDED`. For the status description, see [Job manager and the JOB statements](../../../3.ngql-guide/4.job-statements.md).
- Select a time range for filtering. You can view the job information of the maximum of 7 days by default. You can also select a time range or quickly select latest 12 hours, 1 day, 3 days, or 7 days.
- Select a `Job ID` or `Command` for filtering and enter what you want to search for.
- By default, the job information page will not be updated automatically. You can set the update frequency of the job information page globally or click the ![setup](https://docs-cdn.nebula-graph.com.cn/figures/refresh-220616.png) button to update the page manually.
- Click `Detail` in the `Operation` column on the right side of the target job to view more information, including `Task ID`, `Host`, `Error Code`, etc. You can also stop or recover the job, or search for a task id.
- Click `Detail` in the `Operation` column on the right side of the target job to view more information, including `Task ID`, `Host`, `Error Code`, etc.

## Stop job

Click `Stop Job` in the `Operation` column on the right side of the target job to stop the job whose status is `QUEUE`, `RUNNING` or `FAILED`. After clicking, the status of the job becomes `STOPPED`.
Click `Stop Job` in the `Operation` column on the right side of the target job to stop an unfinished job. After clicking, the status of the job becomes `STOPPED`.

## Recover job

Click `Recover Job` in the `Operation` column on the right side of the target job to recover the job whose status is `QUEUE`, `FAILED` or `STOPPED`. After clicking, the status of the job becomes `RUNNING`.
Click `Recover Job` in the `Operation` column on the right side of the target job to recover the job whose status is `FAILED` or `STOPPED`. After clicking, the status of the job becomes `RUNNING`.

!!! note

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Runtime log

Runtime logs are provided for DBAs and developers to locate faults when the system fails. Dashboard Enterprise Edition allows you to quickly view runtime logs.
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved

## Entry

1. At the top navigation bar of the Dashboard Enterprise Edition page, click **Cluster Management**.
2. On the right side of the target cluster, click **Detail**.
3. On the left-side navigation bar of the page, click **Information**->**Runtime Log**.

!!! note

For the description of runtime log parameters, see [Runtime log](../../..//5.configurations-and-logs/2.log-management/logs.md).

## View runtime log

In the upper corner of the page, you can filter services or search for the log name. Click **View Log** in the **Operation** column.

- Support copying all logs in the window with one click.
- Support copying the log file path.
- Support **Tail Mode** and **Range Mode** to view logs. You need to click **Refresh** after setting.
- Support searching logs by keywords (at least 3 characters).
4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,9 @@ nav:
- Information:
- Information overview: nebula-dashboard-ent/4.cluster-operator/cluster-information/overview-info.md
- Cluster diagnostics: nebula-dashboard-ent/4.cluster-operator/cluster-information/cluster-diagnosis.md
# - Job management: nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md
- Job management: nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md
- Audit log: nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md
- Runtime log: nebula-dashboard-ent/4.cluster-operator/cluster-information/runtime-log.md
- Operation:
- Node: nebula-dashboard-ent/4.cluster-operator/operator/node.md
- Scale: nebula-dashboard-ent/4.cluster-operator/operator/scale.md
Expand Down