Skip to content

Commit

Permalink
[8.9] [docs] Explain max payload size in RUM source map docs (#165732) (
Browse files Browse the repository at this point in the history
#166278)

# Backport

This will backport the following commits from `main` to `8.9`:
- [[docs] Explain max payload size in RUM source map docs
(#165732)](#165732)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Brandon
Morelli","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-09-12T15:22:08Z","message":"[docs]
Explain max payload size in RUM source map docs (#165732)\n\n##
Summary\r\n\r\nCloses
https://github.com/elastic/observability-docs/issues/3021.","sha":"ddf1db09f90b45c363fcd875fc7363a245aca969","branchLabelMapping":{"^v8.11.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:APM","release_note:skip","v8.9.0","v8.10.0","v8.11.0"],"number":165732,"url":"https://github.com/elastic/kibana/pull/165732","mergeCommit":{"message":"[docs]
Explain max payload size in RUM source map docs (#165732)\n\n##
Summary\r\n\r\nCloses
https://github.com/elastic/observability-docs/issues/3021.","sha":"ddf1db09f90b45c363fcd875fc7363a245aca969"}},"sourceBranch":"main","suggestedTargetBranches":["8.9","8.10"],"targetPullRequestStates":[{"branch":"8.9","label":"v8.9.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.10","label":"v8.10.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.11.0","labelRegex":"^v8.11.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/165732","number":165732,"mergeCommit":{"message":"[docs]
Explain max payload size in RUM source map docs (#165732)\n\n##
Summary\r\n\r\nCloses
https://github.com/elastic/observability-docs/issues/3021.","sha":"ddf1db09f90b45c363fcd875fc7363a245aca969"}}]}]
BACKPORT-->

Co-authored-by: Brandon Morelli <[email protected]>
  • Loading branch information
kibanamachine and bmorelli25 authored Sep 12, 2023
1 parent 87a63a2 commit 88a71e3
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/apm/api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -503,6 +503,16 @@ The following APIs are available:
* <<rum-sourcemap-get>>
* <<rum-sourcemap-delete>>

[float]
[[limit-sourcemap-api]]
==== Max payload size

{kib}'s maximum payload size is 1mb.
If you attempt to upload a source map that exceeds the max payload size, you will get a `413` error.

Before uploading source maps that exceed this default, change the maximum payload size allowed by {kib}
with the <<server-maxPayload,`server.maxPayload`>> variable.

[float]
[[use-sourcemap-api]]
==== How to use APM APIs
Expand Down

0 comments on commit 88a71e3

Please sign in to comment.