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

Document log aggregation via Loki #161

Merged
merged 4 commits into from
Aug 25, 2020
Merged

Document log aggregation via Loki #161

merged 4 commits into from
Aug 25, 2020

Conversation

BrianJKoopman
Copy link
Member

@BrianJKoopman BrianJKoopman commented Aug 10, 2020

Description

This PR adds a page in the docs describing the installation and setup of Loki, a log aggregation system made by Grafana Labs. It has nice integration with Grafana and allows viewing realtime logs in the Explore menu and configuring "Logs" visualizations in Dashboard panels.

image

Motivation and Context

Log visibility can often be cumbersome, especially on multi-node systems. This allows log aggregation across nodes in a centralized location and provides an easy viewing alternative to running docker logs -f <container> on each container you want to view the logs for.

How Has This Been Tested?

I have tested the configuration example in an isolated VM. I'm waiting to setup on the Yale system for our cooldown to be completed (tomorrow), since this requires remaking each container you want to forward logs.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • Unless I am preparing a release, I have opened this PR onto the develop branch.

@jlashner
Copy link
Collaborator

Just tested this on the UCSD system and documentation worked pretty much flawlessly. One thing to maybe make a note about is that if you try to look at logs through docker-compose, you will get an error that looks like this:

ocs-aggregator_1         | WARNING: no logs are available with the 'loki' log driver

even though the container might be running successfully. You can still view logs with docker logs just not docker-compose logs for some reason, not that this will affect very many people... Thanks Brian!

@BrianJKoopman
Copy link
Member Author

Great, thanks for the feedback! It's strange to me that they're still available to simple docker logs, but not docker-compose logs. Anyway, I added a small note about the availability of logs in these systems. Will merge once checks are completed.

@BrianJKoopman BrianJKoopman merged commit 4737180 into develop Aug 25, 2020
@BrianJKoopman BrianJKoopman deleted the loki branch August 25, 2020 13:57
@BrianJKoopman BrianJKoopman mentioned this pull request Oct 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants