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

docs: Update _index.md: add information about non-blocking mode to the documentation #15910

Merged
merged 3 commits into from
Jan 24, 2025

Conversation

Rokedd
Copy link
Contributor

@Rokedd Rokedd commented Jan 23, 2025

What this PR does / why we need it:

I struggled with the issue that after working for more than 10 minutes without an internet connection, all my containers froze and stopped working. I've spent a lot of time fixing this issue and I couldn't even find any mention of such a parameter in the documentation.
Thanks for https://community.grafana.com/t/loki-driver-on-docker-and-getting-stuck-container/56610/2

Which issue(s) this PR fixes:

If the Loki server is unavailable, the running containers run for 10 minutes and freeze. That is, everything that is running inside the container completely stops working, which is unacceptable in my opinion. I was also confused that the documentation doesn't even mention that there is such a log-opt!

Special notes for your reviewer:

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

This info saves a lot of time for solving the issue when the Loki server is unavailable and containers become unmanageable and sometimes completely malfunctioning.
This information can only be found in issues, but not in the documentation.

Signed-off-by: Roked <[email protected]>
@Rokedd Rokedd requested a review from a team as a code owner January 23, 2025 08:58
@CLAassistant
Copy link

CLAassistant commented Jan 23, 2025

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Jan 23, 2025
@Rokedd Rokedd changed the title Update _index.md Update _index.md: add information about non-blocking mode to the documentation Jan 23, 2025
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[docs team] Hi @Rokedd , I find it's always helpful with Yaml files to give clear instructions on where snippets need to be nested.

docs/sources/send-data/docker-driver/_index.md Outdated Show resolved Hide resolved
@JStickler JStickler changed the title Update _index.md: add information about non-blocking mode to the documentation docs: Update _index.md: add information about non-blocking mode to the documentation Jan 23, 2025
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[docs team] LGTM

@JStickler JStickler merged commit 10fef0c into grafana:main Jan 24, 2025
60 checks passed
loki-gh-app bot pushed a commit that referenced this pull request Jan 24, 2025
…e documentation (#15910)

Signed-off-by: Roked <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit 10fef0c)
loki-gh-app bot pushed a commit that referenced this pull request Jan 24, 2025
…e documentation (#15910)

Signed-off-by: Roked <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit 10fef0c)
loki-gh-app bot pushed a commit that referenced this pull request Jan 24, 2025
…e documentation (#15910)

Signed-off-by: Roked <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit 10fef0c)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-3.1.x backport release-3.2.x backport release-3.3.x size/XS type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants