Skip to content

docs(integration): add InfluxDB observability integration guide - #153

Merged
majinghe merged 1 commit into
rustfs:mainfrom
majinghe:docs/influxdb-integration
Sep 21, 2026
Merged

majinghe merged 1 commit into
rustfs:mainfrom
majinghe:docs/influxdb-integration

Conversation

@majinghe

Copy link
Copy Markdown
Collaborator

Summary

Adds an InfluxDB guide under the existing Observability category in all five locales (en, zh, de, fr, ja), wired into the category landing pages and meta.json. The InfluxDB GitHub repository is linked in the product introduction.

  • Runs InfluxDB 3 Core — the Rust-based engine whose catalog, WAL, and Parquet data files live entirely in the configured object store — with --object-store s3, --bucket my-bucket, --aws-endpoint http://rustfs:9000, and --aws-allow-http (path-style, plain HTTP).
  • Covers the full flow: admin bearer token creation (influxdb3 create token --admin), line protocol writes via /api/v3/write_lp, SQL reads via /api/v3/query_sql, and verification of the influxdb-demo/catalog/ and influxdb-demo/wal/ objects through rc ls and a Console screenshot (light theme, ≤300 KB; Chinese capture in zh, English captures in the other locales).
  • Includes a restart persistence check: the SQL count is unchanged after restarting InfluxDB, proving the object store is the persistence layer.
  • Documents the pitfalls verified during testing: the token value is printed only once (409 on re-creation requires wiping the node prefix), the admin token is required on every API request, and the --aws-endpoint/--aws-allow-http flags exist even though influxdb3 serve --help does not list them.

Verification

Validated end to end on Ubuntu 24.04 against influxdb:3-core (v3.11.5) and rustfs/rustfs-x86-musl:v2.3.1:

  • 30 line protocol records written to cpu_usage (write: 204); SELECT count(*) returns [{"cnt":30}].
  • catalog/v3/snapshot and wal/00000000001.wal objects appear in the bucket under influxdb-demo/.
  • After docker compose restart influxdb, the same SQL query returns [{"cnt":30}] again.

npm run docs:check passes; npm run build passes (2675 pages); locale audit reports no findings for the new page.

Add an InfluxDB guide under the observability category in all five
locales (en, zh, de, fr, ja), and wire it into the observability
meta.json and category landing pages.

InfluxDB 3 Core keeps its catalog, write-ahead log, and Parquet data
files in the configured object store. The guide deploys RustFS with
Docker Compose alongside influxdb:3-core serving with
--object-store s3 --bucket my-bucket --aws-endpoint (path-style,
plain HTTP), creates the admin bearer token, writes line protocol
through /api/v3/write_lp, queries via /api/v3/query_sql, verifies
the catalog and WAL objects under the node prefix through the rc CLI
and a Console screenshot, and proves persistence by re-querying the
same count after an InfluxDB restart.

Verified end to end on Ubuntu 24.04 against influxdb:3-core
(v3.11.5) and rustfs/rustfs-x86-musl:v2.3.1: 30 line protocol
records written (204), SQL count returns 30, catalog and WAL objects
land in the bucket, and the count is unchanged after a restart.
@vercel

vercel Bot commented Sep 21, 2026

Copy link
Copy Markdown

@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.

@majinghe
majinghe merged commit 2250536 into rustfs:main Sep 21, 2026
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant