Expand documentation #261
Merged
Expand documentation #261
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
davkal
commented
Jan 31, 2019
•
davkal
commented
- Toplevel README
- Getting started doc
- Verify examples work
- Usage (querying)
- Contributing
- Operations
- Troubleshooting
|
|
tomwilkie
reviewed
Feb 1, 2019
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.
Probably not so "advanced"?
tomwilkie
reviewed
Feb 1, 2019
| - 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.
Mind adding link to https://speakerdeck.com/grafana/grafana-loki-like-prometheus-but-for-logs?
tomwilkie
reviewed
Feb 1, 2019
| basicAuth: true | ||
| basicAuthUser: my_user | ||
| basicAuthPassword: test_password | ||
| ``` |
There was a problem hiding this comment.
Where am I supposed to put these files?
tomwilkie
reviewed
Feb 1, 2019
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.
Update link for https://github.com/monitoring-mixins/docs
tomwilkie
reviewed
Feb 1, 2019
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.
Its actually pretty possible right now, we just don't have docs for it.
tomwilkie
approved these changes
Feb 1, 2019
Signed-off-by: Tom Wilkie <tom.wilkie@gmail.com>
|
Merging without CLA as @davkal is a Grafana Labs employee. |
xperimental
pushed a commit
to xperimental/loki
that referenced
this pull request
Mar 5, 2024
…s-5.7 LOG-5059: Improve messages for errors in storage secret
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.