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

[Logs] Soft deprecate legacy internal endpoints #200968

Closed
tonyghiani opened this issue Nov 20, 2024 · 1 comment · Fixed by #201974
Closed

[Logs] Soft deprecate legacy internal endpoints #200968

tonyghiani opened this issue Nov 20, 2024 · 1 comment · Fixed by #201974
Assignees
@tonyghiani
Labels
Team:obs-ux-logs Observability Logs User Experience Team

Comments

@tonyghiani
Copy link
Contributor

📓 Summary

There are logs internal API endpoints that won't be used anymore with the deprecation of Logs Stream.
Although they don't directly impact the end user, it is worth to internally flag them as deprecated so that they won't be used anymore for internal features.

✔ Acceptance criteria

  • The following HTTP APIs are all used for the Logs Stream application to work, which we are deprecating, hence we can soft deprecate these APIs as well with comments or the available deprecation APIs.
    • GET /api/infra/log_views/{logViewId}
    • PUT /api/infra/log_views/{logViewId}
    • POST /api/log_entries/highlights
    • POST /api/log_entries/summary
    • POST /api/log_entries/summary_highlights
  • The log entries search strategy won't be used anymore and its registration can be soft-deprecated commenting on the registration step here.
@tonyghiani tonyghiani added the Team:obs-ux-logs Observability Logs User Experience Team label Nov 20, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-logs-team (Team:obs-ux-logs)

