Microservices Engine (MSE) lets you manage services registered with your Nacos instance through the console. You can create and delete services, add application instances (providers), bring instances online or offline, and monitor subscribers and push tracking.
Prerequisites
Before you begin, make sure that you have:
Created a Nacos engine running version 2.0.3.0 or later. If your engine runs an earlier version, upgrade it first
Navigate to the services page
All service management operations start from the same page. Complete these steps first, then follow the task-specific instructions in each section.
Log on to the MSE console and select a region in the top navigation bar.
In the left-side navigation pane, choose Microservices Registry > Instances.
On the Instances page, click the name of the instance.
In the left-side navigation pane, choose Service Management > Services. Select a namespace from the Namespace drop-down list.
Create a service
Create an empty service to define or test a service before providers register with it. Empty services have no providers. To display empty services in the service list, turn on Show Empty Service.
After you navigate to the services page:
Click Create service.
In the Create service panel, configure the following parameters, then click OK.
Parameters for Nacos 2.1.2.1 or later
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| Service Name | Yes | String | -- | The name of the service. |
| Group Name | Yes | String | -- | The group to which the service belongs. |
| Instance Source | Yes | Enum | -- | The instance source. Valid values: Console, SDK. |
| Protection Threshold | Yes | Float | -- | The minimum ratio of healthy instances to prevent a system breakdown. Valid values: 0 to 1. See Protection threshold guidelines. |
Parameters for Nacos 2.0.3.0 to 2.1.2.0
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| Service Name | Yes | String | -- | The name of the service. |
| Group Name | Yes | String | -- | The group to which the service belongs. |
| Persistence | Yes | Boolean | -- | Whether the service and its instances are persisted. |
| Protection Threshold | Yes | Float | 0 | The ratio of healthy instances below which the protection mechanism activates. Valid values: 0 to 1. For more information, see Implement high availability capabilities of MSE Microservices Registry. |
Protection threshold guidelines
Set the protection threshold to the proportion of the minimum number of nodes that can process the maximum traffic. For example, if 10 instance nodes are available and a minimum of 6 nodes can process the maximum traffic, set this value to 0.6.
Delete a service
Only persistent services with no providers can be deleted. If a service still has providers (the Number of providers is not 0), the Delete button is dimmed.
Persistent services are not temporary services. If a service remains empty for more than 1 minute, the Nacos instance automatically deletes the service.
After you navigate to the services page:
Find the target service, click More in the Actions column, and select Delete.
In the confirmation dialog box, click OK.
View service details
The service list displays the following columns for each service:
| Column | Description |
|---|---|
| Service Name | The name of the service. |
| Group Name | The group to which the service belongs. |
| Number of providers | The number of application instances providing the service. |
| Number of Clusters | The number of logical clusters. |
After you navigate to the services page, click a service name to open its details page. The upper section shows the service name, service group, persistence status, and number of clusters.
Provider tab
Lists all application instances that provide this service, organized by logical cluster. By default, the first logical cluster is shown.
In the All Clusters section on the left, click a cluster name to view instances in that cluster.
In the Actions column for each instance, edit the weight, start or shut down the instance, delete the instance, or view its metadata.
Subscriber tab
Lists all clients that subscribe to the service, including their IP addresses and client versions.
Push track tab
Shows push tracking details for the service:
| Field | Description |
|---|---|
| Push Time | The time the push occurred. |
| Push Client IP Address | The IP address of the client that received the push. |
| Push service name | The name of the pushed service. |
| Push Service Group | The service group of the pushed service. |
| Number of Instances | The number of instances included in the push. |
| Node name | The name of the node that initiated the push. |
Add application instances
Add application instances (providers) for a service through the MSE console to define or test instances before they go live.
After you navigate to the services page:
Click the service name to open its details page.
Click the Provider tab, then click Create an instance.
In the Create an instance dialog box, configure the following parameters, then click OK.
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| IP | Yes | String | -- | The IP address of the application instance. |
| Port Number | Yes | Integer | -- | The port number of the application instance. |
| Cluster Name | No | String | DEFAULT | The logical cluster to which this instance belongs on the Nacos instance. |
| Up and down line status | No | Boolean | Yes (online) | The initial online/offline status of the instance. |
| Weight | No | -- | 1 | The traffic weight of the instance. Valid values: 0 to 10,000. A higher weight routes more traffic to the instance. If a weight change does not take effect, see What do I do if the modified weight of an application instance does not take effect on an MSE Nacos instance? |
Start or shut down an application instance
Bring application instances registered with your Nacos instance online or take them offline.
After you navigate to the services page:
Click the service name to open its details page.
Click the Provider tab. Find the target instance, then click On line or Offline in the Actions column.
In the confirmation dialog box, click OK.