Open afharo opened 2 years ago
Pinging @elastic/uptime (Team:uptime)
@afharo with https://github.com/elastic/kibana/pull/137828 fixing https://github.com/elastic/kibana/issues/137845 for Uptime and Synthetics, is this still needed?
@paulb-elastic AFAIK, the agreement was to use the custom telemetry sender temporarily until Core provided a common API to ship event-based telemetry (which is available from 8.3).
The current implementation has some fundamental known bugs that are spread through all the implementations that were copied across (from Security Solutions to Uptime, osquery (#137963) and fleet (#137964)) while waiting for the general API.
@afharo we're not intending to do any updates to Uptime. What impact would this have if we were to leave Uptime as it is?
Hi folks!
I'm creating this issue to track the effort for migrating the current custom telemetry sender in
x-pack/plugins/synthetics/server/legacy_uptime/lib/telemetry/sender.ts
to the new Core APIs to send telemetry events:core.analytics
.The full documentation can be found in: https://docs.elastic.dev/telemetry/collection/event-based-telemetry
Essentially, during the
setup
phase of your plugin, you need to register the event and the structure that you're planning to send via:Then, anytime you need to ship any events, you can call
core.analytics.reportEvent('my_uptime_event_name', {...contentOfTheEvent});
. The APIreportEvent
is available in thesetup
andstart
contracts.Some relevant documentation about the APIs can be found in the client's package readme: https://github.com/elastic/kibana/blob/main/packages/analytics/client/README.md#reporting-events:
Added benefits
license
,cloud deployment ID
,cluster_uuid
,version
,server's status
, and many more, so you don't need to provide it in your own events.Changes to your current implementation
Looking at your implementation, you would call
events.forEach((event) => core.analytics.reportEvent(channel, event))
inside yourqueueTelemetryEvents
method, and you can delete all the rest 😇Remember that, during the setup phase, you'll need to declare all the events you report
MonitorUpdateTelemetryChannelEvents
.Testing
There are some Jest mocks you can use for unit tests. They are exported alongside the core mocks.
But we also offer some FTR helpers to make developing FTR tests much easier. You can find them in
test/analytics
in the Kibana repo.Indexer considerations
⚠️ You may need to create a new indexer for this new implementation considering these 2 changes:
The structure of the events with the new API looks like this:
The target channels that the core API sends this data to are
kibana-server
andkibana-browser
, depending on where the event was generated (on the server or the browser, respectively).Relates to https://github.com/elastic/kibana/issues/137845