elastic / elastic/cli

Telemetry collection and reporting

Open
#272 0 comments 1 reaction 1 assignee Assigned to @JoshMock View on GitHub
Dominant language
TypeScript
Stars
41
Forks
24
Avg merge
1d 3h
Merged PRs (30d)
56

Description

The CLI will automatically capture telemetry activity for all Elasticsearch APIs, in part because it uses [the JS transport](https://github.com/elastic/elastic-transport-js) for HTTP activity, but also because the DevEx team has been gathering Elasticsearch usage pattern telemetry from Elastic Cloud's proxy logs for several years. Critically, this **DOES NOT** include all non-Elasticsearch APIs supported by the CLI, including (but not limited to):

- Cloud hosted + serverless control plane APIs
- Kibana APIs
- `docs` commands

There are several moving parts required to capture, aggregate and report on this data:

- all HTTP requests to Cloud resources include machine-readable HTTP headers (technical details available via internal docs)
- Cloud proxy logs capture and record those headers in all regional logging clusters
- regional Cloud proxy aggregation jobs query and ship aggregated data to our telemetry API
- telemetry indexers are built to transform and index the stored data
- DevEx (or other stakeholders) build dashboards over the data

All required steps are outlined in sub-issues.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.