Skip to content

Workspace Management

Workspaces are designed for multiple users and can isolate data from different units.

Create Workspace

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

Space Information

  1. Enter the workspace name.
  2. Select the workspace language.
  3. Select the workspace owner: The owner has the highest operational permissions for the workspace.
  4. Optionally enter a description for the workspace.

Primary Storage Engine

Automatically lists the data storage engines.

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

Data Retention Policy

Refers to the data retention period for the current workspace.

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

Configuring Extended Retention Periods
  • When configuring extended data retention periods for OpenSearch or Elasticsearch clusters, it is necessary to estimate not only the storage space usage but also the number of index shards.
  • OpenSearch or Elasticsearch clusters have a default limit of 1000 shards per node. For example, for a 3-node cluster, the total number of shards should not exceed 3000.
  • Example shard count calculation: Assume a workspace's log index is configured with 2 replicas and 3 shards, each shard has a maximum of 30GB, and the daily data volume is about 180GB (i.e., 2 indexes), with a data retention of 200 days. The total shard count formula is: Number of index replicas × Number of daily indexes × Number of shards per index × Data retention days = 2 × 2 × 3 × 200 = 2400 shards.
  • If multiple workspaces exist, the index shard counts for each workspace must be accumulated, and the number of shards for other data type indexes must also be estimated.

Others

  1. Left Star Query: 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 custom mapping rules of a workspace take precedence over the mapping rules configured in the management console.

    Note

    If you configure overlapping rules in the management console and the workspace, the member's role will be the combination of roles assigned in the management console and the workspace.

  3. Custom Log Index: When enabled, allows the workspace to create multiple index policies for log storage.

  4. Large Log Counting Unit: Used to set the counting unit for large logs. Logs can be split into multiple entries for billing based on the set counting unit.
  5. Query Limit: Customizes the query limit for different users' workspaces to avoid low cluster query performance due to excessive data querying, which affects the product experience. Once the query limit is exceeded, additional queries are required to obtain results.

Manage Workspace

Filter

Quickly filter and locate workspaces using the Primary Storage Engine and Business filter options.

The workspace list page displays basic information for all workspaces. You can search by workspace name keywords.

Index Configuration

Adjusts the primary shards, shard size, and replica shards for all index templates in the current workspace.

Click the Configure button next to the data type to customize the "primary shards", "shard size", "hot data retention period", enable/disable "replicas", and access "advanced configuration" for that data type.

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

  • Standard Storage: Configure hot data.
  • Infrequent Access Storage: Can be configured if the standard storage duration is 7 days or more.
  • Archive Storage: Can be configured if the standard storage duration is 30 days or more.
Note
  • Enabling replicas will create a redundant copy of the index shards by default.
  • Enabling advanced configuration allows modifications to the index mapping template configuration, including parameters related to tokenization.

Data Reporting Limit

To meet the needs of different roles within the workspace, configure data reporting limits based on a daily basis to determine if a certain type of data has reached a threshold. Once the threshold is triggered, subsequent reported data will be discarded and not written to the database, thereby saving resource usage costs.

As shown, you can configure limits for Metrics, Network (number of hosts), number of log entries, number of APM Traces, number of APM Profiles, number of RUM PVs, and number of Synthetic Tests.

Note
  • 0 means all corresponding data is discarded and not written, with no upper limit.
  • Metrics and network data are limited by time series and network dimensions, respectively, so there is no quantity limit; only enabling data write limits or having no limits are the options.

View Members

Click to enter the corresponding workspace members page to view basic information of all members in that workspace.

You can perform operations such as search, modify roles, and delete.

Note

A workspace can only have one owner. If you modify another member to be the owner, the original owner will be downgraded to an administrator.

Add User

  1. Click to enter the add page.
  2. Select a member.
  3. Set role permissions.
  4. Click OK.

Note

Members added here must already exist in the system. For new system members, they must first be added successfully on the Users > Add User page before returning here to perform operations.

Modify/Delete Members

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

Tenant Configuration Management

Note

Applies only to workspaces using the ScopeDB engine.

  1. Workgroup: The actual work group executing queries. Once configured, all queries for this workspace will be executed by the specified work group and will not enter the cluster's default work group.
  2. Query Concurrency: Default is 50. The number of concurrent queries within the workspace. Queries exceeding this limit will queue and wait.
  3. Max Slice Time: The maximum time range set for a single query. The search stops immediately once sufficient data is retrieved within this range.

  4. Sampling Threshold: Customizable. When the volume of data scanned by a query reaches the preset configuration, sampled querying is automatically enabled and data is returned.

    • Default values: Dashboard queries (200 million), Explorer queries (100 million), Facet (5 million), Reports (500 million), other queries (200 million).

  5. Async Execution Timeout: Default is 2 minutes. Query timeout duration.

  6. Disable Streaming Aggregation: Disabled by default.

Delete Workspace

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

The system will not immediately clean up the data and configurations, retaining them for a seven-day buffer to avoid unnecessary trouble caused by accidental deletion.

Feedback

Is this page helpful? ×