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

update studio troubleshoot #657

Merged
merged 3 commits into from
Sep 1, 2021
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Connecting to the database error

## Problem description

According to the [connect Studio](../deploy-connect/st-ug-connect.md) operation, it prompts **failed**.

## Possible causes and solutions

You can troubleshoot the problem by following the steps below.

### Step1: Confirm that the format of the **Host** field is correct

You must fill in the IP address (`graph_server_ip`) and port of the Nebula Graph database Graph service. If no changes are made, the port defaults to `9669`. Even if Nebula Graph and Studio are deployed on the current machine, you must use the local IP address instead of `127.0.0.1`, `localhost` or `0.0.0.0`.

### Step2: Confirm that the **username** and **password** are correct

If authentication is not enabled, you can use root and any password as the username and its password.

If authentication is enabled and different users are created and assigned roles, users in different roles log in with their accounts and passwords.

### Step3: Confirm that Nebula Graph service is normal

Check Nebula Graph service status. Regarding the operation of viewing services:

- If you compile and deploy Nebula Graph on a Linux server, refer to the [Nebula Graph service](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md).

- If you use Nebula Graph deployed by Docker Compose and RPM, refer to the [Nebula Graph service status and ports](../deploy-connect/st-ug-deploy.md).

If the Nebula Graph service is normal, proceed to Step4 to continue troubleshooting. Otherwise, please restart Nebula Graph service.

!!! Note

If you used `docker-compose up -d` to satrt Nebula Graph before, you must run the `docker-compose down` to stop Nebula Graph.

### Step4: Confirm the network connection of the Graph service is normal

Run a command (for example, telnet <graph_server_ip> 9669) on the Studio machine to confirm whether Nebula Graph's Graph service network connection is normal.

If the connection fails, check according to the following steps:

- If Studio and Nebula Graph are on the same machine, check if the port is exposed.

- If Studio and Nebula Graph are not on the same machine, check the network configuration of the Nebula Graph server, such as firewall, gateway, and port.

