Skip to content

Conversation

@Jayclifford345
Copy link
Contributor

@Jayclifford345 Jayclifford345 commented Feb 28, 2025

What this PR does / why we need it:
With the focus change to two deployment modes, Monolthic and Microservice, it was time to refresh the quick start guide to Loki. This incorporates much of the same flavour as the original:

  • Docker logs scraping
  • LogQL examples
  • Datasource setup

But includes newer features:

  • Grafana Logs Drilldown
  • Alloy Live debugging

Aswell as adding the Carnivouse Greehouse example to provide an interactive method to understanding LogQL queries.

Killercoda sample found here: https://killercoda.com/grafana-dev-testing/course/workshops/course-tracker-test

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

@Jayclifford345 Jayclifford345 requested a review from a team as a code owner February 28, 2025 10:30
@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Feb 28, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Feb 28, 2025

@Jayclifford345 Jayclifford345 requested a review from JStickler March 3, 2025 12:11
@Jayclifford345
Copy link
Contributor Author

@JStickler, for some reason, the tests keep failing on this one. We are ready for review, happy to discuss these changes on our call together as it was quite a big change to the getting started guide.

Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

Only made it through the docs before I ran out of time. I'll look at the KillerCoda tomorrow.

@Jayclifford345
Copy link
Contributor Author

Aaah thanks @JStickler! All changes are accepted, and the killercoda has been updated for your testing.

Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

Made it through both the docs/local install and the Killercoda today.

Jayclifford345 and others added 2 commits March 12, 2025 14:33
Co-authored-by: J Stickler <[email protected]>
Signed-off-by: Jay Clifford <[email protected]>
Co-authored-by: J Stickler <[email protected]>
Signed-off-by: Jay Clifford <[email protected]>
@Jayclifford345
Copy link
Contributor Author

Hey @JStickler, just accepted your amendments. Will work through the rest manually :)

Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[docs team] Something's still off, I'm getting the Explore menu instead of the new Drilldown menu. =(

@Jayclifford345
Copy link
Contributor Author

Hey @JStickler, so i think i caught all the changes you made before we moved the tutorial so hopefully I caught them all. I have also fixed the Killercoda to the right URL and updated the Grafana version which should fix the old explore UI menu to Drill down. You just might need to do a full docker compose down and then up again to see it:
https://killercoda.com/grafana-dev-testing/course/loki/loki-getting-started-tutorial

Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[docs team] I tried running through the killercoda, but it's not working. Maybe it's because the PR is so old, and we've had a new release?

@Jayclifford345
Copy link
Contributor Author

Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[docs team] Yay, finally got the docker environment fixed, and I see Drilldown Logs, not Explore Logs.

@Jayclifford345
Copy link
Contributor Author

@Jayclifford345 Jayclifford345 requested a review from JStickler May 1, 2025 10:48
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[docs team] Ran through the Killercoda today, everything looked good. I'm going to merge a few more typos I found and approve this PR. But I want to wait to merge this until the engineering team finishes backporting all the CI updates from this week. So look for this to merge late Friday or possibly Monday. Yay, we finally got this one over the finish line!

Last couple of spelling errors.

Signed-off-by: J Stickler <[email protected]>
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[docs team]

@Jayclifford345 Jayclifford345 merged commit e89fd41 into main May 2, 2025
63 checks passed
@Jayclifford345 Jayclifford345 deleted the getting-started-rewrite branch May 2, 2025 17:35
loki-gh-app bot pushed a commit that referenced this pull request May 2, 2025
Signed-off-by: Jay Clifford <[email protected]>
Signed-off-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit e89fd41)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport release-3.5.x size/XL type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants