Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Docs: revise getting started guide#5939

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
slim-bean merged 12 commits intografana:mainfromKMiller-Grafana:docs/getting-started
Apr 28, 2022

Conversation

KMiller-Grafana
Copy link
Contributor

@KMiller-GrafanaKMiller-Grafana commentedApr 15, 2022•
edited
Loading

Compose a single getting started guide (instead of a section with unrelated content). Base it on the SSD Docker installation instructions.

Move unrelated content elsewhere in the doc set. Introduce appropriate aliases (metadata) for the moved content.

Use flog to do log-generation.
Make sure it is obvious that this test environment is not for a production environment.
Move the configuration that goes with this guide into a new Loki/examples directory. (Leave other example material in the/production directory to be updated and/or moved in a different PR.)

To test using the new getting started guide, copy the 3 configuration files fromthis PR's/examples directory. The directions in the prose can't work until after this PR is merged in, as this PR creates the/examples directory.

Copy link
Contributor

@gguillotte-grafanagguillotte-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've hit a wall at the final part, running the{job="flog"} query in Grafana. Everything appears to be working as far as I can tell, but the query returns nothing.

@KMiller-GrafanaKMiller-Grafana marked this pull request as ready for reviewApril 27, 2022 18:09
@KMiller-GrafanaKMiller-Grafana requested a review froma team as acode ownerApril 27, 2022 18:09
Copy link
Contributor

@gguillotte-grafanagguillotte-grafana left a comment

Choose a reason for hiding this comment

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

The revised steps simplify the setup process and work! Thanks,@KMiller-Grafana!

docker-compose down
```
## Modifying the flog app output
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmmm I think this subsection seems out-of-place/looks unnecessary. WDYT?

Copy link
ContributorAuthor

@KMiller-GrafanaKMiller-GrafanaApr 27, 2022•
edited
Loading

Choose a reason for hiding this comment

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

Let's see what others say in their reviews. I wanted this effort to be a guide, not a tutorial. Part of making a guide is providing paths for extending what is given to what is useful for the readers.

I envision adding another section (in the future, when time allows) which shows how to run Promtail and the app outside of Docker containers. This would promote understanding of how to set up Promtail configuration.

So, in the future, I think there will be other sections that we might classify as extending the test environment to further evaluate Loki. I think that we might even use this setup (maybe replace flog with another app?) to be used as a LogQL query-writing practice area.

DylanGuedes reacted with thumbs up emoji
@DylanGuedes
Copy link
Contributor

added a few nits but overall LGTM!

Copy link
Contributor

@ssncferreirassncferreira left a comment

Choose a reason for hiding this comment

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

LGTM 🏆
Thank you for this! It is written in a very clear and easy to follow along manner 🙏
Just some small suggestions

Copy link
Collaborator

@slim-beanslim-bean left a comment

Choose a reason for hiding this comment

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

LGTM!

@slim-beanslim-bean added the backport release-2.5.xTag a PR with this label to create a PR which cherry pics it into the release-2.5.x branch labelApr 28, 2022
@slim-beanslim-bean merged commitc4ebfd3 intografana:mainApr 28, 2022
grafanabot pushed a commit that referenced this pull requestApr 28, 2022
* Revise the getting started section* Docs: revise getting started guide* Intermediate commit of getting started material.* Intermediate revision of the getting started guide.    Add instructions to download, configure, and deploy the test environment.* Add sample queries and instructions for breaking down the test env* Revise prose using reviewer comments.* update to use promtail and flog in the docker compose fileSigned-off-by: Edward Welch <edward.welch@grafana.com>* Revise guide to put all parts into Docker containers.* Add README files for examples directory. Revise getting started instructions.* Address DylanGuedes review comments* Getting started guide: incorporate suggestions from ssncferreiraCo-authored-by: Edward Welch <edward.welch@grafana.com>(cherry picked from commitc4ebfd3)
slim-bean pushed a commit that referenced this pull requestApr 28, 2022
* Revise the getting started section* Docs: revise getting started guide* Intermediate commit of getting started material.* Intermediate revision of the getting started guide.    Add instructions to download, configure, and deploy the test environment.* Add sample queries and instructions for breaking down the test env* Revise prose using reviewer comments.* update to use promtail and flog in the docker compose fileSigned-off-by: Edward Welch <edward.welch@grafana.com>* Revise guide to put all parts into Docker containers.* Add README files for examples directory. Revise getting started instructions.* Address DylanGuedes review comments* Getting started guide: incorporate suggestions from ssncferreiraCo-authored-by: Edward Welch <edward.welch@grafana.com>(cherry picked from commitc4ebfd3)Co-authored-by: Karen Miller <84039272+KMiller-Grafana@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@DylanGuedesDylanGuedesDylanGuedes approved these changes

@slim-beanslim-beanslim-bean approved these changes

+2 more reviewers

@ssncferreirassncferreirassncferreira approved these changes

@gguillotte-grafanagguillotte-grafanagguillotte-grafana approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

backport release-2.5.xTag a PR with this label to create a PR which cherry pics it into the release-2.5.x branchsize/L

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@KMiller-Grafana@DylanGuedes@ssncferreira@slim-bean@gguillotte-grafana
[8]ページ先頭
©2009-2025 Movatter.jp