Include the calling plugin ID in a request header on all Elasticsearch API calls

[joshdover]

In order to assist with filtering Elasticsearch's usage telemetry, it's been requested that Kibana includes the ID of the plugin that initiated an API call in all requests sent to Elasticsearch. This will allow ES to record usage telemetry in a way that allows ES to determine the source of an API call (eg. APM vs Visualize).

The header name is TBD, but some potential options:

• x-origin-application
• x-origin-plugin

Ideally, this is implemented in Core and automatically configured in the ES client instances passed to plugins.

[elasticmachine]

Pinging @elastic/kibana-platform (Team:Platform)

[elasticmachine]

Pinging @elastic/kibana-telemetry (Team:KibanaTelemetry)

[joshdover]

@polyfractal Do you have an input on the header name here? This is something we should be able to easily add whenever Elasticsearch is ready for it.

[polyfractal]

Thanks for opening this @joshdover! Lemme touch base with a few other ES folks to make sure we're all on the same page regarding this change, since it will affect a few different teams. Will be back when I have more info :)

[polyfractal]

Sorry I thought I had posted this comment but apparently never hit the button 🤦

Had a few conversations and the ES side is 👍 with moving forward with this. We're not quite sure when we'll get the implementation done on our side, but getting the headers in whenever Kibana has time would be good (ES will just ignore the headers until we add specific implementation for it).

No strong feelings on header name, although I'm slightly partial to x-origin-application, so that non-Kibana applications (users or otherwise) could also use it if they want.

[pgayvallet]

So x-origin-application would be, like, apm or visualize ? I find it a little misleading, as it is using the 'Kibana' definition of 'application'.

I would personally expect something like that so others, non-kibana callers can leverage the feature:

x-origin-application: kibana
x-origin-plugin: apm

[polyfractal]

That's also 100% cool with us too :) We'll take as much granularity as you'd like to provide... can always simplify on our end if it ends up being too granular, or concatenate them together for display purposes, etc.

[Bamieh]

Note that when we call elasticsearch to query monitoring indices to send to telemetry usage data we append this header:

X-QUERY-SOURCE: 'TELEMETRY'

We've added this header long time ago in case we want to filter / track those es queries for cloud billing.

---

Also we do pass esClient and savedobject client to the fetch function to all collectors. These collectors are ran whenever usage is requested. each plugin has its own collectors to send its usage from. We can simply add a usage header of some sorts to the fetch clients to track exclusive usage of ES for fetching telemetry.

[pgayvallet]

Now that we're sending the x-elastic-product-origin header for #81536, should we align the header name for the calling plugin? Maybe x-elastic-plugin-origin?