@tonyghiani tonyghiani mentioned this issue Nov 27, 2024
Merged
@tonyghiani tonyghiani self-assigned this Nov 27, 2024
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Dec 11, 2024
@tonyghiani
[Logs] Deprecate HTTP APIs used in LogStream app (elastic#201974)
068f6c3 
## 📓 Summary

Closes elastic#200968

These changes deprecate internal APIs used by the LogStream app, which
is also deprecated.

With v9, any internal API will become unreachable from external origins.
In case we get an external request to these APIs (although it should be
less likely to happen), the deprecation will be surfaced on the Upgrade
Assistant UI as a warning.

<img width="3005" alt="Screenshot 2024-11-27 at 13 16 39"
src="https://github.com/user-attachments/assets/c3864a5a-49c7-4cbd-8893-9041b5ee207e">

<img width="3007" alt="Screenshot 2024-11-27 at 13 16 25"
src="https://github.com/user-attachments/assets/f9fb254f-b795-4d01-8d92-463a0ca526a3">

Co-authored-by: Marco Antonio Ghiani <[email protected]>
(cherry picked from commit a176c0f)
kibanamachine added a commit that referenced this issue Dec 11, 2024
@kibanamachine @tonyghiani
[8.x] [Logs] Deprecate HTTP APIs used in LogStream app (#201974) (#20…
6354217 
…3748)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Logs] Deprecate HTTP APIs used in LogStream app
(#201974)](#201974)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Marco Antonio
Ghiani","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-12-11T10:41:28Z","message":"[Logs]
Deprecate HTTP APIs used in LogStream app (#201974)\n\n## 📓
Summary\r\n\r\nCloses #200968 \r\n\r\nThese changes deprecate internal
APIs used by the LogStream app, which\r\nis also deprecated.\r\n\r\nWith
v9, any internal API will become unreachable from external
origins.\r\nIn case we get an external request to these APIs (although
it should be\r\nless likely to happen), the deprecation will be surfaced
on the Upgrade\r\nAssistant UI as a warning.\r\n\r\n<img width=\"3005\"
alt=\"Screenshot 2024-11-27 at 13 16
39\"\r\nsrc=\"https://github.com/user-attachments/assets/c3864a5a-49c7-4cbd-8893-9041b5ee207e\">\r\n\r\n<img
width=\"3007\" alt=\"Screenshot 2024-11-27 at 13 16
25\"\r\nsrc=\"https://github.com/user-attachments/assets/f9fb254f-b795-4d01-8d92-463a0ca526a3\">\r\n\r\nCo-authored-by:
Marco Antonio Ghiani
<[email protected]>","sha":"a176c0fdd7815e5841ed78f5213f1296226b276e","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","backport:prev-minor","ci:project-deploy-observability","Team:obs-ux-logs"],"title":"[Logs]
Deprecate HTTP APIs used in LogStream
app","number":201974,"url":"https://github.com/elastic/kibana/pull/201974","mergeCommit":{"message":"[Logs]
Deprecate HTTP APIs used in LogStream app (#201974)\n\n## 📓
Summary\r\n\r\nCloses #200968 \r\n\r\nThese changes deprecate internal
APIs used by the LogStream app, which\r\nis also deprecated.\r\n\r\nWith
v9, any internal API will become unreachable from external
origins.\r\nIn case we get an external request to these APIs (although
it should be\r\nless likely to happen), the deprecation will be surfaced
on the Upgrade\r\nAssistant UI as a warning.\r\n\r\n<img width=\"3005\"
alt=\"Screenshot 2024-11-27 at 13 16
39\"\r\nsrc=\"https://github.com/user-attachments/assets/c3864a5a-49c7-4cbd-8893-9041b5ee207e\">\r\n\r\n<img
width=\"3007\" alt=\"Screenshot 2024-11-27 at 13 16
25\"\r\nsrc=\"https://github.com/user-attachments/assets/f9fb254f-b795-4d01-8d92-463a0ca526a3\">\r\n\r\nCo-authored-by:
Marco Antonio Ghiani
<[email protected]>","sha":"a176c0fdd7815e5841ed78f5213f1296226b276e"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/201974","number":201974,"mergeCommit":{"message":"[Logs]
Deprecate HTTP APIs used in LogStream app (#201974)\n\n## 📓
Summary\r\n\r\nCloses #200968 \r\n\r\nThese changes deprecate internal
APIs used by the LogStream app, which\r\nis also deprecated.\r\n\r\nWith
v9, any internal API will become unreachable from external
origins.\r\nIn case we get an external request to these APIs (although
it should be\r\nless likely to happen), the deprecation will be surfaced
on the Upgrade\r\nAssistant UI as a warning.\r\n\r\n<img width=\"3005\"
alt=\"Screenshot 2024-11-27 at 13 16
39\"\r\nsrc=\"https://github.com/user-attachments/assets/c3864a5a-49c7-4cbd-8893-9041b5ee207e\">\r\n\r\n<img
width=\"3007\" alt=\"Screenshot 2024-11-27 at 13 16
25\"\r\nsrc=\"https://github.com/user-attachments/assets/f9fb254f-b795-4d01-8d92-463a0ca526a3\">\r\n\r\nCo-authored-by:
Marco Antonio Ghiani
<[email protected]>","sha":"a176c0fdd7815e5841ed78f5213f1296226b276e"}}]}]
BACKPORT-->

Co-authored-by: Marco Antonio Ghiani <[email protected]>
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this issue Dec 12, 2024
@tonyghiani @CAWilson94
[Logs] Deprecate HTTP APIs used in LogStream app (elastic#201974)
03dd5c7 
## 📓 Summary

Closes elastic#200968 

These changes deprecate internal APIs used by the LogStream app, which
is also deprecated.

With v9, any internal API will become unreachable from external origins.
In case we get an external request to these APIs (although it should be
less likely to happen), the deprecation will be surfaced on the Upgrade
Assistant UI as a warning.

<img width="3005" alt="Screenshot 2024-11-27 at 13 16 39"
src="https://github.com/user-attachments/assets/c3864a5a-49c7-4cbd-8893-9041b5ee207e">

<img width="3007" alt="Screenshot 2024-11-27 at 13 16 25"
src="https://github.com/user-attachments/assets/f9fb254f-b795-4d01-8d92-463a0ca526a3">

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

@tonyghiani tonyghiani

Labels
Team:obs-ux-logs Observability Logs User Experience Team
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Logs] Deprecate HTTP APIs used in LogStream app tonyghiani/kibana
2 participants
@elasticmachine @tonyghiani