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.

Sign up for GitHub

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

Jump to bottom

[apm] Clarify how to create/use API keys #4670

Merged
merged 5 commits into from
Jan 3, 2025
Merged

[apm] Clarify how to create/use API keys #4670

merged 5 commits into from
Jan 3, 2025
+43 −16

Conversation

colleenmcginnis
Copy link
Contributor

Description

Fixes inconsistencies in how we talk about API keys for APM Server usage.

Documentation sets edited in this PR

Check all that apply.

  • Stateful (docs/en/observability/*)
  • Serverless (docs/en/serverless/*)
  • Integrations Developer Guide (docs/en/integrations/*)
  • None of the above

Related issue

Closes #4312

Checklist

  • Product/Engineering Review
  • Writer Review

Follow-up tasks

Select one.

  • This PR does not need to be ported to another doc set because:
    • The concepts in this PR only apply to one doc set (serverless or stateful)
    • The PR contains edits to both doc sets (serverless and stateful)
  • This PR needs to be ported to another doc set:
    • Port to stateful docs: <link to PR or tracking issue>
    • Port to serverless docs: <link to PR or tracking issue>

@colleenmcginnis colleenmcginnis added backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify labels Dec 11, 2024
@colleenmcginnis colleenmcginnis self-assigned this Dec 11, 2024
@github-actions GitHub Actions
Copy link
Contributor

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@colleenmcginnis colleenmcginnis marked this pull request as ready for review December 11, 2024 21:08
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner December 11, 2024 21:08
eedugon
eedugon previously approved these changes Dec 12, 2024
View reviewed changes
Copy link
Contributor

@eedugon eedugon left a comment

Choose a reason for hiding this comment

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

I just found a couple of issues, shared as comments.
Looks great!

docs/en/observability/apm/configure/agent-config.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/security/elastic-stack/access-api-keys.asciidoc Outdated Show resolved Hide resolved
@eedugon

This comment was marked as off-topic.

Sign in to view
@colleenmcginnis @eedugon
apply suggestions from code review
aa8f9e4 
Co-authored-by: Edu González de la Herrán <[email protected]>
bmorelli25
bmorelli25 previously approved these changes Dec 18, 2024
View reviewed changes
endorama
endorama previously approved these changes Dec 27, 2024
View reviewed changes
Copy link
Member

@endorama endorama left a comment

Choose a reason for hiding this comment

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

I wasn't able to confirm the changes from the preview, but the diff content looks good to me. Thank you for addressing this!

eedugon
eedugon previously approved these changes Jan 2, 2025
View reviewed changes
@colleenmcginnis colleenmcginnis mentioned this pull request Jan 2, 2025
Closed
colleenmcginnis
colleenmcginnis commented Jan 2, 2025
View reviewed changes
Copy link
Contributor Author

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

My fresh 2025 brain caught one typo.

docs/en/observability/apm/configure/agent-config.asciidoc Outdated Show resolved Hide resolved
@colleenmcginnis colleenmcginnis dismissed stale reviews from eedugon, endorama, and bmorelli25 via e890cb8 January 2, 2025 18:43
bmorelli25
bmorelli25 previously approved these changes Jan 2, 2025
View reviewed changes
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.

2025 🧠

@mergify Mergify
Copy link
Contributor

mergify bot commented Jan 3, 2025

This pull request is now in conflict. Could you fix it @colleenmcginnis? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b issue-4312 upstream/issue-4312
git merge upstream/main
git push upstream issue-4312

@colleenmcginnis
Copy link
Contributor Author

Welp. Merging #4728 created a conflict so I need one more ✅ , @bmorelli25. 🙏

@colleenmcginnis colleenmcginnis merged commit 0fee5c3 into elastic:main Jan 3, 2025
4 checks passed
@colleenmcginnis colleenmcginnis deleted the issue-4312 branch January 3, 2025 16:27
mergify bot pushed a commit that referenced this pull request Jan 3, 2025
@colleenmcginnis @mergify
[apm] Clarify how to create/use API keys (#4670)
e785f35 
* add information on beats api key

* add section to common problems section of the apm config page

* apply suggestions from code review

Co-authored-by: Edu González de la Herrán <[email protected]>

* fix typp

---------

Co-authored-by: Edu González de la Herrán <[email protected]>
(cherry picked from commit 0fee5c3)
mergify bot pushed a commit that referenced this pull request Jan 3, 2025
@colleenmcginnis @mergify
[apm] Clarify how to create/use API keys (#4670)
fc41ff6 
* add information on beats api key

* add section to common problems section of the apm config page

* apply suggestions from code review

Co-authored-by: Edu González de la Herrán <[email protected]>

* fix typp

---------

Co-authored-by: Edu González de la Herrán <[email protected]>
(cherry picked from commit 0fee5c3)
mergify bot pushed a commit that referenced this pull request Jan 3, 2025
@colleenmcginnis @mergify
[apm] Clarify how to create/use API keys (#4670)
4e32aa3 
* add information on beats api key

* add section to common problems section of the apm config page

* apply suggestions from code review

Co-authored-by: Edu González de la Herrán <[email protected]>

* fix typp

---------

Co-authored-by: Edu González de la Herrán <[email protected]>
(cherry picked from commit 0fee5c3)
This was referenced Jan 3, 2025
Merged
Merged
Merged
colleenmcginnis added a commit that referenced this pull request Jan 3, 2025
@mergify @colleenmcginnis
[apm] Clarify how to create/use API keys (#4670) (#4741)
e9d081b 
* add information on beats api key

* add section to common problems section of the apm config page

* apply suggestions from code review

Co-authored-by: Edu González de la Herrán <[email protected]>

* fix typp

---------

Co-authored-by: Edu González de la Herrán <[email protected]>
(cherry picked from commit 0fee5c3)

Co-authored-by: Colleen McGinnis <[email protected]>
colleenmcginnis added a commit that referenced this pull request Jan 3, 2025
@mergify @colleenmcginnis
[apm] Clarify how to create/use API keys (#4670) (#4739)
9f9461e 
* add information on beats api key

* add section to common problems section of the apm config page

* apply suggestions from code review

Co-authored-by: Edu González de la Herrán <[email protected]>

* fix typp

---------

Co-authored-by: Edu González de la Herrán <[email protected]>
(cherry picked from commit 0fee5c3)

Co-authored-by: Colleen McGinnis <[email protected]>
colleenmcginnis added a commit that referenced this pull request Jan 3, 2025
@mergify @colleenmcginnis
[apm] Clarify how to create/use API keys (#4670) (#4740)
829181c 
* add information on beats api key

* add section to common problems section of the apm config page

* apply suggestions from code review

Co-authored-by: Edu González de la Herrán <[email protected]>

* fix typp

---------

Co-authored-by: Edu González de la Herrán <[email protected]>
(cherry picked from commit 0fee5c3)

Co-authored-by: Colleen McGinnis <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bmorelli25 bmorelli25 bmorelli25 approved these changes

@eedugon eedugon eedugon left review comments

@endorama endorama Awaiting requested review from endorama

Assignees

@colleenmcginnis colleenmcginnis

Labels
backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify needs-dev-review needs-writer-review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Request]: inconsistencies in API Key description for APM Server usage
4 participants
@colleenmcginnis @eedugon @endorama @bmorelli25