Vega Telemetry Runtime Metrics

Vega Telemetry Runtime Metrics is collecting more runtime metrics to track various pain points, including component usage, overriding feature flag and public APIs.

Usage

Component Usage

When is it captured?

• Telemetry is captured when a Vega component is rendered on a page.

What is captured?

The following fields are captured by default:

• Browser and OS type and version
• Framework used to build the web app
• The name of the component that is being rendered
• Boolean indicating whether the deprecated properties of the component is be used
• Boolean indicating whether the specific functionality of the component is enabled or not

Opting out

Turn off the following feature flag:

FeatureFlag.disable("VEGA_TELEMETRY.ENABLE_COLLECT_COMPONENTS_USAGE");

Overriding Feature Flags

When is it captured?

• Telemetry is captured when a client overrides a feature flag provided by Vega.

What is captured?

The feature flag name is captured by default.

In addition to the feature flag name, the following fields are captured by default:

• Browser and OS type and version.
• Framework used to build the web app.
• Name string of the feature flag enabled by clients that is impacting the UI/UX during runtime.

Opting out

Turn off the following feature flag:

FeatureFlag.disable("VEGA_TELEMETRY.ENABLE_COLLECT_FEATURE_FLAG_OVERRIDDEN");;

Public API

Event Manager

When is it captured?

Telemetry is captured in the following situations:

• A client changes the event namespace without the vega prefix.
• A client gets the event semantics of an HTML element.
• A client gets the all eventIds in the component.

What is captured?

The following fields are captured by default:

• Browser and OS type and version.
• Framework used to build the web app.
• Boolean indicating whether the client changes the event namespace without the vega prefix.
• Boolean indicating whether the client gets the event semantics of an HTML element.
• Boolean indicating whether the client gets the all eventIds in the component.

Theme Manager

When is it captured?

Telemetry is captured in the following situations:

• A client switches to light or dark mode and determines whether it is dark mode.
• A client overrides the default Vega theme and uses their own brand colors instead.
• A client removes all the custom override theme styles.

What is captured?

The following fields are captured by default:

• Browser and OS type and version.
• Framework used to build the web app.
• Boolean indicating whether the client switches to light or dark mode.
• Boolean indicating whether it is dark mode.
• Boolean indicating whether the client overrides the default Vega theme.
• Boolean indicating whether the client removes all the custom override theme styles.

Icon Manager

When is it captured?

Telemetry is captured in the following situations:

• A client registers a custom icon, making it available for use within Vega components.
• A client gets the custom icons.
• A client validates whether there is the custom icon.

What is captured?

The following fields are captured by default:

• Browser and OS type and version.
• Framework used to build the web app.
• Boolean indicating whether the client registers a custom icon.
• Boolean indicating whether the client gets the registered icon.
• Boolean indicating whether the icon has been successfully registered.

Vega Dialog Controller

When is it captured?

Telemetry is captured when a client creates a dialog by VegaDialog API

What is captured?

The following fields are captured by default:

• Browser and OS type and version.
• Framework used to build the web app.
• Boolean indicating whether the client has created a Vega dialog.

Vega Notify Controller

When is it captured?

Telemetry is captured in the following situations:

• A client shows a notification by VegaNotify API.
• A client closes a notification by passing a reference to its id.
• A client closes all open notifications.

What is captured?

The following fields are captured by default:

• Browser and OS type and version.
• Framework used to build the web app.
• Boolean indicating whether the client has showed a notification.
• Boolean indicating whether the client has closed a notification.
• Boolean indicating whether the client has closed all open notifications.

Vega Loader Controller

When is it captured?

Telemetry is captured in the following situations:

• A client shows a page loading indicators by VegaLoader API.
• A client hides a loading indicators by passing a reference to its id.

What is captured?

The following fields are captured by default:

• Browser and OS type and version.
• Framework used to build the web app.
• Boolean indicating whether the client has showed a loading indicators.
• Boolean indicating whether the client has hided a loading indicators.

Vega Skeleton Loader

When is it captured?

Telemetry is captured in the following situations:

• A client shows a skeleton loader in target element by SkeletonLoader API.
• A client removes a specific skeleton loader with the loader's key.
• A client removes all skeleton loaders on a page.

What is captured?

The following fields are captured by default:

• Browser and OS type and version.
• Framework used to build the web app.
• Boolean indicating whether the client has showed a skeleton loader.
• Boolean indicating whether the client has removed a specific skeleton loader.
• Boolean indicating whether the client has removed all skeleton loaders on a page.

Vega ZIndex Manager

When is it captured?

Telemetry is captured when a client customize the z-index values.

What is captured?

The following fields are captured by default:

• Browser and OS type and version.
• Framework used to build the web app.
• Boolean indicating whether the client has customized the z-index values.

waitForVega

When is it captured?

Telemetry is captured when a client calls the waitForVega utility method helps ensure that all Vega components on a page have completed their initial render cycle.

What is captured?

The following fields are captured by default:

• Browser and OS type and version.
• Framework used to build the web app.
• Boolean indicating whether the client has called the waitForVega utility method.

Opting out

Turn off the following feature flag:

FeatureFlag.disable("VEGA_TELEMETRY.ENABLE_COLLECT_PUBLIC_API");

Privacy Policy

We do not collect any sensitive data, such as environment variables, file paths, contents of files, logs, or serialized JavaScript errors.

• All data collected using telemetry is completely anonymous.
• We do not collect any user cookies/local storage/session storage in the browser.
• We do not collect any user inputs during the interaction with the Vega component.
• We do not collect any data displayed through the rendered Vega components.
• We do not collect any footprint of the user's interaction with the Vega components.
• Data collected is untraceable back to your source code.