docs(integration): add Loki and Tempo observability integration guides - #152
Merged
Merged
Conversation
Add Loki and Tempo guides under the observability category in all five locales (en, zh, de, fr, ja), and wire them into the observability meta.json and category landing pages. - loki.md: single-binary Loki with the TSDB schema storing chunks and index in RustFS through common.storage.s3 (path-style, plain HTTP), with push, query_range, and chunk-object verification. - tempo.md: single-binary Tempo 2.9.5 with storage.trace backend s3 (forcepathstyle, insecure), a Zipkin span push, search + trace lookup, block-object verification, and a restart persistence check. - Both guides pin verified image versions (grafana/loki v3.7.8, grafana/tempo 2.9.5 — Tempo 3.x changed the config layout), use the rc-based bucket initializer, and document the pitfalls hit during verification (ring kvstore, WAL disk monitor, ingester restart state, block flush and blocklist polling delays). Verified end to end on Ubuntu 24.04 against rustfs/rustfs-x86-musl: v2.3.1: 20 Loki log entries query back after chunk flush with chunk objects visible in the bucket; a five-span Tempo trace flushes as single-tenant/<block>/data.parquet and stays searchable across a Tempo restart.
|
@majinghe is attempting to deploy a commit to the overtrue's projects Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds Grafana Loki and Grafana Tempo guides under the existing Observability category in all five locales (en, zh, de, fr, ja), wired into the category landing pages and
meta.json. Both follow the established integration guide structure, and both link the upstream GitHub repositories in the product introductions.v13) storing chunks and index in RustFS throughcommon.storage.s3(endpoint: rustfs:9000,s3forcepathstyle: true,insecure: true). Pushes log streams via/loki/api/v1/push, queries them viaquery_range, verifies chunk objects underfake/<stream-fingerprint>/viarc lsand a Console screenshot.grafana/tempo:2.9.5(Tempo 3.x changed the config layout, documented in Troubleshooting) withstorage.trace.backend: s3(forcepathstyle: true,insecure: true). Pushes Zipkin spans via curl, searches via/api/search, verifies the Parquet block atsingle-tenant/<block-id>/data.parquet, and proves persistence by re-querying after a Tempo restart.rc-based bucket initializer, short flush windows for verification (chunk_idle_period/max_chunk_age/max_block_duration/blocklist_poll), and document the pitfalls verified during testing: the inmemory ring KV store for single binaries, Loki's 90% WAL disk monitor, and block flush/blocklist polling delays.zh, English captures inen/de/fr/ja.Verification
Validated end to end on Ubuntu 24.04 against
rustfs/rustfs-x86-musl:v2.3.1:grafana/loki:latest, v3.7.8): 20 pushed log entries return throughquery_range; after the flush window, two chunk objects appear in the bucket underfake/.grafana/tempo:2.9.5): a five-span Zipkin trace is pushed (202), discovered by/api/search(inspectedTraces: 1from the backend block), returned by/api/traces/<id>with 200, and still queryable after a Tempo restart — the block Parquet (single-tenant/<block-id>/data.parquet, 25 KiB) is visible in RustFS.npm run docs:checkpasses;npm run buildpasses (2635 pages); locale audit reports no findings for the new pages.