Skip to content
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

docs: APM integration #4928

Merged
merged 10 commits into from
Mar 10, 2021
Merged

Conversation

bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Mar 8, 2021

Motivation/summary

This PR adds basic APM integration documentation. The content here complements the APM integration quickstart. This is rough; there's still a lot to be added, figured out, and moved around in future PRs. Right now, we have:

  • Top-level TOC heading for the APM integration
    • Architecture
    • Limitations
    • Terminology
  • Data streams
    • Service name considerations
    • Namespace selection
  • APM input settings reference

This PR also updates the APM integration's readme.md file, including links (using ela.st for easy updating) to the new documentation.

Documentation preview

Click here for a preview of this documentation

To do after this is merged

  • Add a RUM source map workaround
  • Add a how-to update templates, pipelines, and ILM guide
  • Update ela.st links and add new links to the Fleet user guide

Related issues and PRs

For #4494.

@bmorelli25 bmorelli25 self-assigned this Mar 8, 2021
@bmorelli25 bmorelli25 changed the title Doc apm server agent docs: APM integration Mar 8, 2021
@codecov-io
Copy link

Codecov Report

Merging #4928 (d05609a) into master (26ea4e9) will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #4928      +/-   ##
==========================================
+ Coverage   76.95%   76.97%   +0.01%     
==========================================
  Files         168      168              
  Lines       10256    10256              
==========================================
+ Hits         7893     7895       +2     
+ Misses       2363     2361       -2     
Impacted Files Coverage Δ
beater/jaeger/common.go 91.66% <0.00%> (+8.33%) ⬆️

@apmmachine
Copy link
Contributor

apmmachine commented Mar 8, 2021

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview

Expand to view the summary

Build stats

  • Build Cause: Started by user Brandon Morelli

  • Start Time: 2021-03-10T21:17:53.842+0000

  • Duration: 43 min 34 sec

  • Commit: 73c45d0

Test stats 🧪

Test Results
Failed 0
Passed 4773
Skipped 117
Total 4890

Trends 🧪

Image of Build Times

Image of Tests

@bmorelli25 bmorelli25 requested a review from a team March 9, 2021 19:17
@bmorelli25 bmorelli25 marked this pull request as ready for review March 9, 2021 19:18
Copy link
Member

@axw axw left a comment

Choose a reason for hiding this comment

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

Looks great!

docs/apm-package/input-apm.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@simitt simitt left a comment

Choose a reason for hiding this comment

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

Thanks again!

This version is experimental and has some limitations, listed bellow:

- Sourcemaps need to be uploaded to Elasticsearch directly.
- You need to create specific API keys for sourcemaps and central configuration.
- You can't use an Elastic Agent enrolled before 7.12.
- Not all settings are supported.
- Template, pipeline, and ILM settings must be configured through Elasticsearch or Kibana, not APM Server.
Copy link
Contributor

Choose a reason for hiding this comment

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

While you are not mentioning Fleet here - we probably should be more clear that Fleet currently does not offer a way of managing templates, pipelines and ILM policies that are shipped by default; they would neet to be changed outside of Fleet.

Copy link
Member Author

Choose a reason for hiding this comment

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

👍 Updated in 10b97e6. I'll also be adding more docs on this in a future PR.

@bmorelli25
Copy link
Member Author

jenkins retest this please

@bmorelli25 bmorelli25 merged commit fce04da into elastic:master Mar 10, 2021
@bmorelli25 bmorelli25 deleted the doc-apm-server-agent branch March 10, 2021 22:02
bmorelli25 added a commit to bmorelli25/apm-server that referenced this pull request Mar 10, 2021
# Conflicts:
#	apmpackage/apm/0.1.0/_dev/docs/README.template.md
#	apmpackage/apm/0.1.0/docs/README.md
bmorelli25 added a commit to bmorelli25/apm-server that referenced this pull request Mar 10, 2021
# Conflicts:
#	apmpackage/apm/0.1.0/_dev/docs/README.template.md
#	apmpackage/apm/0.1.0/docs/README.md
bmorelli25 added a commit that referenced this pull request Mar 11, 2021
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.

5 participants