34 Commits

Author SHA1 Message Date
2dcaba3176 Loki Getting Started: Fix example query that was not working (#8668)
**What this PR does / why we need it**:

Previously example query was `evaluate-loki_flog_1` this was not the
label used in flog. This results in query not returning any logs which
beginners may be unsure of the cause of the issue. This might also be an
issue if flog was running in the background and logs are not displayed.

Changed to `evaluate-loki-flog-1`.


**Which issue(s) this PR fixes**:
Fixes #<issue number>

**Special notes for your reviewer**:
Trivial fix to "Getting Started" documentation

**Checklist**
- [x] Reviewed the
[`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md)
guide (**required**)
- [ ] Documentation added
- [ ] Tests updated
- [ ] `CHANGELOG.md` updated
- [ ] Changes that require user attention or interaction to upgrade are
documented in `docs/sources/upgrading/_index.md`
2023-03-02 16:43:10 +01:00
1c954166b8 Fix documentation linter errors (#8229) 2023-01-23 09:31:18 +02:00
32b3f974c6 Remove CTA per @grafanawriter. (#7559) 2022-11-02 09:27:18 +01:00
a5b9a9a91c Docs: Improve wording of getting started guide (#6060)
- Add the -d option to all docker-compose up commands
    - Make the wording consistent about the CWD
2022-05-02 08:45:42 +02:00
c4ebfd3020 Docs: revise getting started guide (#5939)
* 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>
2022-04-28 16:15:46 -04:00
732b4ab539 Fixed Getting started docs error (#5504)
* Simple docs error

The docs read "... are what send the logs that Loki generate to Loki" instead of "... are what send the logs that promtail generate to Loki"

* Capitalise spelling of Promtail
2022-03-29 09:37:32 -07:00
2e6e050453 Improve docs on how to install logcli from source (#5126)
* Improve docs on how to install logcli from source

Closes #5108

Signed-off-by: Christian Haudum <christian.haudum@gmail.com>

* fixup! Improve docs on how to install logcli from source

Signed-off-by: Christian Haudum <christian.haudum@gmail.com>
2022-01-25 11:59:04 +02:00
94113ee080 Logql stdin support only log queries (#4606)
* Hack stdin client into LogCLI

Add flag to choose what kind of client to make request to.

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>

* Label filter working

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>

* Demo checkpoint1

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>

* Metrics query working.

Issue was with default value of `step` (1 nanosecond).
StepEvaluator try to go through every nanosecond to apply aggregate on sample data
during the metric queries.

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>

* Basic tests for fileClient

* Tests for logqueries direction

* Use HeapIterator for Entries.

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>

* Remove some debug statements

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>

* Remove support for metric queries. Stick with only log queries

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>

* Small rough usage doc

* Remove filesampleiterator

* Fix some typos and tests

* Fix breaking test cases

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>

* Make linter happy

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>

* PR remarks.

1. Add `--stdin` in examples of the usage
2. Add `--stdin` in all the command help output

* PR remarks
- Use parsed labels correctly
- Fix indendation with --stdin flag

* Fix issue with direction

* Fix linter

* MaxInt64 -> MaxInt (to support even arm32 images)

* Add note on calculating `step` value on the client side
2021-11-18 15:53:07 +02:00
c4562f19ed Docs: correct the page parameter in the Grafana Cloud advertisement (#4486) 2021-10-15 15:31:41 -07:00
69d81dfcf0 Docs: revise wording of Grafana Cloud advertisement (#4422) 2021-10-07 00:10:24 +02:00
24accf6a5b Docs: correctly represent product name (#4416)
The product name is Grafana Loki.  The first use of the product name on
each web page should be the full product name.  After that, within each
page, it is fine to use just Loki.

This PR also set up some frontmatter with weights where it was missing
on a few files, and correct where "Loki" was not capitalized.
2021-10-06 00:21:47 +02:00
e6e8cbfa13 Docs: introduce a fundamentals section (#4403) 2021-10-05 09:42:05 -07:00
8010deac5d Docs: prominently advertise free Graphana Cloud availability (#4399) 2021-09-30 17:36:06 -04:00
68ef8f4dab Docs: Remove wording like "As of version 1.6, you can..." (#4363)
- We give readers versioned documentation (now), so they don't need to know what version a feature appeared in.
- I couldn't resist fixing some grammar formatting and phrasing in the sections that needed changes.
2021-09-22 15:06:45 +02:00
be4cebc516 Docs: improve spelling, grammar, and formatting. (#4320)
- section titled "Get logs into Loki"
2021-09-16 11:40:48 +05:30
b3df9f5dfd cmd/logcli: add --follow flag as an alias for --tail (#4203)
When using 'logcli query --tail', '--tail' behaves similar to the 'tail'
command, which uses '--follow' flag, if you want to continuously
follow the appended data to the file.

I believe '--follow' flag is more natural for system administrators to
use rather than '--tail' if one wants to "follow" the incoming logs, so
this commit adds one, as an alias for '--tail'.

Closes #3570

Signed-off-by: Mateusz Gozdek <mgozdekof@gmail.com>
2021-08-23 13:04:03 +02:00
2aafb0d38a Docs: revise the LogCLI subsection (#3921)
* Docs: revise the LogCLI subsection

* Update docs/sources/getting-started/logcli.md per review suggestion

Co-authored-by: Owen Diehl <ow.diehl@gmail.com>

* Incorporate review suggestion.

Co-authored-by: Owen Diehl <ow.diehl@gmail.com>
2021-07-06 19:58:28 -04:00
3c23ca6e18 Correct “ and ” with " and same with single quote mark. (#3899) 2021-06-28 13:37:42 +05:30
475560ba13 Corrected capitalization and formatting of "Promtail" (#3860) 2021-06-22 09:15:47 -04:00
88708d4b22 added support for bearer token authentication (#3749) 2021-06-09 09:02:11 +02:00
38e06015ba Update troubleshooting.md (#3715)
fix some typo. change utf8 em dash to ascii dash
2021-05-18 04:08:17 -04:00
771d33b69e Update labels.md in Loki Docs (#3648)
Complement to https://github.com/grafana/loki/pull/3641
2021-04-27 08:51:48 -04:00
e71cb454ca removes naming collision (#3641) 2021-04-22 10:34:15 -04:00
f0715a2c8c Fix wget link. (#3633) 2021-04-21 09:42:31 -04:00
794c324e64 doc: Cleanup formatting (#3017)
* doc: Add missing backticks

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* doc: Use absolute path to positions.yaml file

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* doc: Remove .. from URL paths

I'm not sure what the `..` means exactly.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2020-12-02 08:53:34 -05:00
6978ee5d73 Loki Release: update release notes and docs (#2808)
* update release notes and docs!

* add go and cortex version

* tweaks

* tweak wording

* change paths

* typo, thanks Cyril ;)

* thanks Owen ;)
2020-10-26 11:47:40 -04:00
e64409540b Doc: Vague link text. (#2698)
* Fixes remove vague link text #2680

* Fix remaining 'docs' links.

* Accept suggestion.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Change HTTP API to Ruler API.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Correct typo.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Capitalize Github.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Capitalize Promtail.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Add copy-edit suggestions from @achatterjee-grafana.

* Incorporate @owen-d's changes.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-10-12 08:18:30 -04:00
c00c7ed252 docs: use repetitive numbering (#2699) 2020-09-30 15:48:50 -04:00
3669770c07 Update to raw link (#2605)
Currently wget downloads the html not the raw yaml
2020-09-10 17:46:19 +05:30
82845e4f78 Adds --analyize-labels to logcli series command. (#2497)
Changes the series command to use the common matcher input found in the query and instant-query commands, instead of `logcli series --matcher='{foo="bar"}'` it's now `logcli series '{foo="bar"}'`
2020-08-13 11:31:17 -04:00
80693cae6f Logcli: automatically batch requests (#2482)
* first stab at batching logcli requests

* fix other calls to printResult

* working batching code

* refactor the logcli Client into an interface so that it can be mocked for testing.

* fixing some bugs

* refactoring the output interface to make testing easier

* starting to add tests

* adding a bunch of tests
fixing up how the MockQuerier works.

* updating docs

* Update docs/sources/getting-started/logcli.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/getting-started/logcli.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/getting-started/logcli.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/getting-started/logcli.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/getting-started/logcli.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/getting-started/logcli.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/getting-started/logcli.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/getting-started/logcli.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

Co-authored-by: Owen Diehl <ow.diehl@gmail.com>
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-08-10 16:38:21 -04:00
68568f141e colored labels output for logcli (#2470)
* colored labels output for logcli

* add period to all cli description
2020-08-08 12:41:00 -04:00
e2f1581313 Docs - update links, readme (#2398)
* docs - update links

* update readme
2020-07-23 08:14:10 -04:00
5a8bc848db Sync docs to website (#2378)
* update docs location

* add workflow

* update docs content

* update content

* cleanup
2020-07-21 17:53:48 +02:00