Skip to content

Conversation

inge4pres
Copy link
Contributor

Paired with elastic/kibana#234065, adjust the documentation for the new public API to setup Profiling in 9.2+

Paired with elastic/kibana#234065, adjust the documentation for the new public API to setup Profiling in 9.2+
Copy link

github-actions bot commented Sep 9, 2025

@inge4pres inge4pres marked this pull request as ready for review September 18, 2025 14:38
@inge4pres inge4pres requested a review from a team as a code owner September 18, 2025 14:38
Copy link
Contributor

@florent-leborgne florent-leborgne left a 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"
```
:::

::::

And will look like this in the docs:
image

@inge4pres
Copy link
Contributor Author

inge4pres commented Sep 18, 2025

I'd propose to use tabs to distinguish between both versions of the path

Thanks for the suggestion @florent-leborgne it's great 🙏🏼
There's a caveat though: 9.0 and 9.1 cannot work with the internal endpoint - Kibana blocks it.
There is an unfortunate series of events that brought us here, but basically programmatic setup for Universal Profiling as documented only works for 9.2+ with the fix just merged in Kibana.

What's the best way to express this?
Should we add a section about this in the known issues?

@florent-leborgne
Copy link
Contributor

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 ### Programmatic configuration [profiling-configure-data-ingestion-programmatic]:

```{applies_to}
stack: ga 9.2
```

This will add a badge to the section indicating that what's described there is only possible from 9.2.

@inge4pres
Copy link
Contributor Author

add the following the line right after ### Programmatic configuration [profiling-configure-data-ingestion-programmatic]

trying, thanks 🙏🏼

Added a note about stack compatibility for Universal Profiling.
@inge4pres
Copy link
Contributor Author

trying, thanks 🙏🏼

Apparently the commit I added broke CI? @florent-leborgne did I mess it up?

Copy link
Contributor

@florent-leborgne florent-leborgne left a 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 :)

@inge4pres
Copy link
Contributor Author

That's the other way around

Thanks 🙏🏼

Copy link
Contributor

@florent-leborgne florent-leborgne left a 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!!

@florent-leborgne florent-leborgne enabled auto-merge (squash) September 19, 2025 08:15
@florent-leborgne florent-leborgne merged commit 1db4543 into main Sep 19, 2025
6 of 7 checks passed
@florent-leborgne florent-leborgne deleted the inge4pres-patch-1 branch September 19, 2025 08:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants