Build a custom telemetry plugin
Build a custom telemetry plugin that collects workspace activity events and sends them to your organization’s analytics backend.
- How telemetry plugins work
A telemetry plugin for OpenShift Dev Spaces collects workspace usage data and sends it to your analytics backend. The plugin extends theAbstractAnalyticsManagerclass with methods for event handling, activity tracking, and shutdown. - Create a telemetry server
Create a server that receives telemetry events from the OpenShift Dev Spaces telemetry plugin and writes them to standard output. For production, consider integrating with a third-party telemetry system such as Segment or Woopra. - Create a telemetry backend
Create a Quarkus-based telemetry backend that extends the OpenShift Dev Spaces telemetry client and implements custom event handling logic. - Implement and test telemetry backend event handlers
Implement theAnalyticsManagerevent handling methods in your telemetry backend and test the backend in a running Dev Workspace to verify that events are received from the front-end plugin. - Deploy a telemetry plugin
Deploy the telemetry backend as a container image, create a devfile v2 plugin, and host the plugin on a web server so that Dev Workspaces can load it. - Configure workspaces to load a telemetry plugin
Configure Dev Workspaces to load the telemetry plugin so that workspace activity events are sent to your telemetry backend for collection and analysis.
Related information