-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
Expand documentation #261
Expand documentation #261
Conversation
davkal
commented
Jan 31, 2019
•
edited
Loading
edited
- Toplevel README
- Getting started doc
- Verify examples work
- Usage (querying)
- Contributing
- Operations
- Troubleshooting
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good so far.
README.md
Outdated
For the beginnings of documentation on how to use Loki, see [our usage docs](./docs/usage.md). [API documentation](./docs/api.md) is also available. | ||
Once you have promtail, Loki, and Grafana running, continue with [our usage docs](./docs/usage.md) on how to query your logs. | ||
|
||
### Advanced documentation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably not so "advanced"?
- Goutham Veeramachaneni's blog post "[Loki: Prometheus-inspired, open source logging for cloud natives](https://grafana.com/blog/2018/12/12/loki-prometheus-inspired-open-source-logging-for-cloud-natives/)". | ||
- David Kaltschmidt's KubeCon 2018 talk "[On the OSS Path to Full Observability with Grafana][kccna18-event]" ([slides][kccna18-slides], [video][kccna18-video]) on how Loki fits into a cloud-native environment. | ||
- Goutham Veeramachaneni's blog post "[Loki: Prometheus-inspired, open source logging for cloud natives](https://grafana.com/blog/2018/12/12/loki-prometheus-inspired-open-source-logging-for-cloud-natives/)" on details of the Loki architectire. | ||
- David Kaltschmidt's blog post "[Closer look at Grafana's user interface for Loki](https://grafana.com/blog/2019/01/02/closer-look-at-grafanas-user-interface-for-loki/)" on the ideas that went into the logging user interface. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mind adding link to https://speakerdeck.com/grafana/grafana-loki-like-prometheus-but-for-logs?
basicAuth: true | ||
basicAuthUser: my_user | ||
basicAuthPassword: test_password | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where am I supposed to put these files?
docs/operations.md
Outdated
Check out our [Loki mixin](../production/loki-mixin) for a set of dashboards, recording rules, and alerts. | ||
These give you a comprehensive package on how to monitor Loki in production. | ||
|
||
For more information about mixins, take a look at the [Kubernetes mixins project](https://github.com/kubernetes-monitoring/kubernetes-mixin). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update link for https://github.com/monitoring-mixins/docs
docs/operations.md
Outdated
Loki has support for Google Cloud storage. | ||
Take a look at our [production setup](https://github.com/grafana/loki/blob/a422f394bb4660c98f7d692e16c3cc28747b7abd/production/ksonnet/loki/config.libsonnet#L55) for the relevant configuration fields. | ||
|
||
Support for AWS and Azure is still under development. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Its actually pretty possible right now, we just don't have docs for it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with a few comments.
Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
Merging without CLA as @davkal is a Grafana Labs employee. |
…s-5.7 LOG-5059: Improve messages for errors in storage secret