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] Prefix internal APM APIs with /internal/ #113383

Closed
sorenlouv opened this issue Sep 29, 2021 · 3 comments · Fixed by #114196
Closed

[APM] Prefix internal APM APIs with /internal/ #113383

sorenlouv opened this issue Sep 29, 2021 · 3 comments · Fixed by #114196
Assignees
@smith
Labels
good first issue low hanging fruit Team:APM All issues that need APM UI Team support technical debt Improvement of the software architecture and operational architecture

Comments

@sorenlouv
Copy link
Member

sorenlouv commented Sep 29, 2021 •
edited
Loading

All APM apis with very few exceptions should be marked as internal. We can do that easily by prefxing a route with /internal/. APM apis are defined in: x-pack/plugins/apm/server/routes

Public APIs:

Additional context: https://docs.google.com/document/d/1v4R9hWiQObP8sERfflGScC9Yp36fLE0wVlUNf13mVrc/edit#heading=h.2b1v1tr0ep8m
@sorenlouv sorenlouv added [zube]: Inbox Team:APM All issues that need APM UI Team support technical debt Improvement of the software architecture and operational architecture labels Sep 29, 2021
@sorenlouv sorenlouv mentioned this issue Sep 29, 2021
Merged
@smith
Copy link
Contributor

smith commented Sep 29, 2021

Is this a duplicate of #112273?

@sorenlouv sorenlouv mentioned this issue Sep 29, 2021
Closed
@teezzan
Copy link

teezzan commented Oct 2, 2021 •
edited
Loading

Can I hop on this? @sqren And is there anything else to note before attempting to fix this? Thanks

This is my first issue 😃

@smith smith self-assigned this Oct 6, 2021
@smith smith mentioned this issue Oct 7, 2021
Merged
@smith
Copy link
Contributor

smith commented Oct 7, 2021

@teezzan I've got a draft PR (#114196) up that fixes this. Sorry I didn't see your comment earlier. There's a bunch of good first APM UI issues we would love help with, and I would be happy to pair with you or provide any assistance on any of them.

smith added a commit that referenced this issue Oct 8, 2021
@smith
Relocate internal APM API endpoints to /internal (#114196)
02822a6 
All endpoints except annotations, source maps, and agent configuration are now at /internal/apm instead of /api/apm.

None of the UX endpoints have been updated, only APM.

If you search for "/api/apm" in the codebase, you should only see the above endpoints.

Fixes #113383.
smith added a commit to smith/kibana that referenced this issue Oct 11, 2021
@smith
Relocate internal APM API endpoints to /internal (elastic#114196)
ec75715 
All endpoints except annotations, source maps, and agent configuration are now at /internal/apm instead of /api/apm.

None of the UX endpoints have been updated, only APM.

If you search for "/api/apm" in the codebase, you should only see the above endpoints.

Fixes elastic#113383.
# Conflicts:
#	x-pack/plugins/apm/public/components/shared/MetadataTable/ErrorMetadata/index.tsx
#	x-pack/plugins/apm/public/components/shared/MetadataTable/SpanMetadata/index.tsx
#	x-pack/plugins/apm/public/components/shared/MetadataTable/TransactionMetadata/index.tsx
#	x-pack/plugins/apm/server/routes/event_metadata.ts
#	x-pack/test/apm_api_integration/tests/metadata/event_metadata.ts
#	x-pack/test/apm_api_integration/tests/services/throughput.ts
smith added a commit that referenced this issue Oct 11, 2021
@smith
Relocate internal APM API endpoints to /internal (#114196) (#114494)
f6e4f1b 
All endpoints except annotations, source maps, and agent configuration are now at /internal/apm instead of /api/apm.

None of the UX endpoints have been updated, only APM.

If you search for "/api/apm" in the codebase, you should only see the above endpoints.

Fixes #113383.
# Conflicts:
#	x-pack/plugins/apm/public/components/shared/MetadataTable/ErrorMetadata/index.tsx
#	x-pack/plugins/apm/public/components/shared/MetadataTable/SpanMetadata/index.tsx
#	x-pack/plugins/apm/public/components/shared/MetadataTable/TransactionMetadata/index.tsx
#	x-pack/plugins/apm/server/routes/event_metadata.ts
#	x-pack/test/apm_api_integration/tests/metadata/event_metadata.ts
#	x-pack/test/apm_api_integration/tests/services/throughput.ts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@smith smith

Labels
good first issue low hanging fruit Team:APM All issues that need APM UI Team support technical debt Improvement of the software architecture and operational architecture
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Relocate internal APM API endpoints to /internal smith/kibana
4 participants
@smith @dannycroft @sorenlouv @teezzan