If you cannot connect to the Nebula Graph service after troubleshooting with the above steps, please go to the [Nebula Graph forum](https://discuss.nebula-graph.io) for consultation.
54 changes: 54 additions & 0 deletions docs-2.0/nebula-studio/troubleshooting/st-ug-connection-errors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Cannot access to Studio

## Problem description

I follow the document description and visit `127.0.0.1:7001` or `0.0.0.0:7001` after starting Studio, why can’t I open the page?

## Possible causes and solutions

You can troubleshoot the problem by following the steps below.

### Step1: Confirm system architecture

It is necessary to confirm whether the machine where the Studio service is deployed is of x86_64 architecture. Currently, Studio only supports x86_64 architecture.

### Step2: Check if the Studio service starts normally

Run `docker-compose ps` to check if the service has started normally.

If the service is normal, the return result is as follows. Among them, the `State` column should all be displayed as `Up`.

```bash
Name Command State Ports
------------------------------------------------------------------------------------------------------
nebula-web-docker_client_1 ./nebula-go-api Up 0.0.0.0:32782->8080/tcp
nebula-web-docker_importer_1 nebula-importer --port=569 ... Up 0.0.0.0:32783->5699/tcp
nebula-web-docker_nginx_1 /docker-entrypoint.sh ngin ... Up 0.0.0.0:7001->7001/tcp, 80/tcp
nebula-web-docker_web_1 docker-entrypoint.sh npm r ... Up 0.0.0.0:32784->7001/tcp
```

If the above result is not returned, stop Studio and restart it first. For details, refer to [Deploy Studio](../deploy-connect/st-ug-deploy.md).

!!! note

If you used `docker-compose up -d` to satrt Nebula Graph before, you must run the `docker-compose down` to stop Nebula Graph.

### Step3: Confirm address

If Studio and the browser are on the same machine, users can use `localhost:7001`, `127.0.0.1:7001` or `0.0.0.0:7001` in the browser to access Studio.

If Studio and the browser are not on the same machine, you must enter `<studio_server_ip>:7001` in the browser. Among them, `studio_server_ip` refers to the IP address of the machine where the Studio service is deployed.

### Step4: Confirm network connection

Run `curl <studio_server_ip>:7001` -I to confirm if it is normal. If it returns `HTTP/1.1 200 OK`, it means that the network is connected normally.

If the connection is refused, check according to the following steps:

If the connection fails, check according to the following steps:

- If Studio and Nebula Graph are on the same machine, check if the port is exposed.

- If Studio and Nebula Graph are not on the same machine, check the network configuration of the Nebula Graph server, such as firewall, gateway, and port.

If you cannot connect to the Nebula Graph service after troubleshooting with the above steps, please go to the [Nebula Graph forum](https://discuss.nebula-graph.io) for consultation.
9 changes: 9 additions & 0 deletions docs-2.0/nebula-studio/troubleshooting/st-ug-faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# FAQ

???+ faq "Why can't I use a function?"

If you find that a function cannot be used, it is recommended to troubleshoot the problem according to the following steps:
1. Confirm that Nebula Graph is the latest version. If you use Docker Compose to deploy the Nebula Graph database, it is recommended to run `docker-compose pull && docker-compose up -d` to pull the latest Docker image and start the container.
2. Confirm that Studio is the latest version. For more information, refer to [check updates](../about-studio/st-ug-check-updates.md).
3. Search the [nebula forum](https://discuss.nebula-graph.io/), [nebula](https://github.com/vesoft-inc/nebula) and [nebula-studio](https://github.com/vesoft-inc/nebula-studio) projects on the GitHub to confirm if there are already similar problems.
4. If none of the above steps solve the problem, you can submit a problem on the forum.
64 changes: 32 additions & 32 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -269,38 +269,38 @@ nav:
- Service Tuning:
- Compaction: 8.service-tuning/compaction.md
- Storage load balance: 8.service-tuning/load-balance.md
# - Nebula Graph Studio:
# - Release Note: nebula-studio/about-studio/st-ug-release-note.md
# - About Nebula Graph Studio:
# - What is Studio: nebula-studio/about-studio/st-ug-what-is-graph-studio.md
# - Usage restriction:
# - Limitation: nebula-studio/about-studio/st-ug-limitations.md
# - Check updates: nebula-studio/about-studio/st-ug-check-updates.md
# - Shortcuts: nebula-studio/about-studio/st-ug-shortcuts.md
# - Deploy and connect:
# - Deploy Studio: nebula-studio/install-configure/st-ug-deploy.md
# - Connect to Studio: nebula-studio/install-configure/st-ug-connect.md
# - Reset connection: nebula-studio/install-configure/st-ug-reset-connection.md
# - Quick start:
# - Design a schema: nebula-studio/quick-start/st-ug-plan-schema.md
# - Create a schema: nebula-studio/quick-start/st-ug-create-schema.md
# - Import data: nebula-studio/quick-start/st-ug-import-data.md
# - Query graph data: nebula-studio/quick-start/st-ug-explore.md
# - Operation guide:
# - Use Schema:
# - Operate graph spaces: nebula-studio/manage-schema/st-ug-crud-space.md
# - Operate tags: nebula-studio/manage-schema/st-ug-crud-tag.md
# - Operate edge types: nebula-studio/manage-schema/st-ug-crud-edge-type.md
# - Operate indexes: nebula-studio/manage-schema/st-ug-crud-index.md
# - Use Console:
# - Console:
# - Open in Explore: nebula-studio/use-console/st-ug-open-in-explore.md
# - View subgraph: nebula-studio/use-console/st-ug-visualize-subgraph.md
# - Troubleshooting:
# - Config server errors:
# - Connection errors:
# - FAQ:

- Nebula Graph Studio:
- Change Log: nebula-studio/about-studio/st-ug-release-note.md
- About Nebula Graph Studio:
- What is Nebula Graph Studio: nebula-studio/about-studio/st-ug-what-is-graph-studio.md
- Explanations of terms: nebula-studio/about-studio/st-ug-terms.md
- Limitations: nebula-studio/about-studio/st-ug-limitations.md
- Check updates: nebula-studio/about-studio/st-ug-check-updates.md
- Shortcuts: nebula-studio/about-studio/st-ug-shortcuts.md
- Deploy and connect:
- Deploy Studio: nebula-studio/deploy-connect/st-ug-deploy.md
- Connect to Nebula Graph: nebula-studio/deploy-connect/st-ug-connect.md
- Clear connection: nebula-studio/deploy-connect/st-ug-reset-connection.md
- Quick start:
- Design a schema: nebula-studio/quick-start/st-ug-plan-schema.md
- Create a schema: nebula-studio/quick-start/st-ug-create-schema.md
- Import data: nebula-studio/quick-start/st-ug-import-data.md
- Query graph data: nebula-studio/quick-start/st-ug-explore.md
- Operation guide:
- Use Schema:
- Operate graph spaces: nebula-studio/manage-schema/st-ug-crud-space.md
- Operate Tags: nebula-studio/manage-schema/st-ug-crud-tag.md
- Operate Edge types: nebula-studio/manage-schema/st-ug-crud-edge-type.md
- Operate Indexes: nebula-studio/manage-schema/st-ug-crud-index.md
- Use Console:
- Console: nebula-studio/use-console/st-ug-console.md
- Open in Explore: nebula-studio/use-console/st-ug-open-in-explorer.md
- View subgraphs: nebula-studio/use-console/st-ug-visualize-findpath.md
- Troubleshooting:
- Connecting to the database error: nebula-studio/troubleshooting/st-ug-config-server-errors.md
- Cannot access to Studio: nebula-studio/troubleshooting/st-ug-connection-errors.md
- FAQ: nebula-studio/troubleshooting/st-ug-faq.md

- Nebula Graph Dashboard:
- What is Nebula Graph Dashboard: nebula-dashboard/1.what-is-dashboard.md
Expand Down