-
Notifications
You must be signed in to change notification settings - Fork 541
docs: Update and combine troubleshooting guides #10827
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
55f875a
very basic for now
bmorelli25 e159859
Merge branch 'main' of https://github.com/elastic/apm-server into ft-…
bmorelli25 9e3888b
update and combine troubleshooting guides
bmorelli25 2404570
remove file
bmorelli25 d320df0
Merge branch 'main' into ft-troubleshoot
bmorelli25 cd2e363
empty
bmorelli25 85dd706
fix broken link
bmorelli25 998440e
Merge branch 'main' into ft-troubleshoot
bmorelli25 4faefcd
Merge branch 'main' of https://github.com/elastic/apm-server into ft-…
bmorelli25 a77db2a
feedback from @simitt
bmorelli25 9a80b17
Apply suggestions from code review
bmorelli25 1828108
Merge branch 'main' into ft-troubleshoot
bmorelli25 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| [[common-response-codes]] | ||
| === APM Server response codes | ||
|
|
||
| [[bad-request]] | ||
| [float] | ||
| ==== HTTP 400: Data decoding error / Data validation error | ||
|
|
||
| The most likely cause for this error is using incompatible versions of {apm-agent} and APM Server. | ||
| See the <<agent-server-compatibility,agent/server compatibility matrix>> to verify compatibility. | ||
|
|
||
| [[event-too-large]] | ||
| [float] | ||
| ==== HTTP 400: Event too large | ||
|
|
||
| APM agents communicate with the APM server by sending events in an HTTP request. Each event is sent as its own line in the HTTP request body. If events are too large, you should consider increasing the <<apm-input-general-settings,maximum size per event>> | ||
| setting in the APM integration, and adjusting relevant settings in the agent. | ||
|
|
||
| [[unauthorized]] | ||
| [float] | ||
| ==== HTTP 401: Invalid token | ||
|
|
||
| Either the <<secret-token>> in the request header doesn't match the secret token configured in the APM integration, | ||
| or the <<api-key>> is invalid. | ||
|
|
||
| [[forbidden]] | ||
| [float] | ||
| ==== HTTP 403: Forbidden request | ||
|
|
||
| Either you are sending requests to a <<apm-rum,RUM>> endpoint without RUM enabled, or a request | ||
| is coming from an origin not specified in the APM integration settings. | ||
| See the <<apm-input-rum-settings,Allowed origins>> setting for more information. | ||
|
|
||
| [[request-timed-out]] | ||
| [float] | ||
| ==== HTTP 503: Request timed out waiting to be processed | ||
|
|
||
| This happens when APM Server exceeds the maximum number of requests that it can process concurrently. | ||
| To alleviate this problem, you can try to: reduce the sample rate and/or reduce the collected stack trace information. | ||
| See <<reduce-apm-storage>> for more information. | ||
|
|
||
| Another option is to increase processing power. | ||
| This can be done by either migrating your {agent} to a more powerful machine | ||
| or adding more APM Server instances. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| [[server-es-down]] | ||
| === What happens when APM Server or {es} is down? | ||
|
|
||
| *If {es} is down* | ||
|
|
||
| APM Server does not have an internal queue to buffer requests, | ||
| but instead leverages an HTTP request timeout to act as back-pressure. | ||
| If {es} goes down, the APM Server will eventually deny incoming requests. | ||
| Both the APM Server and {apm-agent}(s) will issue logs accordingly. | ||
|
|
||
| *If APM Server is down* | ||
|
|
||
| Some agents have internal queues or buffers that will temporarily store data if the APM Server goes down. | ||
| As a general rule of thumb, queues fill up quickly. Assume data will be lost if APM Server goes down. | ||
| Adjusting these queues/buffers can increase the agent's overhead, so use caution when updating default values. | ||
|
|
||
| * **Go agent** - Circular buffer with configurable size: | ||
| {apm-go-ref}/configuration.html#config-api-buffer-size[`ELASTIC_APM_BUFFER_SIZE`]. | ||
| // * **iOS agent** - ?? | ||
| * **Java agent** - Internal buffer with configurable size: | ||
| {apm-java-ref}/config-reporter.html#config-max-queue-size[`max_queue_size`]. | ||
| * **Node.js agent** - No internal queue. Data is lost. | ||
| * **PHP agent** - No internal queue. Data is lost. | ||
| * **Python agent** - Internal {apm-py-ref}/tuning-and-overhead.html#tuning-queue[Transaction queue] | ||
| with configurable size and time between flushes. | ||
| * **Ruby agent** - Internal queue with configurable size: | ||
| {apm-ruby-ref}/configuration.html#config-api-buffer-size[`api_buffer_size`]. | ||
| * **RUM agent** - No internal queue. Data is lost. | ||
| * **.NET agent** - No internal queue. Data is lost. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "SSL client fails to connect" section is pretty weird IMO. I realise it's preexisting, but I don't think I've ever read it before. Why use telnet to debug? How does one "Verify that the certificate is valid and that the hostname and IP match."?
I guess leave this as a followup, but perhaps we should just suggest that users run
curlto check they can make a request to the server?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. I'll open an issue to address this.