Skip to content

Workspace Management

Workspaces are designed for multi-user use and can isolate data from different units.

Create Workspace

In the workspace list, click Create Workspace in the top-right corner.

Workspace Information

  1. Enter the workspace name;

  2. Select the workspace language;

  3. Select the workspace owner: The owner has the highest operation permissions for the workspace;

  4. Optionally enter a description for the workspace.

Main Storage Engine

Automatically lists data storage engines.

If you do not select a data storage engine, the data will be saved to the system's main storage engine.

Data Retention Policy

This is the data retention duration for the current workspace.

In addition to the storage durations corresponding to each data type, you can also choose to set a custom retention period (<= 1800 days).

Configure ultra-long storage duration
  • When configuring ultra-long data retention periods for OpenSearch or Elasticsearch clusters, it’s important to estimate both storage space usage and index shard counts;
  • OpenSearch or Elasticsearch clusters have a default limit of up to 1000 shards per node. For example, for a 3-node cluster, the total number of shards should not exceed 3000;
  • Shard count calculation example: Assume that the log index configuration for a certain workspace is 2 replicas, 3 shards, with each shard having a maximum size of 30GB, and daily data volume is approximately 180GB (i.e., 2 indices), with data retention for 200 days. The total shard count calculation formula is: Index replica count × Daily index count × Shards per index × Data retention days = 2 × 2 × 3 × 200 = 2400 shards;
  • If there are multiple workspaces, you need to sum up the index shard counts for all workspaces and simultaneously estimate the shard counts for other data types.

Others

  1. Left-star query: This determines whether the newly created workspace supports left-star queries;

  2. Custom mapping rules: Enabling this configuration allows the corresponding workspace to define custom mapping rules. The priority of the workspace's custom mapping rules is higher than those defined in the management backend.

    Note

    If you configure overlapping mappings between the management backend and within the workspace, the member role will be a combination of roles assigned by both the management backend and the workspace.

  3. Custom log indices: After enabling this, the workspace is allowed to create multiple index policies for storing logs;

  4. Large log counting unit: Used to set the counting unit for super-large logs, which can split them into multiple logs for billing based on the set counting unit;

  5. Query quantity limit: Customize the query quantity limits for different users' workspaces to avoid performance degradation due to excessive query data volumes, thereby improving product usability. After setting the query limit, any excess queries must be re-executed to obtain results.

Manage Workspaces

Filtering

Quickly filter and locate workspaces through two filtering options: Main Storage Engine and Business.

On the workspace list page, you can view basic information about all workspaces. You can search by workspace name keywords.

Index Configuration

Adjust the primary shards, shard size, and replica shards for all index templates within the current workspace.

Click the Configure button next to the data type to customize configurations for "Primary Shards", "Shard Size", "Hot Data Retention Duration", enable/disable "Replicas", and access "Advanced Configuration".

Among these, under the Volcengine base, the storage strategies for traces, logs, and custom log indices include:

  • Standard Storage: Configure hot data;
  • Infrequent Access Storage: Configurable if standard storage duration is 7 days or more;
  • Archive Storage: Configurable if standard storage duration is 30 days or more.
Note

  • Enabling replicas will automatically create a redundant copy of the index shards;

  • After enabling advanced configuration, you can modify the index mapping template settings, including changes to tokenization-related parameters.

Data Reporting Limit

To meet the needs of users with the same role within a workspace, data reporting limits can be configured. Based on a "day" dimension, it determines whether a certain type of data has exceeded the threshold. Once the threshold is triggered, subsequent data reports will not be written to the database and will be discarded, thus saving resource usage costs.

As shown in the figure, you can configure limits for Metrics, NETWORK (host counts), log entries, APM Trace counts, APM Profile entries, RUM PV counts, and Synthetic Testing frequencies.

Note

  • 0 indicates that all corresponding data will be discarded without being written, meaning no upper limit;

  • Metrics and NETWORK data have no numerical limits because their statistical dimensions are Time Series and NETWORK, so only two modes exist: enabling data write restrictions or unlimited.

View Members

Click to enter the corresponding workspace members page, where you can view all basic information about members in the workspace.

You can perform operations such as searching, modifying roles, and deleting.

Note

A workspace can only have one owner. Changing another member to the owner demotes the original owner to an administrator.

Add Users

  1. Click to enter the add page;
  2. Select members;
  3. Set role permissions;
  4. Click confirm.

Note

Here, you can add existing system members. If adding a new system member, you need to first successfully add them on the User > Add User page before returning here to proceed.

Modify/Delete Members

Click to modify the workspace configuration or directly delete the workspace.

Delete Workspace

After clicking to delete a workspace, users will no longer be able to log in to that workspace, and data will no longer be reported.

The system will not immediately clean up data and configurations but will retain them for seven days as a buffer to prevent unnecessary trouble caused by accidental deletions.

Feedback

Is this page helpful? ×