Skip to content

Adds applies tags to Troubleshoot > Observability section #705

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

Merged
merged 11 commits into from
Mar 13, 2025
Merged

Adds applies tags to Troubleshoot > Observability section #705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
9065e3e
Adds applies tags to Troubleshoot > Observability section
natasha-moore-elastic Mar 7, 2025
9455662
Apply suggestions from code review
natasha-moore-elastic Mar 10, 2025
da2190b
Merge branch 'main' into ts-obs-applies
natasha-moore-elastic Mar 10, 2025
30b595d
deletes duplicate page
natasha-moore-elastic Mar 10, 2025
bfaa200
updates link
natasha-moore-elastic Mar 10, 2025
676ea21
Address feedback
natasha-moore-elastic Mar 12, 2025
1253dfa
Merge branch 'main' into ts-obs-applies
natasha-moore-elastic Mar 12, 2025
f7d68d2
Apply suggestions from code review
natasha-moore-elastic Mar 13, 2025
ea2f29b
Merge branch 'main' into ts-obs-applies
natasha-moore-elastic Mar 13, 2025
5041344
fix broken link
natasha-moore-elastic Mar 13, 2025
fd66524
Merge branch 'main' into ts-obs-applies
natasha-moore-elastic Mar 13, 2025
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
2 changes: 1 addition & 1 deletion solutions/observability/apps/apm-agent-compatibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The chart below outlines the compatibility between different versions of Elastic
| `1.x` | ≥ `6.5` |

