-
Notifications
You must be signed in to change notification settings - Fork 156
Update API endpoint for profiling setup commands #2865
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
Conversation
Paired with elastic/kibana#234065, adjust the documentation for the new public API to setup Profiling in 9.2+
🔍 Preview links for changed docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @inge4pres. The change itself LGTM, but these docs must also stay accurate for 9.0 and 9.1 users.
I'd propose to use tabs to distinguish between both versions of the path (one for 9.0+9.1, the other for 9.2 and beyond) This could look like this:
To configure data ingestion from the console, go to **Dev Tools** in the navigation menu and run the following command:
::::{tab-set}
:group: versions
:::{tab-item} 9.2+
:sync: 9.2
{applies_to}`stack: ga 9.2`
```console
POST kbn:/api/profiling/setup/es_resources
{}
```
:::
:::{tab-item} 9.0 to 9.1
:sync: 9.0
{applies_to}`stack: ga 9.0`
```console
POST kbn:/internal/profiling/setup/es_resources
{}
```
:::
::::
To configure data ingestion programmatically using a standalone HTTP client (e.g., `curl`), run the following command:
::::{tab-set}
:group: versions
:::{tab-item} 9.2+
:sync: 9.2
{applies_to}`stack: ga 9.2`
```console
curl -u elastic:<PASSWORD> -H "kbn-xsrf: true" -H "Content-Type: application/json" \
--data "{}" "https://<kibana-host>:<kibana-port>/api/profiling/setup/es_resources"
```
:::
:::{tab-item} 9.0 to 9.1
:sync: 9.0
{applies_to}`stack: ga 9.0`
```console
curl -u elastic:<PASSWORD> -H "kbn-xsrf: true" -H "Content-Type: application/json" \
--data "{}" "https://<kibana-host>:<kibana-port>/internal/profiling/setup/es_resources"
```
:::
::::
Thanks for the suggestion @florent-leborgne it's great 🙏🏼 What's the best way to express this? |
Ah, then I think we're in a much simpler case, you can forget about my initial suggestion and instead add the following the line right after
This will add a badge to the section indicating that what's described there is only possible from 9.2. |
trying, thanks 🙏🏼 |
Added a note about stack compatibility for Universal Profiling.
Apparently the commit I added broke CI? @florent-leborgne did I mess it up? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's the other way around, this should make the CI happier :)
solutions/observability/infra-and-hosts/get-started-with-universal-profiling.md
Outdated
Show resolved
Hide resolved
…rsal-profiling.md
Thanks 🙏🏼 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perfect! Thank you @inge4pres!!
Paired with elastic/kibana#234065, adjust the documentation for the new public API to setup Profiling in 9.2+