108 Commits (1e1e7a94d5a13b23dd53b45814574c6d4027f68f)

Author	SHA1	Message	Date
J Stickler	9d86b9e483	docs: Fix WAL numbering (#15874)	11 months ago
Dylan Guedes	7cb8dd6526	docs: Fillout metrics section of our WAL docs (#15809) ... **What this PR does / why we need it**: Add a new `metrics` section to our WAL docs.	11 months ago
Christian Haudum	c8a4afe2ac	chore: Update ASCII diagram of chunk binary encoding (#15386) ... Signed-off-by: Christian Haudum <christian.haudum@gmail.com>	1 year ago
sarah-spang	98f41069b3	docs: add URL to Log entry deletion page (#9119) ... Co-authored-by: J Stickler <julie.stickler@grafana.com>	1 year ago
Matt Veitas	1b860e2e95	docs: Update reference to the default tsdb-max-query-parallelism value to be 128 (#14837) ... Co-authored-by: J Stickler <julie.stickler@grafana.com>	1 year ago
J Stickler	3d6d35e976	docs: update admonitions to new shortcode format (#14735)	1 year ago
J Stickler	8d196c066e	docs: support clarification for filesystem (#14560)	1 year ago
J Stickler	7b9ef19f0b	docs: Late review comments and linting (#13714)	1 year ago
J Stickler	e13e12b758	docs: fix broken link and add alt text (#13322)	2 years ago
J Stickler	3cbdd95e76	docs: Update storage topics (v3.0) (#12768)	2 years ago
Christian Haudum	8b63b66c71	docs: Update supported and deprecated type in Manage > Storage (#12742) ... Make distinction between supported and deprecated store types more visible on this page, similar to what's listed under Configure > Storage. Also updated the list of supported object store backends. Signed-off-by: Christian Haudum <christian.haudum@gmail.com>	2 years ago
J Stickler	41246a05ac	docs: fix doc-validate errors due to config move (#12662)	2 years ago
J Stickler	ecb4878f45	docs: Rename API file to support publishing in GEL docs (#12493) ... Co-authored-by: Jack Baldry <jack.baldry@grafana.com>	2 years ago
Jack Baldry	cafc7b6f87	docs: Fix up storage page front matter (#12532) ... Signed-off-by: Jack Baldry <jack.baldry@grafana.com>	2 years ago
J Stickler	060b6c288f	docs: Loki 3.0 Release Notes (#12508)	2 years ago
Ed Welch	23b2e1d252	docs: remove whitespace in links (#12525) ... Signed-off-by: Edward Welch <edward.welch@grafana.com>	2 years ago
J Stickler	1c5a736641	docs: proper fix for #12510 (#12516)	2 years ago
J Stickler	38fbfb7236	docs: Attempt to fix whatever broke the docs builds (#12510)	2 years ago
J Stickler	3634ff4d64	docs: move Storage page under Configuration (#12478)	2 years ago
Ed Welch	27606a3d68	docs: add some docs around a schema value for new installs (#12424) ... Signed-off-by: Edward Welch <edward.welch@grafana.com> Co-authored-by: Dylan Guedes <djmgguedes@gmail.com>	2 years ago
Paul Rogers	b286075428	chore: Update examples to use v13 schema, along with related defaults (#12402) ... Co-authored-by: J Stickler <julie.stickler@grafana.com>	2 years ago
P0lskay	72593264ba	docs: Updated the information in the documentation about working with wal (#12219) ... Co-authored-by: J Stickler <julie.stickler@grafana.com>	2 years ago
Edson C	0bf894b704	docs: Update Kubernetes terminology in operations pages (#12235) ... Co-authored-by: J Stickler <julie.stickler@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com>	2 years ago
J Stickler	0dc8c75331	Update admonitions to add shortcode (#11622) ... **What this PR does / why we need it**: Completing the work that was started in #9409 but not completed because there were multiple variations on how to format notes in the docs source files. We rolled out different colors for admonitions recently, which highlighted that there were still a few notes not using the admonition shortcode. I searched the docs for the following words: * tip * caution * important * warning * note So hopefully I've caught all of the admonitions that weren't using the shortcode.	2 years ago
J Stickler	efdea22db4	Update descriptions (#11586) ... **What this PR does / why we need it**: Updates the `description` field in the metadata to support the Docs Landing Page project --------- Co-authored-by: Michel Hollands <42814411+MichelHollands@users.noreply.github.com>	2 years ago
J Stickler	5e3496739c	Update notes to use shortcode (#11408) ... **What this PR does / why we need it**: Updates Notes to use the Hugo admonition shortcode. **Which issue(s) this PR fixes**: Replaces PR #9409 which has gone stale.	2 years ago
Ashwanth	a118e994d8	Remove shared_store and shared_store_key_prefix from shipper and compactor (#10840) ... **What this PR does / why we need it**: #### Removes `shared_store` and `shared_store_key_prefix` from index shipper and compactor configs and their corresponding CLI flags. - `-tsdb.shipper.shared-store` - `-boltdb.shipper.shared-store` - `-tsdb.shipper.shared-store.key-prefix` - `-boltdb.shipper.shared-store.key-prefix` - `-boltdb.shipper.compactor.shared-store` - `-boltdb.shipper.compactor.shared-store.key-prefix` `shared_store` has been a confusing option allowing users to easily misconfigure Loki. Going forward `object_store` setting in the [period_config](https://grafana.com/docs/loki/latest/configure/#period_config) (which already configured the store for chunks) will be used to configure store for the index. And the newly added `path_prefix` option under the `index` key in `period_config` will configure the path under which index tables are stored. This change enforces chunks and index files for a given period reside together in the same storage bucket. More details in the upgrade guide. --- `-compactor.delete-request-store` has to be **explicitly configured** going forward. Without setting this, loki wouldn't know which object store to use for storing delete requests. Path prefix for storing deletes is decided by `-compactor.delete-request-store.key-prefix` which defaults to `index/`. **Checklist** - [X] Reviewed the [`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md) guide (**required**) - [X] Documentation added - [X] Tests updated - [x] `CHANGELOG.md` updated - [ ] If the change is worth mentioning in the release notes, add `add-to-release-notes` label - [X] Changes that require user attention or interaction to upgrade are documented in `docs/sources/setup/upgrade/_index.md` - [ ] For Helm chart changes bump the Helm chart version in `production/helm/loki/Chart.yaml` and update `production/helm/loki/CHANGELOG.md` and `production/helm/loki/README.md`. [Example PR](d10549e3ec)	2 years ago
Salva Corts	de9cc69de3	Update configuration examples (#10781) ... **What this PR does / why we need it**: This PR updates the set of configuration examples. There are snippets for some deprecated configs. We are considering moving those deprecated examples to a separate section with a follow-up PR. --------- Co-authored-by: Ashwanth <iamashwanth@gmail.com>	2 years ago
Ashwanth	b2f30ccd4a	doc: log retention page improvements (#10665) ... **What this PR does / why we need it**: - Marks table manager as deprecated - Use admonition shortcode for block quotes - Adds description to stream_retention fields - minor restructure **Special notes for your reviewer**: **Checklist** - [ ] Reviewed the [`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md) guide (**required**) - [ ] Documentation added - [ ] Tests updated - [ ] `CHANGELOG.md` updated - [ ] If the change is worth mentioning in the release notes, add `add-to-release-notes` label - [ ] Changes that require user attention or interaction to upgrade are documented in `docs/sources/setup/upgrade/_index.md` - [ ] For Helm chart changes bump the Helm chart version in `production/helm/loki/Chart.yaml` and update `production/helm/loki/CHANGELOG.md` and `production/helm/loki/README.md`. [Example PR](d10549e3ec)	2 years ago
Christian Haudum	2d7930e6d8	Revise documentation about Loki architecture (#10672) ... Also split out legacy storage into separate page. Signed-off-by: Christian Haudum <christian.haudum@gmail.com>	2 years ago
Christian Haudum	4704d5e51a	Docs: Fix broken link on WAL page (#10673) ... The reference to a headline on the API page broke, because the headline was removed in https://github.com/grafana/loki/pull/10655 Signed-off-by: Christian Haudum <christian.haudum@gmail.com>	2 years ago
J Stickler	aed39c89ee	[docs] Replace ampersand with the word "and" (#10637) ... Replacing the ampersand character (&) with the word `and` to conform to the Style Guide https://grafana.com/docs/writers-toolkit/write/style-guide/capitalization-punctuation/#punctuation-guidelines Do not abbreviate and with an ampersand (&).	2 years ago
J Stickler	1f408305c4	[Docs] Create top level Manage section (#10461) ... **What this PR does / why we need it**: Part of the Epic to create a consistent documentation information architecture across the three DB projects. **Which issue(s) this PR fixes**: Fixes #8718 **Special notes for your reviewer**: The original Issue called for moving files under Manage, but rather than rename the folder and break links, I chose to make the "move" by updating the topic metadata. This PR also includes updates to topic metadata and removes or updates page weights.	2 years ago
Ward Bekker	7733be0658	making clearer that TSDB is the new recommended index, and make expli… (#9246) ... **What this PR does / why we need it**: making clearer that TSDB is the new recommended index, and make explicit that non TSDB and BoltDB shipper are deprecated and not recommended Fixes #9105 **Special notes for your reviewer**: This needs to be changed in more places, but this is a start as it concerns the main storage docs **Checklist** - [X] Reviewed the [`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md) guide (**required**) - [X] Documentation added - [ ] Tests updated - [ ] `CHANGELOG.md` updated - [ ] Changes that require user attention or interaction to upgrade are documented in `docs/sources/upgrading/_index.md` --------- Co-authored-by: Travis Patterson <masslessparticle@gmail.com> Co-authored-by: J Stickler <julie.stickler@grafana.com> Co-authored-by: Travis Patterson <travis.patterson@grafana.com>	2 years ago
J Stickler	aae92b9840	[Docs] Create top-level Setup section (#9974) ... **Which issue(s) this PR fixes**: Fixes #8712 **Special notes for your reviewer**: Move the following files under a new Setup section (with three subsections: Install, Migrate, and Upgrade). - ./sources/installation/sizing/index.md - ./sources/installation/_index.md - ./sources/installation/docker.md - ./sources/installation/helm/_index.md - ./sources/installation/helm/concepts.md - ./sources/installation/helm/configure-storage/index.md - ./sources/installation/helm/install-monolithic/index.md - ./sources/installation/helm/install-scalable/index.md - ./sources/installation/helm/migrate-from-distributed/index.md - ./sources/installation/helm/migrate-to-three-scalable-targets/index.md - ./sources/installation/helm/monitor-and-alert/index.md - ./sources/installation/helm/reference.md - ./sources/installation/helm/upgrade-from-2.x/index.md - ./sources/installation/install-from-source.md - ./sources/installation/istio.md - ./sources/installation/local.md - ./sources/installation/tanka.md Updates cross-references broken by the move, Updates file metadata (descriptions, weights) and adds aliases for redirects to avoid 404s. Probably fixes a couple of typos too.	2 years ago
J Stickler	7797a98074	TOC Sync: Move configuration files under Configure (#9879) ... **Which issue(s) this PR fixes**: Fixes #8713 **Special notes for your reviewer**: Replaces PR [#8817](https://github.com/grafana/loki/pull/8817), which was stale and badly out of date. Part of the Database products table of contents alignment project. Moves configuration files from Configuration to new Configure heading in TOC. Updates front matter for the topic. Fixes links broken by the move. Updates the MakeFile to point to the new Configure DOCS_SOURCES_PATH.	3 years ago
J Stickler	32320736db	TOC Sync: Move files under Get Started. (#9717) ... **Which issue(s) this PR fixes**: Fixes #8711 **Special notes for your reviewer**: Part of the Database products table of contents alignment project. Moves Getting Started and Fundamentals files under Get Started in TOC. Updates front matter for the topic (headings, page weights, descriptions, aliases to redirect from old URL to new URL) Fixes links broken by the move.	3 years ago
J Stickler	11e2375e6d	Removing 'please' from the docs. (#9658) ... **Which issue(s) this PR fixes**: Fixes #8922 **Special notes for your reviewer**: This is to conform with our Style Guide. https://developers.google.com/style/tone#politeness-and-use-of-please	3 years ago
Jack Baldry	8391e557b1	Update doc-validator to v3.0.0 (#9666) ... ## 3.0.0 ### Added - Structured output for use with [`reviewdog`](https://github.com/reviewdog/reviewdog). You can achieve the original error output by piping the output to the following `jq` expression: `jq -r '"ERROR: \(.location.path):\(.location.range.start.line):\(.location.range.start.column): \(.message)"'`. - Suggestions for simple link fixes. In GitHub, [`reviewdog`](https://github.com/reviewdog/reviewdog) comments these suggestions for convenient replacement. - Support for anchors referring to repeated headings. In the case that a page has multiple headings that share the same text, the renderer appends a zero indexed, numbered suffix to the identifier. For example, when there are two headings that are both "Heading text", the first anchor identifier is `heading-text` and the second is `heading-text-1`. - Error when running `doc-validator` on no files. **Notes for reviewer:** This also updates the `make-docs` procedure. Please ensure you can run `make docs` from the `docs/` directory before approving and merging this PR. --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com>	3 years ago
oleksii-boiko-ua	f9aba99455	Helm: add hpa for read, write and backend (#8684) ... **What this PR does / why we need it**: It adds missing HPA (HorizontalPodAutoscaler) templates to write, read, and backend components **Which issue(s) this PR fixes**: Fixes #7864 **Checklist** - [x] Reviewed the [`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md) guide (**required**) - [x] Documentation added - [ ] Tests updated - [x] `CHANGELOG.md` updated - [x] Changes that require user attention or interaction to upgrade are documented in `docs/sources/upgrading/_index.md` Co-authored-by: Oleksii Boiko <oleksii_boiko@external.mckinsey.com>	3 years ago
J Stickler	8ee9a2c3c7	TOC Sync: Move API docs under Reference. (#9203) ... **Which issue(s) this PR fixes**: Fixes #8719 **Special notes for your reviewer**: Part of the Database products table of contents alignment project. Moves API doc under Reference heading in TOC. Updates front matter for the topic. Fixes links broken by the move. Adds aliases for redirects.	3 years ago
Alain Pham	c1052d704c	Update retention doc tsdb support of compactor (#9397) ... compactor now also supports tsdb in addition to boltdb-schipper **What this PR does / why we need it**: **Which issue(s) this PR fixes**: Fixes #<issue number> **Special notes for your reviewer**: **Checklist** - [ ] 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`	3 years ago
Zirpolo	df5217baef	Change upper and lower case Compactor name (#9288) ... Made chances to reflect uniform reference to the name Compactor, changed all lowercase instance outside of code to uppercase. **What this PR does / why we need it**: To make the docs uniform when speaking about the Compactor **Which issue(s) this PR fixes**: Fixes #<issue number> **Special notes for your reviewer**: **Checklist** - [ ] 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`	3 years ago
René Scheibe	e050d5c494	Docs: Update Loki GitHub URLs (#9080) ... * use `main` instead of `master` branch * fix outdated URLs	3 years ago
Erik Sjölund	2cccc1bc68	Docs: Fix typos and grammar (#8966) ... **What this PR does / why we need it**: Fixes typos and grammar. Most of them were occurrences of `it's` that should be `its`. **Which issue(s) this PR fixes**: None **Special notes for your reviewer**: **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` Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>	3 years ago
Athira Varghese	ffb961c439	feat(storage): add support for IBM cloud object storage as storage client (#8826) ... **What this PR does / why we need it**: Add support for IBM cloud object storage as storage client **Which issue(s) this PR fixes**: Fixes NA **Checklist** - [x] Reviewed the [`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md) guide (**required**) - [x] Documentation added - [x] Tests updated - [ ] `CHANGELOG.md` updated --------- Signed-off-by: Shahul <shahulsonhal@gmail.com> Co-authored-by: Aman Kumar Singh <amankrsingh2110@gmail.com> Co-authored-by: Suruthi-G-K <shruthi.suruthi@gmail.com> Co-authored-by: tareqmamari <tariq.mamari@de.ibm.com> Co-authored-by: shahulsonhal <shahulsonhal@gmail.com> Co-authored-by: Aditya C S <aditya.gnu@gmail.com> Co-authored-by: Tareq Al-Maamari <tariq.mamari@gmail.com>	3 years ago
Danny Kopping	c15048b50b	Retention: add selector detail to docs (#8808) ... **What this PR does / why we need it**: This adds more detail around what can and cannot be used in a `selector` for retention. It was unclear whether arbitrary LogQL could be used or not; this makes it explicit. Also added some additional matchers to the examples to show that it can be combinatorial. --------- Signed-off-by: Danny Kopping <danny.kopping@grafana.com> Co-authored-by: J Stickler <julie.stickler@grafana.com>	3 years ago
Ed Welch	eadb9d2c00	Loki: Change the behavior of the 0 value for retention_period to disable retention. (#8753) ... **What this PR does / why we need it**: Issue #8359 exposed a very unfortunate inconsistency in a Loki config where the zero value did not disable a feature. By convention in Loki the zero value for a config typically "disables" it. This PR changes the retention_period to honor the zero value of `0` or `0s` to disable retention. **Which issue(s) this PR fixes**: Fixes #8359 **Special notes for your reviewer**: **Checklist** - [x] Reviewed the [`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md) guide (**required**) - [x] Documentation added - [x] Tests updated - [x] `CHANGELOG.md` updated - [x] Changes that require user attention or interaction to upgrade are documented in `docs/sources/upgrading/_index.md` --------- Signed-off-by: Edward Welch <edward.welch@grafana.com> Co-authored-by: J Stickler <julie.stickler@grafana.com>	3 years ago
Travis Patterson	4b9cc39f9f	fix remaining docs issues (#8263)	3 years ago
Owen Diehl	8d3c50f40d	tsdb docs first pass (#8048) ... Co-authored-by: J Stickler <julie.stickler@grafana.com>	3 years ago