kibana/x-pack/plugins/infra/docs/telemetry
Marco Antonio Ghiani ea26816ac9
[Infrastructure UI] Add TelemetryService documentation (#151641)
## 📓 Summary

Closes #150977 

This documentation helps to better understand how we can define and
trigger custom events in the infra plugin using a centralized service
that is injected into the Kibana context for the easiest consumption.

It includes documentation for:
- Quick overview of the `TelemetryService`
- How to define custom events with TelemetryService
- Examples of using custom events in the plugin

It also includes some minor changes to the definition of the
TelemetryService types.

---------

Co-authored-by: Marco Antonio Ghiani <marcoantonio.ghiani@elastic.co>
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2023-02-23 11:09:25 +01:00
..
define_custom_events.md [Infrastructure UI] Add TelemetryService documentation (#151641) 2023-02-23 11:09:25 +01:00
README.md [Infrastructure UI] Add TelemetryService documentation (#151641) 2023-02-23 11:09:25 +01:00
telemetry_service_overview.md [Infrastructure UI] Add TelemetryService documentation (#151641) 2023-02-23 11:09:25 +01:00
trigger_custom_events_examples.md [Infrastructure UI] Add TelemetryService documentation (#151641) 2023-02-23 11:09:25 +01:00

Telemetry Implementation Guide | infra plugin

Welcome to the documentation on implementing custom Telemetry events using the TelemetryService. Tracking Telemetry events is part of our workflow for better understanding what users like the most and constantly improving the Observability Metrics and Logs.

Custom events provide a flexible way to track specific user behaviors and application events. By using the TelemetryService, you can easily create and track custom events, allowing you to gain valuable insights into how your application is being used.

In this documentation, we will see how to implement custom events and how to trigger them while working with React.