Skip to content

docs: fix ingestion examples broken by current tool releases - #3048

Merged
sunng87 merged 5 commits into
mainfrom
docs/verify-ingest-integrations
Nov 17, 2026
Merged

sunng87 merged 5 commits into
mainfrom
docs/verify-ingest-integrations

Conversation

@killme2008

@killme2008 killme2008 commented Nov 17, 2026 •

Copy link
Copy Markdown
Member

What changed

Ran every copy-paste example on the ingestion pages with each tool's latest stable release against GreptimeDB v1.3.1. These broke:

  • vector.md: influxdb_metrics fails to load without version (required since Vector 0.60). The Remote Write basic auth key is user, not username. The health check sends GET to the write endpoint and gets a 405, as it does against Prometheus (Adjust healthcheck for prometheus_remote_write vectordotdev/vector#8279); the example sets healthcheck.uri to /v1/health.
  • fluent-bit.md: Fluent Bit sends quoted header values literally, so all three OTLP outputs got 400. Removed the quotes.
  • elasticsearch.md: Telegraf 1.40 removed from_beginning from inputs.tail and refuses the config. Replaced it with initial_read_offset = "beginning" and switched headers to the array syntax; the string form is deprecated since 1.32.
  • splunk.md: the OTel Collector snippet referenced an undefined otlp receiver and failed validation.

These were inaccurate:

  • vector.md: with new_naming = true, as in the example, columns are greptime_timestamp and greptime_value, not ts and val. Sketch also writes count. The InfluxDB token accepts <username>:<password>, so the "not compatible with authentication" note was wrong.
  • influxdb-line-protocol.md: integer, unsigned, string, and boolean fields keep their types; only floats become Float64. Telegraf needs the target database to exist.
  • prometheus.md: native histograms are scraped only with scrape_native_histograms: true.
  • alloy.md: the OTel examples fail to start with empty credentials; documented removing the auth block when authentication is off.
  • traces/read-write.md: Collector image 0.159.0 → 0.165.0, and dropped -p flags that --network host ignores.
  • emqx.md: EMQX is no longer open source (BSL 1.1); link updated to emqx.com.

The _bulk endpoint reports success for documents that fail to insert; filed as GreptimeTeam/greptimedb#10471.

Scope

  • Documentation versions: Nightly, 1.3
  • Languages: English, Chinese

Verification

Tested versions: Vector 0.62.0, Fluent Bit 5.2.0, OTel Collector contrib 0.165.0, Grafana Alloy 1.22.0, Telegraf 1.40.3, Prometheus 3.16.0, vmalert/vmagent 1.156.0, Logstash and Filebeat 9.5.6, EMQX 6.3.3. Each broken example was rerun with its fix and the written data checked with SQL.

DOC_LANG=en pnpm check:links and DOC_LANG=zh pnpm check:links pass.

Checklist

  • I verified the content against the applicable GreptimeDB version.
  • I updated the relevant documentation versions and languages, or explained why not.
  • I checked changed links and anchors.
  • I updated navigation when the document structure changed.
  • For a version cut, stable promotion, or feature backport, I reviewed Nightly upgrade entries against the target release, updated both Nightly and versioned English/Chinese guides, and recorded release evidence and the outcome (or marked this not applicable).

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 68d2e60
Status: ✅  Deploy successful!
Preview URL: https://13c8125f.greptime-docs.pages.dev
Branch Preview URL: https://docs-verify-ingest-integrati.greptime-docs.pages.dev

View logs

@killme2008
killme2008 requested review from shuiyisong and sunng87 and a balanced review from Copilot November 17, 2026 05:10

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues block the ingestion documentation updates.

No open issues 🎉

What changed in this PR

Updates GreptimeDB ingestion examples for current tool releases across Nightly and 1.3 documentation, keeping English and Chinese pages aligned.

Changes:

  • Fixs configuration examples for Vector, Fluent Bit, Telegraf, and the OpenTelemetry Collector.
  • Clarifies authentication, native histogram collection, database prerequisites, and field mappings.
  • Updates the Collector image and EMQX description and website link.
File Description
versioned_docs/​version-1.3/​user-guide/​traces/​read-write.md Updates Collector image and removes ignored port mappings.
versioned_docs/​version-1.3/​user-guide/​ingest-data/​for-observability/​vector.md Corrects sink settings, authentication, and metric columns.
versioned_docs/​version-1.3/​user-guide/​ingest-data/​for-observability/​splunk.md Defines the referenced OTLP receiver.
versioned_docs/​version-1.3/​user-guide/​ingest-data/​for-observability/​prometheus.md Documents native histogram scraping configuration.
versioned_docs/​version-1.3/​user-guide/​ingest-data/​for-observability/​fluent-bit.md Removes literal quotes from HTTP headers.
versioned_docs/​version-1.3/​user-guide/​ingest-data/​for-observability/​elasticsearch.md Updates Telegraf settings and sample result ordering.
versioned_docs/​version-1.3/​user-guide/​ingest-data/​for-observability/​alloy.md Explains configuration without authentication.
versioned_docs/​version-1.3/​user-guide/​ingest-data/​for-iot/​influxdb-line-protocol.md Corrects field mappings and Telegraf database setup.
versioned_docs/​version-1.3/​user-guide/​ingest-data/​for-iot/​emqx.md Updates EMQX description and website link.
i18n/​zh/​docusaurus-plugin-content-docs/​version-1.3/​user-guide/​traces/​read-write.md Mirrors Collector image and Docker command updates.
i18n/​zh/​docusaurus-plugin-content-docs/​version-1.3/​user-guide/​ingest-data/​for-observability/​vector.md Mirrors Vector configuration and data-model corrections.
i18n/​zh/​docusaurus-plugin-content-docs/​version-1.3/​user-guide/​ingest-data/​for-observability/​splunk.md Adds the OTLP receiver definition.
i18n/​zh/​docusaurus-plugin-content-docs/​version-1.3/​user-guide/​ingest-data/​for-observability/​prometheus.md Adds native histogram scraping guidance.
i18n/​zh/​docusaurus-plugin-content-docs/​version-1.3/​user-guide/​ingest-data/​for-observability/​fluent-bit.md Removes literal quotes from HTTP headers.
i18n/​zh/​docusaurus-plugin-content-docs/​version-1.3/​user-guide/​ingest-data/​for-observability/​elasticsearch.md Mirrors Telegraf settings and sample result corrections.
i18n/​zh/​docusaurus-plugin-content-docs/​version-1.3/​user-guide/​ingest-data/​for-observability/​alloy.md Adds guidance for disabling authentication configuration.
i18n/​zh/​docusaurus-plugin-content-docs/​version-1.3/​user-guide/​ingest-data/​for-iot/​influxdb-line-protocol.md Mirrors field mappings and database setup guidance.
i18n/​zh/​docusaurus-plugin-content-docs/​version-1.3/​user-guide/​ingest-data/​for-iot/​emqx.md Updates EMQX description and website link.
i18n/​zh/​docusaurus-plugin-content-docs/​current/​user-guide/​traces/​read-write.md Mirrors Collector image and Docker command updates.
i18n/​zh/​docusaurus-plugin-content-docs/​current/​user-guide/​ingest-data/​for-observability/​vector.md Mirrors Vector configuration and data-model corrections.
i18n/​zh/​docusaurus-plugin-content-docs/​current/​user-guide/​ingest-data/​for-observability/​splunk.md Adds the OTLP receiver definition.
i18n/​zh/​docusaurus-plugin-content-docs/​current/​user-guide/​ingest-data/​for-observability/​prometheus.md Adds native histogram scraping guidance.
i18n/​zh/​docusaurus-plugin-content-docs/​current/​user-guide/​ingest-data/​for-observability/​fluent-bit.md Removes literal quotes from HTTP headers.
i18n/​zh/​docusaurus-plugin-content-docs/​current/​user-guide/​ingest-data/​for-observability/​elasticsearch.md Mirrors Telegraf settings and sample result corrections.
i18n/​zh/​docusaurus-plugin-content-docs/​current/​user-guide/​ingest-data/​for-observability/​alloy.md Adds guidance for disabling authentication configuration.
i18n/​zh/​docusaurus-plugin-content-docs/​current/​user-guide/​ingest-data/​for-iot/​influxdb-line-protocol.md Mirrors field mappings and database setup guidance.
i18n/​zh/​docusaurus-plugin-content-docs/​current/​user-guide/​ingest-data/​for-iot/​emqx.md Updates EMQX description and website link.
docs/​user-guide/​traces/​read-write.md Updates Collector image and removes ignored port mappings.
docs/​user-guide/​ingest-data/​for-observability/​vector.md Corrects sink settings, authentication, and metric columns.
docs/​user-guide/​ingest-data/​for-observability/​splunk.md Defines the referenced OTLP receiver.
docs/​user-guide/​ingest-data/​for-observability/​prometheus.md Documents native histogram scraping configuration.
docs/​user-guide/​ingest-data/​for-observability/​fluent-bit.md Removes literal quotes from HTTP headers.
docs/​user-guide/​ingest-data/​for-observability/​elasticsearch.md Updates Telegraf settings and sample result ordering.
docs/​user-guide/​ingest-data/​for-observability/​alloy.md Explains configuration without authentication.
docs/​user-guide/​ingest-data/​for-iot/​influxdb-line-protocol.md Corrects field mappings and Telegraf database setup.
docs/​user-guide/​ingest-data/​for-iot/​emqx.md Updates EMQX description and website link.

Review effort: Balanced

@killme2008
killme2008 marked this pull request as ready for review November 17, 2026 05:20
@sunng87
sunng87 merged commit 47e3bd8 into main Nov 17, 2026
8 checks passed
@sunng87
sunng87 deleted the docs/verify-ingest-integrations branch November 17, 2026 22:09
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.

4 participants