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

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

Merged
merged 4 commits into from
Nov 7, 2024
Merged

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

merged 4 commits into from
Nov 7, 2024

Conversation

florianl
Copy link
Member

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

@florianl florianl requested a review from a team as a code owner October 18, 2024 10:08
@github-actions GitHub Actions
Copy link
Contributor

A documentation preview will be available soon.

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.

@florianl florianl mentioned this pull request Oct 16, 2024
Closed
4 tasks
@mergify Mergify
Copy link
Contributor

mergify bot commented Oct 18, 2024

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.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Oct 18, 2024
@bmorelli25
Copy link
Member

Thanks, @florianl! Should this go into 8.16?

@florianl 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
@florianl
Copy link
Member Author

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

@florianl @christos68k
Apply suggestions from code review
f2f3975 
Co-authored-by: Christos Kalkanis <[email protected]>
@florianl @christos68k
Apply suggestions from code review
0c3b63d 
Co-authored-by: Christos Kalkanis <[email protected]>
christos68k
christos68k previously approved these changes Oct 23, 2024
View reviewed changes
@florianl florianl added the backport-8.x Automated backport to the 8.x branch with mergify label Oct 23, 2024
@florianl
Copy link
Member Author

friendly ping @elastic/obs-docs

@florianl
Copy link
Member Author

florianl commented Nov 5, 2024

friendly ping @elastic/obs-docs

mdbirnstiehl
mdbirnstiehl previously approved these changes Nov 6, 2024
View reviewed changes
Copy link
Contributor

@mdbirnstiehl mdbirnstiehl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

docs/en/observability/profiling-advanced-configuration.asciidoc Outdated Show resolved Hide resolved
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-config-file.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/profiling-config-file.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
@florianl florianl enabled auto-merge (squash) November 7, 2024 12:35
mdbirnstiehl
mdbirnstiehl approved these changes Nov 7, 2024
View reviewed changes
Copy link
Contributor

@mdbirnstiehl mdbirnstiehl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@florianl florianl merged commit e335f27 into main Nov 7, 2024
5 checks passed
@florianl florianl deleted the profiling-config-file branch November 7, 2024 14:05
mergify bot pushed a commit that referenced this pull request Nov 7, 2024
@florianl @mergify
profiling: add documentation for the config file and CLI arguments (#…
99bfbf8 
…4398)

* profiling: add documentation for the config file

Signed-off-by: Florian Lehner <[email protected]>

* Apply suggestions from code review

Co-authored-by: Christos Kalkanis <[email protected]>

* Apply suggestions from code review

Co-authored-by: Christos Kalkanis <[email protected]>

* Apply suggestions from code review

Co-authored-by: Mike Birnstiehl <[email protected]>

---------

Signed-off-by: Florian Lehner <[email protected]>
Co-authored-by: Christos Kalkanis <[email protected]>
Co-authored-by: Mike Birnstiehl <[email protected]>
(cherry picked from commit e335f27)

# Conflicts:
#	docs/en/observability/index.asciidoc
#	docs/en/observability/profiling-envs.asciidoc
mergify bot pushed a commit that referenced this pull request Nov 7, 2024
@florianl @mergify
profiling: add documentation for the config file and CLI arguments (#…
827adec 
…4398)

* profiling: add documentation for the config file

Signed-off-by: Florian Lehner <[email protected]>

* Apply suggestions from code review

Co-authored-by: Christos Kalkanis <[email protected]>

* Apply suggestions from code review

Co-authored-by: Christos Kalkanis <[email protected]>

* Apply suggestions from code review

Co-authored-by: Mike Birnstiehl <[email protected]>

---------

Signed-off-by: Florian Lehner <[email protected]>
Co-authored-by: Christos Kalkanis <[email protected]>
Co-authored-by: Mike Birnstiehl <[email protected]>
(cherry picked from commit e335f27)

# Conflicts:
#	docs/en/observability/index.asciidoc
#	docs/en/observability/profiling-envs.asciidoc
This was referenced Nov 7, 2024
Merged
Merged
mdbirnstiehl added a commit that referenced this pull request Nov 7, 2024
@mergify @florianl @mdbirnstiehl
[8.x](backport #4398) profiling: add documentation for the config fil…
553e9d7 
…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 <[email protected]>

* Apply suggestions from code review

Co-authored-by: Christos Kalkanis <[email protected]>

* Apply suggestions from code review

Co-authored-by: Christos Kalkanis <[email protected]>

* Apply suggestions from code review

Co-authored-by: Mike Birnstiehl <[email protected]>

---------

Signed-off-by: Florian Lehner <[email protected]>
Co-authored-by: Christos Kalkanis <[email protected]>
Co-authored-by: Mike Birnstiehl <[email protected]>
(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 <[email protected]>
Co-authored-by: Mike Birnstiehl <[email protected]>
mdbirnstiehl added a commit that referenced this pull request Nov 7, 2024
@mergify @florianl @mdbirnstiehl
[8.16](backport #4398) profiling: add documentation for the config fi…
f1800b9 
…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 <[email protected]>

* Apply suggestions from code review

Co-authored-by: Christos Kalkanis <[email protected]>

* Apply suggestions from code review

Co-authored-by: Christos Kalkanis <[email protected]>

* Apply suggestions from code review

Co-authored-by: Mike Birnstiehl <[email protected]>

---------

Signed-off-by: Florian Lehner <[email protected]>
Co-authored-by: Christos Kalkanis <[email protected]>
Co-authored-by: Mike Birnstiehl <[email protected]>
(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 <[email protected]>
Co-authored-by: Mike Birnstiehl <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mdbirnstiehl mdbirnstiehl mdbirnstiehl approved these changes

@christos68k christos68k Awaiting requested review from christos68k

Assignees
No one assigned
Labels
backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify needs-writer-review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@florianl @bmorelli25 @christos68k @mdbirnstiehl