profiling: add documentation for the config file and CLI arguments #4398

florianl · 2024-10-18T10:08:45Z

Description

Extend the documentation about the format of the config file and the CLI arguments.

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

Signed-off-by: Florian Lehner <florian.lehner@elastic.co>

github-actions · 2024-10-18T10:09:00Z

A documentation preview will be available soon.

🔨 Buildkite builds
📚 HTML diff
📙 Preview page

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.}

mergify · 2024-10-18T10:09:32Z

This pull request does not have a backport label. Could you fix it @florianl? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
NOTE: backport-skip has been added to this pull request.

bmorelli25 · 2024-10-18T20:53:51Z

Thanks, @florianl! Should this go into 8.16?

florianl · 2024-10-21T05:46:16Z

Backporting to 8.16 sounds good. I have updated the labels by removing backport-skip and added backport-8.16.

docs/en/observability/profiling-advanced-configuration.asciidoc

docs/en/observability/profiling-config-file.asciidoc

docs/en/observability/profiling-envs.asciidoc

Co-authored-by: Christos Kalkanis <christos.kalkanis@elastic.co>

docs/en/observability/profiling-advanced-configuration.asciidoc

docs/en/observability/profiling-config-file.asciidoc

docs/en/observability/profiling-envs.asciidoc

Co-authored-by: Christos Kalkanis <christos.kalkanis@elastic.co>

florianl · 2024-10-28T15:37:30Z

friendly ping @elastic/obs-docs

florianl · 2024-11-05T07:47:30Z

friendly ping @elastic/obs-docs

mdbirnstiehl

Sorry for the delay. Just a couple of small things, otherwise, LGTM!

docs/en/observability/profiling-advanced-configuration.asciidoc

docs/en/observability/profiling-config-file.asciidoc

docs/en/observability/profiling-envs.asciidoc

Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com>

mdbirnstiehl

🚀

…4398) * profiling: add documentation for the config file Signed-off-by: Florian Lehner <florian.lehner@elastic.co> * Apply suggestions from code review Co-authored-by: Christos Kalkanis <christos.kalkanis@elastic.co> * Apply suggestions from code review Co-authored-by: Christos Kalkanis <christos.kalkanis@elastic.co> * Apply suggestions from code review Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com> --------- Signed-off-by: Florian Lehner <florian.lehner@elastic.co> Co-authored-by: Christos Kalkanis <christos.kalkanis@elastic.co> Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com> (cherry picked from commit e335f27) # Conflicts: # docs/en/observability/index.asciidoc # docs/en/observability/profiling-envs.asciidoc

