Snapshots¶

Guance snapshots support creating custom time-range copies of data for scenario dashboards, infrastructure, metrics, logs, events, APM, RUM, cloud dial testing, security checks, CI visualization, and other Explorers. They also generate shortcut links with specified viewing permissions.

• If there is a need to record data from specific moments when a business system encounters issues or anomalies, the Save Snapshot feature can effectively help IT engineers quickly document accurate observation data, aiding in rapid problem identification.
• When different teams within an enterprise or external partners need to share certain observation data while ensuring data permission isolation, the Share Snapshot feature can significantly improve collaboration efficiency among members with different responsibilities, helping the enterprise solve problems quickly.

Save Snapshots¶

Snapshot Permissions¶

• For pages that support saving snapshots, only the Owner and Administrator of the current workspace have the permissions to save snapshots, share snapshots, and manage snapshot sharing among the four default roles.
• In addition to default roles, you can grant relevant snapshot permissions through custom roles and assign these roles to required members.

Saving Methods¶

Enter the page where you want to save a snapshot, adjust the time widget in the top-right corner, and filter out the data you wish to save. Use the following methods to bring up the Save Snapshot window.

Snapshot Settings¶

After successfully bringing up the Save Snapshot window, you can configure the settings for this snapshot.

1. Enter the snapshot name;
2. Visibility scope: including Public and Private.
   • Public: All users in the current workspace can view this snapshot;
   • Private: Only the user who saved the snapshot can view it.
3. Automatically retrieves the selected time range from the current page; you can adjust the time range here.

View Snapshots¶

Viewing Methods¶

You can view saved snapshots via the following entry points:

In the Snapshot Menu¶

• Workspace > Shortcut > Snapshot menu, view all snapshots saved in the current workspace.

• Each page can display up to 20 snapshots; navigate to the next page to see more.

In the Explorer Page¶

Enter Explorer > Snapshots, which displays snapshots saved by the current Explorer. For example, snapshots saved in the Log Explorer cannot be viewed in the APM > Trace Explorer;

• Hover over historical snapshots to display the corresponding time range and filters in a floating window. The time range can be "Absolute Time," "Relative Time," or "Default" based on the selection at the time of snapshot creation.

• If you have clicked into a specific historical snapshot, clicking Snapshot again and then Return to Explorer will take you back to the default Explorer before entering the historical snapshot.

In the Dashboard Page¶

Enter Scenarios > Dashboard, and in the upper right-hand corner under Historical Snapshots, view all dashboard snapshots saved in the current workspace.

Snapshot List Operations¶

• In the 🔍 bar, you can input the snapshot name to search for related snapshots by keyword;
• On the right side of each snapshot, you can choose to share/delete the snapshot or copy the snapshot link;
• Clicking the Snapshot Name opens the corresponding data copy and restores the data tags as they were when the snapshot was saved;
• If the visibility scope was set to Private during snapshot creation, a icon will appear after the snapshot name, indicating that others cannot view it.

Share Snapshots¶

In the snapshot list on the right, click , to share the current specific snapshot.

Basic Configuration¶

Time Range¶

After saving the snapshot, it retains the time range selected at the time of saving. You can choose whether the recipient can change the time range on the snapshot page.

Validity Period¶

Options include 1 day, 3 days, 7 days, and permanent validity; the default is 1 day.

Note: If you select "Permanent Validity," it may pose data security risks, so please consider carefully.

Sharing Method¶

Guance supports two snapshot sharing methods: public sharing and encrypted sharing. Shared snapshots automatically generate corresponding links. You can share the snapshot link with "anyone" or encrypt it for those with the key.

Public Sharing

Users with the share link can view the Guance workspace data displayed by this snapshot.

Note: In the Log Explorer, users with snapshot viewing permissions can view the filtering conditions in the search bar above the snapshot page and add additional search criteria.

Encrypted Sharing

Set a password conforming to 4-8 digits and English letters. Users with both the share link and the corresponding password can view the Guance workspace data displayed by this snapshot.

Additional Options¶

Display Top Bar

• Enabling the top bar shows platform introduction text at the top.

• Disabling the top bar hides the platform introduction text.

Display Watermark

Snapshots can display a watermark with the sharer's name in the format "Shared by: Name".

Data Masking¶

You can configure masking rules for field values within the snapshot. Input the masking fields and regular expressions, click preview, and matched content will be displayed as *.

• Masking fields: multiple selections supported;
• Regular expressions: use regex syntax for masking; refer to Data Access for more operations.

IP Restrictions¶

Enable IP whitelist: This adds an extra layer of protection to snapshot sharing.

When enabling the IP whitelist, you can choose to use the current workspace's IP whitelist or customize the input:

• Workspace IP Whitelist: Uses the current workspace's IP whitelist, which changes according to the workspace's IP whitelist configuration and cannot be edited in the snapshot sharing settings;
• Custom Input: You can input custom IP access whitelists. IPs not listed will not be able to view the shared snapshot.

For more details, refer to How to Configure IP Whitelist.

Preview Snapshot¶

After completing all configurations for sharing the snapshot, you can choose to preview the snapshot effect:

The masking effect in the snapshot is shown below:

Note: This preview mirrors the actual sharing process. For example, if you set IP whitelist restrictions in the configuration steps, IPs outside the whitelist will also be unable to view the preview snapshot.

Manage Shared Snapshots¶

Members with permissions to save, analyze, and manage snapshots can enter the Manage Shared Snapshots page via the following two methods to view snapshots, check share links, cancel shares, etc.

Refer to Share Management for more details.