::::{note}
Java agent < 1.43.0 not fully compatible with APM Server >= 8.11.0. Read more in [Known issues](../../../troubleshoot/observability/apm/known-issues.md#apm-empty-metricset-values).
Java agent < 1.43.0 not fully compatible with APM Server >= 8.11.0. Read more in [Known issues](/release-notes/known-issues/elastic-apm.md).

::::

Expand Down
4 changes: 4 additions & 0 deletions troubleshoot/observability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
navigation_title: "Observability"
mapped_pages:
- https://www.elastic.co/guide/en/observability/current/troubleshooting.html
applies_to:
stack: all
serverless:
observability: all
---

# Troubleshoot Observability [troubleshooting]
Expand Down
4 changes: 4 additions & 0 deletions troubleshoot/observability/amazon-data-firehose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
navigation_title: "Amazon Data Firehose"
mapped_pages:
- https://www.elastic.co/guide/en/observability/current/monitor-aws-firehose-troubleshooting.html
applies_to:
stack: all
serverless:
observability: all
---


Expand Down
4 changes: 4 additions & 0 deletions troubleshoot/observability/apm-agent-dotnet/apm-net-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
navigation_title: "APM .NET agent"
mapped_pages:
- https://www.elastic.co/guide/en/apm/agent/dotnet/current/troubleshooting.html
applies_to:
stack: all
serverless:
observability: all
---

# Troubleshoot APM .NET agent
Expand Down
4 changes: 4 additions & 0 deletions troubleshoot/observability/apm-agent-go/apm-go-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
navigation_title: "APM Go Agent"
mapped_pages:
- https://www.elastic.co/guide/en/apm/agent/go/current/troubleshooting.html
applies_to:
stack: all
serverless:
observability: all
---

# Troubleshoot APM Go Agent
Expand Down
4 changes: 4 additions & 0 deletions troubleshoot/observability/apm-agent-java/apm-java-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
navigation_title: "APM Java Agent"
mapped_pages:
- https://www.elastic.co/guide/en/apm/agent/java/current/trouble-shooting.html
applies_to:
stack: all
serverless:
observability: all
---

# Troubleshoot APM Java Agent [trouble-shooting]
Expand Down
4 changes: 4 additions & 0 deletions troubleshoot/observability/apm-agent-nodejs/apm-nodejs-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
navigation_title: "APM Node.js Agent"
mapped_pages:
- https://www.elastic.co/guide/en/apm/agent/nodejs/current/troubleshooting.html
applies_to:
stack: all
serverless:
observability: all
---

# Troubleshoot APM Node.js Agent [troubleshooting]
Expand Down
4 changes: 4 additions & 0 deletions troubleshoot/observability/apm-agent-php/apm-php-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
navigation_title: "APM PHP Agent"
mapped_pages:
- https://www.elastic.co/guide/en/apm/agent/php/current/troubleshooting.html
applies_to:
stack: all
serverless:
observability: all
---

# Troubleshoot APM PHP Agent [troubleshooting]
Expand Down
4 changes: 4 additions & 0 deletions troubleshoot/observability/apm-agent-python/apm-python-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
navigation_title: "APM Python Agent"
mapped_pages:
- https://www.elastic.co/guide/en/apm/agent/python/current/troubleshooting.html
applies_to:
stack: all
serverless:
observability: all
---

# Troubleshoot APM Python Agent [troubleshooting]
Expand Down
4 changes: 4 additions & 0 deletions troubleshoot/observability/apm-agent-ruby/apm-ruby-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
navigation_title: "APM Ruby Agent"
mapped_pages:
- https://www.elastic.co/guide/en/apm/agent/ruby/current/debugging.html
applies_to:
stack: all
serverless:
observability: all
---

# Troubleshoot APM Ruby Agent [debugging]
Expand Down
2 changes: 2 additions & 0 deletions ...oot/observability/apm-agent-rum-js/apm-real-user-monitoring-javascript-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
navigation_title: "APM Real User Monitoring JavaScript Agent"
mapped_pages:
- https://www.elastic.co/guide/en/apm/agent/rum-js/current/troubleshooting.html
applies_to:
stack: all
---

# Troubleshoot APM Real User Monitoring JavaScript Agent [troubleshooting]
Expand Down
2 changes: 2 additions & 0 deletions troubleshoot/observability/apm-agent-swift/apm-ios-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
navigation_title: "APM iOS Agent"
mapped_pages:
- https://www.elastic.co/guide/en/apm/agent/swift/current/troubleshooting.html
applies_to:
stack: all
---

# Troubleshoot APM iOS Agent [troubleshooting]
Expand Down
4 changes: 4 additions & 0 deletions troubleshoot/observability/apm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
navigation_title: "APM"
mapped_pages:
- https://www.elastic.co/guide/en/observability/current/apm-troubleshoot-apm.html
applies_to:
stack: all
serverless:
observability: all
Comment on lines +5 to +8
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure how to handle this one since some of the APM agents are not applicable to serverless. Maybe it's ok to still list them on this page, but call out on the individual APM agent pages below when something is not applicable to serverless?

Copy link
Member

Choose a reason for hiding this comment

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

Hmmm. Yeah this is a good callout. This isn't the only page with this problem. What are we doing on the other pages?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@marciw, do you know if we have any examples like this elsewhere in the troubleshooting docs? I think Colleen's suggestion makes sense, since each page will have its own applies badge.

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 know of other examples offhand (but I'm sure there are some).

I like Colleen's suggestion too -- seems totally reasonable to have a top-level "something on this page applies" and then page- or section-specific exceptions/distinctions. 👍

---


Expand Down
4 changes: 4 additions & 0 deletions troubleshoot/observability/apm/_agent_is_not_instrumenting_code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/apm/agent/php/current/_agent_is_not_instrumenting_code.html
applies_to:
stack: all
serverless:
observability: all
---

# Agent is not instrumenting code [_agent_is_not_instrumenting_code]
Expand Down
4 changes: 4 additions & 0 deletions troubleshoot/observability/apm/_collection_of_diagnostic_information.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/apm/agent/php/current/_collection_of_diagnostic_information.html
applies_to:
stack: all
serverless:
observability: all
---

# Collection of diagnostic information [_collection_of_diagnostic_information]
Expand Down
2 changes: 2 additions & 0 deletions troubleshoot/observability/apm/apm-server-performance-diagnostic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/observability/current/apm-performance-diagnostic.html
applies_to:
stack: all
---

# APM Server performance diagnostic [apm-performance-diagnostic]
Expand Down
40 changes: 37 additions & 3 deletions troubleshoot/observability/apm/apm-server-response-codes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,58 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/observability/current/apm-common-response-codes.html
applies_to:
stack: all
serverless:
observability: all
---

# APM Server response codes [apm-common-response-codes]


## HTTP 400: Data decoding error / Data validation error [apm-bad-request]

The most likely cause for this error is using incompatible versions of {{apm-agent}} and APM Server. See the [agent/server compatibility matrix](../../../solutions/observability/apps/apm-agent-compatibility.md) to verify compatibility.
::::{tab-set}

:::{tab-item} {{stack}}
The most likely cause for this error is using incompatible versions of {{apm-agent}} and APM Server. See the [agent/server compatibility matrix](/solutions/observability/apps/apm-agent-compatibility.md) to verify compatibility.
:::

:::{tab-item} {{serverless-short}}
The most likely cause for this error is using an incompatible version of an {{apm-agent}}. See [minimum supported APM agent versions](/solutions/observability/apps/elastic-apm-agents.md#observability-apm-agents-elastic-apm-agents-minimum-supported-versions) to verify compatibility.
:::

::::


## HTTP 400: Event too large [apm-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 [Max event size](../../../solutions/observability/apps/general-configuration-options.md#apm-max_event_size) setting in the APM integration, and adjusting relevant settings in the agent.
::::{tab-set}

:::{tab-item} {{stack}}
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 [Max event size](/solutions/observability/apps/general-configuration-options.md#apm-max_event_size) setting in the APM integration, and adjusting relevant settings in the agent.
:::

:::{tab-item} {{serverless-short}}
APM agents communicate with the Managed intake service 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 can reduce the size of the events that your APM agents send by: [enabling span compression](/solutions/observability/apps/spans.md) or [reducing collected stack trace information](/solutions/observability/apps/reduce-storage.md#observability-apm-reduce-stacktrace).
:::

::::


## HTTP 401: Invalid token [apm-unauthorized]

Either the [Secret token](../../../solutions/observability/apps/secret-token.md) in the request header doesn’t match the secret token configured in the APM integration, or the [API keys](../../../solutions/observability/apps/api-keys.md) is invalid.
::::{tab-set}

:::{tab-item} {{stack}}
Either the [Secret token](/solutions/observability/apps/secret-token.md) in the request header doesn’t match the secret token configured in the APM integration, or the [API keys](/solutions/observability/apps/api-keys.md) is invalid.
:::

:::{tab-item} {{serverless-short}}
The API key is invalid.
:::

::::


## HTTP 403: Forbidden request [apm-forbidden]
Expand Down
25 changes: 4 additions & 21 deletions troubleshoot/observability/apm/common-problems.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
mapped_pages:
- https://www.elastic.co/guide/en/observability/current/apm-common-problems.html
- https://www.elastic.co/guide/en/serverless/current/observability-apm-troubleshooting.html
applies_to:
stack: all
serverless:
observability: all
---

# Common problems [apm-common-problems]
Expand Down Expand Up @@ -290,24 +294,3 @@ To fix this, make sure these two fields match exactly.

For example, if the APM agent is not configured to use the correct host name, the host name might be set to the container name or the Kubernetes pod name. To get the correct host name, you need to set some additional configuration options, specifically `system.kubernetes.node.name` as described in [Kubernetes data](../../../solutions/observability/apps/elastic-apm-events-intake-api.md#apm-api-kubernetes-data).


## Common response codes [observability-apm-troubleshooting-common-response-codes]
```yaml {applies_to}
serverless: all
```


### HTTP 400: Data decoding error / Data validation error [bad-request]

The most likely cause for this error is using an incompatible version of an {{apm-agent}}. See [minimum supported APM agent versions](../../../solutions/observability/apps/elastic-apm-agents.md#observability-apm-agents-elastic-apm-agents-minimum-supported-versions) to verify compatibility.


### HTTP 400: Event too large [event-too-large]

APM agents communicate with the Managed intake service 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 can reduce the size of the events that your APM agents send by: [enabling span compression](../../../solutions/observability/apps/spans.md) or [reducing collected stack trace information](../../../solutions/observability/apps/reduce-storage.md#observability-apm-reduce-stacktrace).


### HTTP 401: Invalid token [unauthorized]

The API key is invalid.

2 changes: 2 additions & 0 deletions troubleshoot/observability/apm/enable-apm-server-binary-debugging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
navigation_title: "APM Server binary debugging"
mapped_pages:
- https://www.elastic.co/guide/en/observability/current/apm-enable-apm-server-debugging.html
applies_to:
stack: all
---


Expand Down
Loading