-
Notifications
You must be signed in to change notification settings - Fork 524
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
docs: APM integration #4928
Conversation
Codecov Report
@@ 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
|
💚 Build Succeeded
Expand to view the summary
Build stats
Test stats 🧪
Trends 🧪 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great!
There was a problem hiding this 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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
jenkins retest this please |
# Conflicts: # apmpackage/apm/0.1.0/_dev/docs/README.template.md # apmpackage/apm/0.1.0/docs/README.md
# Conflicts: # apmpackage/apm/0.1.0/_dev/docs/README.template.md # apmpackage/apm/0.1.0/docs/README.md
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:
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
ela.st
links and add new links to the Fleet user guideRelated issues and PRs
For #4494.