Add per request functionality to add HTTP request headers #756

111andre111 · 2024-10-08T15:44:21Z

Feature statement

Adds functionality to configure headers on a per request statement
Syntax example:

<requestname>:
  versions:
    ">= <stackversion>":
      url: "<api url"
      extra-headers:
        <header1>: "<header1value"
        <header2>: "<header2value"

Checklist

I have verified that the existing global header functionality in config/diags.yml from Add support for additional headers to DiagnosticService #519 still works
e.g.

extra-headers:
  elastic-api-version: "2023-10-31"

I have verified that the local headers in {kibana|elastic|logstash}-rest.yaml overwrite the global header functionality

Fixes #657

…nagement

…y` using `setExtraHeaders()`

…xecution

…multiple entries

…aking requests

…h per-request headers (`currentRestEntry`)

…headers

…ng Kibana REST queries/lifecycle

…ng Elasticsearch REST queries/lifecycle

…ng Logstash REST queries/lifecycle

…like `elastic-api-version`

pickypg · 2024-10-10T20:14:51Z

src/main/java/co/elastic/support/rest/RestEntryConfig.java

+                    RestEntry restEntry = new RestEntry(name, subdir, extension, retry, url, showErrors, pageableFieldName, spaceAware);
+
+                    // Logic for handling extra-headers, if they exist, after RestEntry is created
+                    if (info.containsKey("extra-headers")) {


Is there a downside to just extracting the headers during creation, like we do with spaceAware for example?

@111andre111 Is there a reason for this or just how you implemented it at the time (either way is fine, I'm just trying to understand)?

111andre111 added 14 commits October 8, 2024 16:18

Add field and initialize it

96719d3

Add getExtraHeaders() and setExtraHeaders() methods for header ma…

2ce7545

…nagement

Parse extra-headers from configuration and assign them to `RestEntr…

577b748

…y` using `setExtraHeaders()`

Introduce currentRestEntry to track headers for each HTTP request e…

75cb468

…xecution

Add setCurrentRestEntry() method for setting per-request headers

249a3db

Add setRestEntries(Map<String, RestEntry> restEntries) to populate …

32199f3

…multiple entries

Update query execution logic to call setCurrentRestEntry() before m…

2fbe148

…aking requests

Modify execRequest() to combine global headers (extraHeaders) wit…

a88a057

…h per-request headers (`currentRestEntry`)

Added debugging logger line for the headers

e441ab3

Update Base command query to execute per request to overwrite global …

4808c37

…headers

Update command classes to call setCurrentRestEntry() before executi…

8141fa6

…ng Kibana REST queries/lifecycle

Update command classes to call setCurrentRestEntry() before executi…

53d43f8

…ng Elasticsearch REST queries/lifecycle

Update command classes to call setCurrentRestEntry() before executi…

e8663c0

…ng Logstash REST queries/lifecycle

Update respective API entries in YAML to include per-request headers …

c3c47dd

…like `elastic-api-version`

111andre111 requested a review from pickypg as a code owner October 8, 2024 15:44

pickypg reviewed Oct 10, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add per request functionality to add HTTP request headers #756

Add per request functionality to add HTTP request headers #756

111andre111 commented Oct 8, 2024

pickypg Oct 10, 2024

pickypg Dec 19, 2024

Add per request functionality to add HTTP request headers #756

Are you sure you want to change the base?

Add per request functionality to add HTTP request headers #756

Conversation

111andre111 commented Oct 8, 2024

Feature statement

Checklist

pickypg Oct 10, 2024

Choose a reason for hiding this comment

pickypg Dec 19, 2024

Choose a reason for hiding this comment