Skip to content

[docs] Miscellaneous docs clean up #411

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 1 commit into from
Mar 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
475 changes: 0 additions & 475 deletions docs/docset.yml

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/reference/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ val agent = ElasticApmAgent.builder(application)
agent.span("My Span") {
Thread.sleep(500) // <1>
agent.span("My nested Span") { // <2>
Thread.sleep(500)
Thread.sleep(500)
}
}
```
Expand All @@ -83,21 +83,21 @@ Once your app has sent telemetry data, either [manually](manual-instrumentation.

You should find your application listed there.

:::{image} ../images/span-visualization/1.png
:::{image} /reference/images/span-visualization/1.png
:screenshot:
:width: 350px
:::

When you open it, go to the **Transactions** tab, where you should see your app's "outermost" spans listed.

:::{image} ../images/span-visualization/2.png
:::{image} /reference/images/span-visualization/2.png
:screenshot:
:width: 350px
:::

After clicking on the span, you should see it in detail.

:::{image} ../images/span-visualization/3.png
:::{image} /reference/images/span-visualization/3.png
:screenshot:
:::

Expand Down
8 changes: 4 additions & 4 deletions docs/reference/how-tos.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,25 +50,25 @@ The export endpoint is where your app's telemetry is sent, so it's required to i

Then select **Application**, as shown below:

:::{image} ../images/find-export-endpoint/1.png
:::{image} /reference/images/find-export-endpoint/1.png
:screenshot:
:::

Choose **OpenTelemetry**:

:::{image} ../images/find-export-endpoint/2.png
:::{image} /reference/images/find-export-endpoint/2.png
:screenshot:
:::

On the next page, scroll down to the **APM Agents** pane, and select the **OpenTelemetry** tab:

:::{image} ../images/find-export-endpoint/3.png
:::{image} /reference/images/find-export-endpoint/3.png
:screenshot:
:::

Your export endpoint URL is the value for the **`OTEL_EXPORTER_OTLP_ENDPOINT`** configuration setting:

:::{image} ../images/find-export-endpoint/4.png
:::{image} /reference/images/find-export-endpoint/4.png
:screenshot:
:::

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ mapped_pages:

# Introduction

The Elastic OTel Android Agent is an [APM](https://en.wikipedia.org/wiki/Application_performance_management) agent based on [OpenTelemetry](https://opentelemetry.io/) ![alt](../images/opentelemetry-logo.png "OpenTelemetry =16x16"). It provides built-in tools and configurations to make the [OpenTelemetry SDK](https://opentelemetry.io/docs/languages/java/) work with your {{stack}} using as little code as possible while fully leveraging the combined forces of [Elasticsearch](docs-content://get-started/index.md) and [Kibana](docs-content://get-started/the-stack.md) for your Android application.
The Elastic OTel Android Agent is an [APM](https://en.wikipedia.org/wiki/Application_performance_management) agent based on [OpenTelemetry](https://opentelemetry.io/) ![alt](/reference/images/opentelemetry-logo.png "OpenTelemetry =16x16"). It provides built-in tools and configurations to make the [OpenTelemetry SDK](https://opentelemetry.io/docs/languages/java/) work with your {{stack}} using as little code as possible while fully leveraging the combined forces of [Elasticsearch](docs-content://get-started/index.md) and [Kibana](docs-content://get-started/the-stack.md) for your Android application.

## What can I do with it?

Expand All @@ -17,7 +17,7 @@ All the features provided by the [OpenTelemetry SDK](https://github.com/open-tel

Distributed tracing allows you to see the full picture of **how long your application has to wait for your backend services** to provide a response (and why), as shown in the example below:

:::{image} ../images/intro/distributed-tracing.png
:::{image} /reference/images/intro/distributed-tracing.png
:screenshot:
:::

Expand Down
4 changes: 2 additions & 2 deletions docs/release-notes/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
navigation_title: "Release notes"
navigation_title: "Elastic APM Android Agent"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We need to update this (at least for now) because of how this title is used when the docs are compiled. Right now there's no indication that the top section in the image below is related to the OTel Android Agent. (I went with Elastic APM Android Agent for consistency, but let me know if we should change it.)

image

Copy link
Contributor

Choose a reason for hiding this comment

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

Got it, thanks!

mapped_pages:
- https://www.elastic.co/guide/en/apm/agent/android/current/release-notes.html
- https://www.elastic.co/guide/en/apm/agent/android/current/release-notes-0.x.html
Expand All @@ -21,7 +21,7 @@ To check for security updates, go to [Security announcements for the Elastic sta
% ### Fixes [elastic-apm-android-agent-versionext-fixes]

% next_release_notes

## 0.20.0 [elastic-apm-android-agent-0200-release-notes]
**Release date:** July 29, 2024

Expand Down
Loading