Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add rum response_headers #5954

Merged
merged 5 commits into from
Aug 23, 2021
Merged

docs: add rum response_headers #5954

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b917690
docs: add rum response_headers
bmorelli25 Aug 16, 2021
b71283b
docs: bugfix
bmorelli25 Aug 16, 2021
5431bc2
Merge branch 'master' into doc-rum_response_headers
bmorelli25 Aug 19, 2021
8e30206
Update docs/configuration-rum.asciidoc
bmorelli25 Aug 23, 2021
31dc7ce
Merge branch 'master' into doc-rum_response_headers
bmorelli25 Aug 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/configuration-rum.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,17 @@ custom values configured here are appended to the default list and used as the v

Default: `[]`

[float]
[[rum-response-headers]]
==== `response_headers`
Custom HTTP headers to add to RUM responses.
This can be useful for security policy compliance.

Any values set in `apm-server.response_headers` also apply to RUM events.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't quite understand what you mean with this sentence; custom headers are not added to the indexed trace events. Can we just remove this line?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I can remove it. This sentence was added based on what I read in #4523 (comment)

If both are defined, then they will both be added to RUM responses, with values for the same key concatenated.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Any values set in `apm-server.response_headers` also apply to RUM events.

Values set for the same key will be concatenated.

Default: Not set

[float]
[[rum-library-pattern]]
==== `library_pattern`
Expand Down