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.

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

Create "Ingest and analyze profile data" section in docs #2828

Merged
merged 5 commits into from
Dec 12, 2023

Conversation

aleks-p
Copy link
Contributor

@aleks-p aleks-p commented Dec 11, 2023

Changes:

  1. Reorder top level items
  2. Add a new top level item "Ingest and analyze profile data"
  3. Move "profiling types", "analyzing profiles" and "profile cli" to the new section
  4. Minor improvement to the profile CLI docs

Screenshot 2023-12-11 at 16 12 11

@aleks-p aleks-p requested review from a team as code owners December 11, 2023 20:13
--profile-type=memory:inuse_space:bytes:space:bytes
--query='{service_name="my_application_name"}' \
Copy link
Contributor

Choose a reason for hiding this comment

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

can we explicitly write out the defaults so that people copy-pasting are aware of how and what format to change the time frame for something like this ?

Copy link
Contributor

Choose a reason for hiding this comment

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

also is this really "merging" or just querying?

for example if I query data from 12:00 to 12:45 and I merge data from 12:00-12:45 isn't that the same thing?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

can we explicitly write out the defaults so that people copy-pasting are aware of how and what format to change the time frame for something like this ?

Done!

also is this really "merging" or just querying?

for example if I query data from 12:00 to 12:45 and I merge data from 12:00-12:45 isn't that the same thing?

We call it "merge" throughout the codebase because we are (potentially) merging data from multiple profiles into one. I agree that it is a confusing word, merge is often used for mutating operations (e.g., git merge).

I don't think we can call it just query here since we have two subcommands (merge and series) but we could call it query profile potentially (with the risk of confusion about whether it returns data from one or more profiles). I'll leave it as it is for now though to avoid a breaking change at this time.

Copy link
Contributor

@knylander-grafana knylander-grafana left a comment

Choose a reason for hiding this comment

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

I did some minor updates to this content--mostly just fixing headings and some formatting. Let's get this approved so we can work on the introductory material. Some o f the content on Analyze profiles will move to the introduction content.

@knylander-grafana knylander-grafana self-assigned this Dec 12, 2023
@knylander-grafana knylander-grafana added the type/docs Improvements for doc docs. Used by Docs team for project management label Dec 12, 2023
@aleks-p aleks-p merged commit 3f6c051 into main Dec 12, 2023
19 checks passed
@aleks-p aleks-p deleted the docs/profile-cli branch December 12, 2023 12:35
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements for doc docs. Used by Docs team for project management
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants