Docs: revise getting started guide #5939
Conversation
Add instructions to download, configure, and deploy the test environment.
Signed-off-by: Edward Welch <edward.welch@grafana.com>
There was a problem hiding this comment.
The revised steps simplify the setup process and work! Thanks, @KMiller-Grafana!
| docker-compose down | ||
| ``` | ||
|
|
||
| ## Modifying the flog app output |
There was a problem hiding this comment.
Hmmm I think this subsection seems out-of-place/looks unnecessary. WDYT?
There was a problem hiding this comment.
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.
|
added a few nits but overall LGTM! |
slim-bean
added
the
backport release-2.5.x
* 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 file
Signed-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 ssncferreira
Co-authored-by: Edward Welch <edward.welch@grafana.com>
(cherry picked from commit c4ebfd3)
* 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 file
Signed-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 ssncferreira
Co-authored-by: Edward Welch <edward.welch@grafana.com>
(cherry picked from commit c4ebfd3)
Co-authored-by: Karen Miller <84039272+KMiller-Grafana@users.noreply.github.com>
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
/examplesdirectory. (Leave other example material in the/productiondirectory to be updated and/or moved in a different PR.)To test using the new getting started guide, copy the 3 configuration files from this PR's
/examplesdirectory. The directions in the prose can't work until after this PR is merged in, as this PR creates the/examplesdirectory.