…e and CLI arguments (#4499) * profiling: add documentation for the config file and CLI arguments (#4398) * profiling: add documentation for the config file Signed-off-by: Florian Lehner <florian.lehner@elastic.co> * Apply suggestions from code review Co-authored-by: Christos Kalkanis <christos.kalkanis@elastic.co> * Apply suggestions from code review Co-authored-by: Christos Kalkanis <christos.kalkanis@elastic.co> * Apply suggestions from code review Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com> --------- Signed-off-by: Florian Lehner <florian.lehner@elastic.co> Co-authored-by: Christos Kalkanis <christos.kalkanis@elastic.co> Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com> (cherry picked from commit e335f27) # Conflicts: # docs/en/observability/index.asciidoc # docs/en/observability/profiling-envs.asciidoc * Update docs/en/observability/index.asciidoc --------- Co-authored-by: Florian Lehner <florianl@users.noreply.github.com> Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com>

…le and CLI arguments (#4500) * profiling: add documentation for the config file and CLI arguments (#4398) * profiling: add documentation for the config file Signed-off-by: Florian Lehner <florian.lehner@elastic.co> * Apply suggestions from code review Co-authored-by: Christos Kalkanis <christos.kalkanis@elastic.co> * Apply suggestions from code review Co-authored-by: Christos Kalkanis <christos.kalkanis@elastic.co> * Apply suggestions from code review Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com> --------- Signed-off-by: Florian Lehner <florian.lehner@elastic.co> Co-authored-by: Christos Kalkanis <christos.kalkanis@elastic.co> Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com> (cherry picked from commit e335f27) # Conflicts: # docs/en/observability/index.asciidoc # docs/en/observability/profiling-envs.asciidoc * Update docs/en/observability/index.asciidoc --------- Co-authored-by: Florian Lehner <florianl@users.noreply.github.com> Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com>

profiling: add documentation for the config file

f39c31a

Signed-off-by: Florian Lehner <florian.lehner@elastic.co>

florianl requested a review from christos68k October 18, 2024 10:08

florianl requested a review from a team as a code owner October 18, 2024 10:08

florianl mentioned this pull request Oct 16, 2024

[Request]: Universal Profiling pf-host-agent - Document CLI params and configuration files without the need of accessing Kibana #4360

Closed

4 tasks

docs-project-automation bot added the needs-writer-review label Oct 18, 2024

mergify bot added the backport-skip Skip notification from the automated backport with mergify label Oct 18, 2024

florianl added backport-8.16 Automated backport with mergify and removed backport-skip Skip notification from the automated backport with mergify labels Oct 21, 2024

christos68k reviewed Oct 21, 2024

View reviewed changes

docs/en/observability/profiling-advanced-configuration.asciidoc Outdated Show resolved Hide resolved

docs/en/observability/profiling-config-file.asciidoc Outdated Show resolved Hide resolved

docs/en/observability/profiling-envs.asciidoc Outdated Show resolved Hide resolved

Apply suggestions from code review

f2f3975

Co-authored-by: Christos Kalkanis <christos.kalkanis@elastic.co>

florianl requested a review from christos68k October 23, 2024 06:38

christos68k reviewed Oct 23, 2024

View reviewed changes

Apply suggestions from code review

0c3b63d

Co-authored-by: Christos Kalkanis <christos.kalkanis@elastic.co>

christos68k previously approved these changes Oct 23, 2024

View reviewed changes

florianl added the backport-8.x Automated backport to the 8.x branch with mergify label Oct 23, 2024

bmorelli25 requested a review from mdbirnstiehl October 30, 2024 23:39

mdbirnstiehl previously approved these changes Nov 6, 2024

View reviewed changes

Apply suggestions from code review

c40a071

Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com>

florianl dismissed stale reviews from mdbirnstiehl and christos68k via c40a071 November 7, 2024 12:35

florianl enabled auto-merge (squash) November 7, 2024 12:35

florianl requested review from mdbirnstiehl and christos68k November 7, 2024 12:35

mdbirnstiehl approved these changes Nov 7, 2024

View reviewed changes

florianl merged commit e335f27 into main Nov 7, 2024
5 checks passed

florianl deleted the profiling-config-file branch November 7, 2024 14:05

This was referenced Nov 7, 2024

[8.x](backport #4398) profiling: add documentation for the config file and CLI arguments #4499

Merged

[8.16](backport #4398) profiling: add documentation for the config file and CLI arguments #4500

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

profiling: add documentation for the config file and CLI arguments #4398

profiling: add documentation for the config file and CLI arguments #4398

florianl commented Oct 18, 2024

github-actions bot commented Oct 18, 2024

mergify bot commented Oct 18, 2024

bmorelli25 commented Oct 18, 2024

florianl commented Oct 21, 2024

florianl commented Oct 28, 2024

florianl commented Nov 5, 2024

mdbirnstiehl left a comment

mdbirnstiehl left a comment

profiling: add documentation for the config file and CLI arguments #4398

profiling: add documentation for the config file and CLI arguments #4398

Conversation

florianl commented Oct 18, 2024

Description

Documentation sets edited in this PR

github-actions bot commented Oct 18, 2024

mergify bot commented Oct 18, 2024

bmorelli25 commented Oct 18, 2024

florianl commented Oct 21, 2024

florianl commented Oct 28, 2024

florianl commented Nov 5, 2024

mdbirnstiehl left a comment

Choose a reason for hiding this comment

mdbirnstiehl left a comment

Choose a reason for hiding this comment