Skip to content

docs: update broken links for apm-guide-ref #1385 #2541

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

Merged
merged 5 commits into from
Jan 20, 2022

Conversation

ollyhowell
Copy link
Contributor

@ollyhowell ollyhowell commented Jan 20, 2022

Links updated as per elastic/observability-docs#1385. The old links will break when 7.17 releases. This PR and all backports must be merged before the 7.17 release. Thanks!

Backports

@ollyhowell ollyhowell requested a review from bmorelli25 January 20, 2022 16:31
@github-actions github-actions bot added agent-nodejs Make available for APM Agents project planning. community triage labels Jan 20, 2022
@apmmachine
Copy link
Contributor

apmmachine commented Jan 20, 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: 2022-01-20T18:07:31.391+0000

  • Duration: 4 min 32 sec

  • Commit: 112bb46

🤖 GitHub comments

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

  • /test : Re-trigger the build.

  • run module tests for <modules> : Run TAV tests for one or more modules, where <modules> can be either a comma separated list of modules (e.g. memcached,redis) or the string literal ALL to test all modules

  • run benchmark tests : Run the benchmark test only.

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

Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

Thanks, Olly! LG. I'll tag the Node.js team for review and create the lone backport.

@bmorelli25 bmorelli25 marked this pull request as ready for review January 20, 2022 18:11
@bmorelli25 bmorelli25 requested a review from a team January 20, 2022 18:12
@bmorelli25 bmorelli25 added the Team:Docs Label for the Observability docs team label Jan 20, 2022
@bmorelli25 bmorelli25 mentioned this pull request Jan 20, 2022
@@ -373,7 +373,7 @@ still supported. Users should switch to using `longFieldMaxLength`. If
now use the `longFieldMaxLength` value.
+
Note that ultimately the maximum length of any tracing field is limited by the
{apm-server-ref-v}/configuration-process.html#max_event_size[`max_event_size`]
{apm-guide-ref}/configuration-process.html#max_event_size[`max_event_size`]
Copy link
Member

Choose a reason for hiding this comment

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

elastic/observability-docs#1385 suggests this one should be "Remove from Node.js Agent"?

Copy link
Member

Choose a reason for hiding this comment

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

That was an incorrect assumption on my part. This config variable is still valid for the standalone method of running APM Server. We'll need to remove this at a later date.

@@ -104,7 +104,7 @@ containing the data about to be sent to the APM Server.

The format of the payload depends on the event type being sent.
For details about the different formats,
see the {apm-server-ref-v}/intake-api.html[APM Server intake API documentation].
see the {apm-guide-ref}/intake-api.html[APM Server intake API documentation].
Copy link
Member

Choose a reason for hiding this comment

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

elastic/observability-docs#1385 says

{apm-server-ref}/intake-api.html -> {apm-guide-ref}/api.html

Though perhaps for this one we'd (eventually?) want https://www.elastic.co/guide/en/apm/guide/7.17/api-events.html ? I'm not sure if the intent of this PR is to just fix the {apm-server-ref-v} reference, or to also change from the "Legacy APM Server Reference" to the new Agent-based APM server docs.

Copy link
Member

Choose a reason for hiding this comment

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

Unfortunately, the goal here is just to fix the outdated {apm-server-ref-v} refs. There are improvements that could be made to all of the agent docs to better differentiate between running APM Server in standalone mode vs the APM integration, but I don't have the bandwidth to tackle those right now.

As for the API link. It looks like this was a mistake, but I'd agree that the current link is better than what I had proposed in elastic/observability-docs#1385.

@bmorelli25 bmorelli25 merged commit 6a12f7f into elastic:main Jan 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
agent-nodejs Make available for APM Agents project planning. community Team:Docs Label for the Observability docs team triage
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants