Skip to content

[docs] APM Overview structure and content improvements#2171

Merged
bmorelli25 merged 14 commits intoelastic:masterfrom
bmorelli25:revamp-apm-overview
Jul 3, 2019
Merged

[docs] APM Overview structure and content improvements#2171
bmorelli25 merged 14 commits intoelastic:masterfrom
bmorelli25:revamp-apm-overview

Conversation

@bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented May 7, 2019

Preview this PR on Firebase: https://elastic-obs-docs.firebaseapp.com/index.html
😮 🆒 😎 🎉


Backports


This PR improves the content and structure of the APM Overview:

  • Shifts to a cloud-first approach for installation
  • Improves the layout of tables
  • Refreshes old images and screenshots
  • Adds new architecture images - closes [docs] Update APM Architecture diagram to include cloud #2117
  • Adds a new "Troubleshooting" top level heading
  • Adds a new "Real User Monitoring" top level heading
  • Updates the overview
  • Updates the components and documentation links

Proposed new structure:

  • Overview (What is APM?)
  • Components and documentation (What are the components and where can I find the relevant documentation?)
  • Install and run (Cloud first)
    • Step 1: Install Elasticsearch
    • Step 2: Install Kibana
    • Step 3: Install APM Server
    • Step 4: Install APM agents
  • Data Model (What kind of data does APM capture?)
    • Spans
    • Transactions
    • Errors
    • Metrics
    • Metadata
  • Distributed tracing
  • Real User Monitoring (RUM)
  • OpenTracing bridge
  • Agent and Server compatibility
  • Troubleshooting
  • Breaking changes
  • Release highlights

Other notes:

@bmorelli25 bmorelli25 force-pushed the revamp-apm-overview branch from a13afdb to 82a095c Compare June 26, 2019 17:31
@bmorelli25 bmorelli25 marked this pull request as ready for review June 26, 2019 22:59
@bmorelli25
Copy link
Member Author

The failing elasticsearch-ci/docs-build is unrelated (it's really a bug).

@bmorelli25 bmorelli25 requested a review from graphaelli June 26, 2019 23:09
@bmorelli25 bmorelli25 changed the title [docs][WIP] APM Overview structure [docs] APM Overview structure and content improvements Jun 26, 2019
@bmorelli25
Copy link
Member Author

cc @tbragin

bmorelli25 and others added 3 commits July 1, 2019 22:37
Co-Authored-By: Gil Raphaelli <g@raphaelli.com>
Co-Authored-By: Gil Raphaelli <g@raphaelli.com>
@bmorelli25 bmorelli25 merged commit 3209835 into elastic:master Jul 3, 2019
@tbragin
Copy link

tbragin commented Jul 7, 2019

@bmorelli25 Love this change! I see it in master:
https://www.elastic.co/guide/en/apm/get-started/master/install-and-run.html#install-and-run

How far back do you think we can backport it?

@tbragin
Copy link

tbragin commented Jul 7, 2019

Small nit -- since the page above is so short, I don't know if we need the "Alternatively, you can install the stack yourself." since the install the stack option is visible above the fold.

@bmorelli25
Copy link
Member Author

Thanks Tanya. Good point with the nit, I'll get that fixed.

Backporting to 7.0 will be easy. Everything before that will take a little bit of work. I'm going to try and take this as far as I can. Probably 6.6 or 6.5.

bmorelli25 added a commit to bmorelli25/apm-server that referenced this pull request Jul 10, 2019
bmorelli25 added a commit to bmorelli25/apm-server that referenced this pull request Jul 10, 2019
bmorelli25 added a commit to bmorelli25/apm-server that referenced this pull request Jul 10, 2019
bmorelli25 added a commit to bmorelli25/apm-server that referenced this pull request Jul 10, 2019
bmorelli25 added a commit to bmorelli25/apm-server that referenced this pull request Jul 10, 2019
bmorelli25 added a commit to bmorelli25/apm-server that referenced this pull request Jul 10, 2019
# Conflicts:
#	docs/guide/agent-server-compatibility.asciidoc
#	docs/guide/apm-architecture.png
#	docs/guide/install-and-run.asciidoc
#	docs/guide/redirects.asciidoc
bmorelli25 added a commit to bmorelli25/apm-server that referenced this pull request Jul 10, 2019
# Conflicts:
#	docs/guide/agent-server-compatibility.asciidoc
#	docs/guide/apm-architecture.png
#	docs/guide/install-and-run.asciidoc
#	docs/guide/redirects.asciidoc
@bmorelli25 bmorelli25 deleted the revamp-apm-overview branch July 10, 2019 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] Update APM Architecture diagram to include cloud

3 participants