Skip to content

Commit

Permalink
add tech preview admonition (#350)
Browse files Browse the repository at this point in the history
  • Loading branch information
bmorelli25 authored Sep 9, 2024
1 parent 8d8b63b commit 9180bc0
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/configuration.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[[configuration]]
== Configuration

preview::[]

[float]
=== Gradle configuration

Expand Down
2 changes: 2 additions & 0 deletions docs/faq.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[[faq]]
== Frequently asked questions

preview::[]

[float]
[[faq-how-does-it-work]]
=== How does the agent work?
Expand Down
2 changes: 2 additions & 0 deletions docs/intro.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[[intro]]
== Introduction

preview::[]

The Elastic APM Android Agent automatically measures the performance of your application and tracks errors.
It has a default configuration that suits most common use cases and built-in support for popular frameworks and technologies.
The agent is built on top of https://opentelemetry.io/[OpenTelemetry], enabling you to add custom instrumentation with the
Expand Down
2 changes: 2 additions & 0 deletions docs/manual-instrumentation.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[[manual-instrumentation]]
== Manual Instrumentation

preview::[]

The Elastic APM Android Agent automatically instruments <<supported-technologies>>, creating spans for interesting events for each case, and some of those automated spans can be <<configuration,configured>> to better suit different app's needs.
However, if you need to create your own, custom spans, metrics and logs, you can do so by accessing the https://opentelemetry.io/docs/instrumentation/java/manual/[OpenTelemetry Java SDK APIs] that this agent is built on top.

Expand Down
2 changes: 2 additions & 0 deletions docs/release-notes.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
[[release-notes]]
== Release notes

preview::[]

// new major versions go here
* <<release-notes-0.x>>

Expand Down
3 changes: 2 additions & 1 deletion docs/setup.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[[setup]]
== Set up the Agent

preview::[]

Follow these steps to start reporting your Android application's performance to Elastic APM:

1. <<gradle-setup>>.
Expand Down Expand Up @@ -155,4 +157,3 @@ Head to the **APM app in {kib}** to start exploring your data.

If you need to customize the Elastic APM agent to your project's needs, see <<configuration,configuration>>.
If you need to create your own custom transactions, see <<manual-instrumentation, manual instrumentation>>.

2 changes: 2 additions & 0 deletions docs/supported-technologies.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[[supported-technologies]]
== Supported technologies

preview::[]

The Elastic APM Android agent is built on top of the https://opentelemetry.io[OpenTelemetry Java SDK] -- extending its functionality while also automatically instrumenting various APIs and frameworks.
This section lists all supported technologies.

Expand Down

0 comments on commit 9180bc0

Please sign in to comment.