Repository navigation
docs: fix ingestion examples broken by current tool releases - #3048
Merged
Merged
Conversation
Deploying greptime-docs with
|
| 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 |
killme2008
requested review from
shuiyisong and
sunng87
and
a balanced review from Copilot
November 17, 2026 05:10
Contributor
There was a problem hiding this comment.
🟢 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
marked this pull request as ready for review
November 17, 2026 05:20
fengjiachun
reviewed
Nov 17, 2026
sunng87
approved these changes
Nov 17, 2026
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
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.
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_metricsfails to load withoutversion(required since Vector 0.60). The Remote Write basic auth key isuser, notusername. The health check sends GET to the write endpoint and gets a 405, as it does against Prometheus (Adjust healthcheck forprometheus_remote_writevectordotdev/vector#8279); the example setshealthcheck.urito/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 removedfrom_beginningfrominputs.tailand refuses the config. Replaced it withinitial_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 undefinedotlpreceiver and failed validation.These were inaccurate:
vector.md: withnew_naming = true, as in the example, columns aregreptime_timestampandgreptime_value, nottsandval. Sketch also writescount. The InfluxDBtokenaccepts<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 becomeFloat64. Telegraf needs the target database to exist.prometheus.md: native histograms are scraped only withscrape_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-pflags that--network hostignores.emqx.md: EMQX is no longer open source (BSL 1.1); link updated to emqx.com.The
_bulkendpoint reports success for documents that fail to insert; filed as GreptimeTeam/greptimedb#10471.Scope
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:linksandDOC_LANG=zh pnpm check:linkspass.Checklist