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

Remove documentation from integration readme #9932

Merged
merged 5 commits into from
Jan 10, 2023

Conversation

bmorelli25
Copy link
Member

Summary

I could use some second opinions on this one. This PR removes almost all of the documentation from the APM package readme. What's left is a brief overview of APM and a field reference. In addition, there are three links to APM documentation:

Closes elastic/observability-docs#2008.

@bmorelli25 bmorelli25 added the Team:Docs Label for the Observability docs team label Dec 29, 2022
@bmorelli25 bmorelli25 requested a review from a team December 29, 2022 19:49
@bmorelli25 bmorelli25 self-assigned this Dec 29, 2022
@mergify
Copy link
Contributor

mergify bot commented Dec 29, 2022

This pull request does not have a backport label. Could you fix it @bmorelli25? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-7.x is the label to automatically backport to the 7.x branch.
  • backport-7./d is the label to automatically backport to the 7./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Dec 29, 2022
@apmmachine
Copy link
Contributor

apmmachine commented Dec 29, 2022

💚 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 preview

Expand to view the summary

Build stats

  • Start Time: 2023-01-09T22:16:00.224+0000

  • Duration: 10 min 55 sec

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate and publish the docker images.

  • /test windows : Build & tests on Windows.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@apmmachine
Copy link
Contributor

apmmachine commented Dec 29, 2022

📚 Go benchmark report

Diff with the main branch

name                                          old time/op    new time/op    delta
pkg:github.com/elastic/apm-server/internal/agentcfg goos:linux goarch:amd64
FetchAndAdd/FetchFromCache-12                   41.2ns ± 0%    46.2ns ± 0%   +12.20%  (p=0.016 n=4+5)
FetchAndAdd/FetchAndAddToCache-12               95.5ns ± 2%   102.1ns ± 0%    +6.83%  (p=0.008 n=5+5)
pkg:github.com/elastic/apm-server/internal/beater/request goos:linux goarch:amd64
ContextReset/Remote_Addr_ipv4-12                 767ns ±13%     657ns ±15%   -14.34%  (p=0.016 n=5+5)
ContextReset/X-Forwarded-For_ipv6-12             937ns ±16%     645ns ±36%   -31.11%  (p=0.016 n=5+5)
ContextResetContentEncoding/empty-12             110ns ± 1%     123ns ± 0%   +11.88%  (p=0.008 n=5+5)
ContextResetContentEncoding/uncompressed-12      130ns ± 1%     145ns ± 1%   +12.23%  (p=0.008 n=5+5)
pkg:github.com/elastic/apm-server/internal/publish goos:linux goarch:amd64
Publisher-12                                     1.00s ± 0%     1.00s ± 0%    -0.03%  (p=0.016 n=4+5)
pkg:github.com/elastic/apm-server/x-pack/apm-server/aggregation/spanmetrics goos:linux goarch:amd64
pkg:github.com/elastic/apm-server/x-pack/apm-server/aggregation/txmetrics goos:linux goarch:amd64
pkg:github.com/elastic/apm-server/x-pack/apm-server/sampling goos:linux goarch:amd64
pkg:github.com/elastic/apm-server/x-pack/apm-server/sampling/eventstorage goos:linux goarch:amd64
WriteTransaction/json_codec-12                  4.67µs ±18%   11.20µs ±46%  +139.92%  (p=0.008 n=5+5)
WriteTransaction/json_codec_big_tx-12           4.95µs ± 4%   12.37µs ±53%  +149.98%  (p=0.008 n=5+5)
ReadEvents/json_codec/0_events-12                321ns ± 6%     363ns ± 3%   +13.14%  (p=0.008 n=5+5)
ReadEvents/json_codec_big_tx/0_events-12         308ns ± 6%     355ns ± 9%   +15.22%  (p=0.008 n=5+5)
ReadEvents/json_codec_big_tx/1_events-12        11.5µs ± 9%    12.4µs ± 3%    +7.81%  (p=0.032 n=5+5)
ReadEvents/nop_codec/0_events-12                 306ns ± 5%     344ns ± 5%   +12.13%  (p=0.008 n=5+5)
ReadEvents/nop_codec/1_events-12                1.99µs ± 4%    2.13µs ± 4%    +7.35%  (p=0.032 n=5+4)
ReadEvents/nop_codec/1000_events-12              897µs ± 5%     983µs ±13%    +9.63%  (p=0.032 n=5+5)
ReadEvents/nop_codec_big_tx/1_events-12         1.95µs ± 8%    2.21µs ± 9%   +13.11%  (p=0.016 n=5+5)
IsTraceSampled/sampled-12                       69.7ns ± 3%    77.4ns ± 3%   +11.12%  (p=0.008 n=5+5)
IsTraceSampled/unsampled-12                     71.3ns ± 2%    79.3ns ± 1%   +11.22%  (p=0.008 n=5+5)
IsTraceSampled/unknown-12                        370ns ± 1%     422ns ± 2%   +13.91%  (p=0.008 n=5+5)

name                                          old alloc/op   new alloc/op   delta
pkg:github.com/elastic/apm-server/internal/agentcfg goos:linux goarch:amd64
pkg:github.com/elastic/apm-server/internal/beater/request goos:linux goarch:amd64
pkg:github.com/elastic/apm-server/internal/publish goos:linux goarch:amd64
pkg:github.com/elastic/apm-server/x-pack/apm-server/aggregation/spanmetrics goos:linux goarch:amd64
pkg:github.com/elastic/apm-server/x-pack/apm-server/aggregation/txmetrics goos:linux goarch:amd64
pkg:github.com/elastic/apm-server/x-pack/apm-server/sampling goos:linux goarch:amd64
pkg:github.com/elastic/apm-server/x-pack/apm-server/sampling/eventstorage goos:linux goarch:amd64
ReadEvents/json_codec_big_tx/100_events-12      1.03MB ± 0%    1.03MB ± 0%    +0.06%  (p=0.016 n=5+5)
ReadEvents/nop_codec/1000_events-12             2.18MB ± 0%    2.19MB ± 1%    +0.54%  (p=0.032 n=5+5)

name                                          old allocs/op  new allocs/op  delta
pkg:github.com/elastic/apm-server/internal/agentcfg goos:linux goarch:amd64
pkg:github.com/elastic/apm-server/internal/beater/request goos:linux goarch:amd64
pkg:github.com/elastic/apm-server/internal/publish goos:linux goarch:amd64
pkg:github.com/elastic/apm-server/x-pack/apm-server/aggregation/spanmetrics goos:linux goarch:amd64
pkg:github.com/elastic/apm-server/x-pack/apm-server/aggregation/txmetrics goos:linux goarch:amd64
pkg:github.com/elastic/apm-server/x-pack/apm-server/sampling goos:linux goarch:amd64
pkg:github.com/elastic/apm-server/x-pack/apm-server/sampling/eventstorage goos:linux goarch:amd64

report generated with https://pkg.go.dev/golang.org/x/perf/cmd/benchstat

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.

LGTM

apmpackage/apm/_dev/build/docs/README.md Outdated Show resolved Hide resolved
@bmorelli25 bmorelli25 enabled auto-merge (squash) January 9, 2023 22:06
@bmorelli25 bmorelli25 merged commit c62650b into elastic:main Jan 10, 2023
@bmorelli25 bmorelli25 deleted the new-apm-integration-docs branch January 10, 2023 00:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-skip Skip notification from the automated backport with mergify Team:Docs Label for the Observability docs team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace APM integration documentation with static page
4 participants