grafana/loki

Docs feedback: /docs/sources/operations/loki-canary/_index.md

Open

#11,749 opened on Jan 23, 2024

View on GitHub
 (1 comment) (5 reactions) (0 assignees)Go (28,187 stars) (3,997 forks)batch import
component/loki-canaryhelp wantedtype/docs

Description

  • binary and docker installation of loki-canary is not provided properly along with how to run
  • requires few examples of loki-canary with their configurations
  • discuss more about different terminal parameters
  • discuss general errors occurred due to wrong configurations like
    • failed to receive entry 1706019464814950000 within 300.000000 seconds
    • failed to find entry 1706015608136329000 in Loki when spot check querying 33m59.000013519s after it was written
    • timeout tailing new logs (timeout period: 10.00s), will retry in 10 seconds: read tcp 127.0.0.1:55129->127.0.0.1:3100: i/o timeout
    • websocket failed to receive entry 1706019729815965000 within 60.000000 seconds
    • websocket missing entry: 1706019523814842000

Contributor guide

Tech stack
godocker
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of Lokifamiliarity with Docker
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Review the existing documentation at /docs/sources/operations/loki canary/ index.md. Identify sections where installation instructions (binary and Docker) are missing or incomplete. Add examples of loki canary configurations and explain common terminal parameters. Document common errors such as timeout and missing entry messages with troubleshooting steps. Ensure the documentation is accessible to newcomers.