Skip to content

fix(influxdb-v1): remove retired _internal stat fields from measurements-internal - #7731

Open
jstirnaman wants to merge 4 commits into
masterfrom
agent-task/docsv2-7684
Open

fix(influxdb-v1): remove retired _internal stat fields from measurements-internal#7731
jstirnaman wants to merge 4 commits into
masterfrom
agent-task/docsv2-7684

Conversation

@jstirnaman

@jstirnaman jstirnaman commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Closes #7684

What changed

In content/shared/influxdb-v1/administration/monitor/measurements-internal.md:

  • Removed httpd.valuesWrittenOK from the table of contents and the httpd section.
  • Removed write.pointsWrittenOK and write.valuesWrittenOK from the table of contents and the write section.
  • Removed write.subWriteDrop from the table of contents and the write section.
  • Removed the <!-- VERIFY (live instance) --> comment that a prior PR (fix(platform): verify InfluxDB _internal fields against live v1.13.0 #7685) added, including its "unconfirmed" note about hh_database. hh_database itself stays documented; only the caveat is gone.

In content/influxdb/v1/about_the_project/release-notes.md:

  • Updated the v1.8.3 release note that linked to measurements-internal/#valueswrittenok. That anchor no longer exists once both valuesWrittenOK headings are removed, so the link now points to measurements-internal/#httpd.

Why

Issue #7684 asked engineering to confirm whether five _internal stat fields still exist in InfluxDB v1. @davidby-influx confirmed on the issue thread:

  • httpd.valuesWrittenOK — declared in services/httpd/service.go but never emitted; its use was removed in 1.9.0.
  • write.subWriteDrop — removed for 1.10.0.
  • write.pointsWrittenOK and write.valuesWrittenOK — never existed. httpd.pointsWrittenOK is the closest analog and is already documented.
  • hh_database — confirmed to exist in the Enterprise hinted-handoff service, so it stays documented.

This content is shared between influxdb/v1 and enterprise_influxdb/v1 through content/shared/, so the fix applies to both products in one file.

Impact

Readers of the InfluxDB v1 and Enterprise v1 internal-monitoring documentation will no longer see four fields that don't exist in current InfluxDB v1 releases. The release-notes link to measurements-internal no longer 404s on the removed anchor.

Verification

No live-instance verification was run in this change. The removals are based on direct inspection of the InfluxDB source at commit 8a2663add71ed729e1cc6e465f754e8beea8d541:

  • services/httpd/service.go declares statValuesWrittenOK but no Statistics map emits it; only statPointsWrittenOK is emitted, in handler.go.
  • coordinator/points_writer.go lists the complete write module stat key set (req, pointReq, pointReqLocal, writeOk, writeDrop, writeTimeout, writeError, subWriteOk) — no pointsWrittenOK, valuesWrittenOK, or subWriteDrop.

hh_database's continued existence was confirmed by engineering against the private Enterprise hinted-handoff service source, cited in the issue thread.

Confirmed by grep that the shared source file no longer contains any of the four removed field names or the VERIFY note, and that httpd.pointsWrittenOK and hh_database remain documented.

Out of scope: the four retired fields are still described on content/telegraf/v1/input-plugins/influxdb.md, which syncs from the upstream Telegraf plugin README and isn't editable in this repository. That needs a separate upstream fix.

Checklist

Note

The source issue was chosen as a test of the docs-tooling triage-pipeline end-to-end.
This PR was generated by the pipeline.

…nts-internal

httpd.valuesWrittenOK, write.pointsWrittenOK, write.valuesWrittenOK, and
write.subWriteDrop no longer exist in InfluxDB v1's _internal measurements.
Engineering confirmed on #7684 that httpd.valuesWrittenOK
was declared but never emitted (removed in 1.9.0), write.subWriteDrop was
removed for 1.10.0, and the two write.*WrittenOK fields never existed.
hh_database is confirmed to exist in Enterprise's hinted-handoff service,
so it stays documented without the prior "unconfirmed" caveat.

Closes #7684
@jstirnaman
jstirnaman requested a review from a team as a code owner September 2, 2026 03:26
@jstirnaman
jstirnaman requested review from sanderson and removed request for a team September 2, 2026 03:26
@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Vale Style Check Results

Metric Count
Errors 10
Warnings 12

Errors (blocking)

File Line Rule Message
content/influxdb/v1/about_the_project/release-notes.md 634 Google.Spacing 't.P' should have one space.
content/influxdb/v1/about_the_project/release-notes.md 737 Google.Spacing 'e.G' should have one space.
content/influxdb/v1/about_the_project/release-notes.md 950 Google.Spacing 'e.D' should have one space.
content/influxdb/v1/about_the_project/release-notes.md 956 Google.Spacing 'r.C' should have one space.
content/influxdb/v1/about_the_project/release-notes.md 958 Google.Spacing 'e.C' should have one space.
content/influxdb/v1/about_the_project/release-notes.md 968 Google.Spacing 't.M' should have one space.
content/influxdb/v1/about_the_project/release-notes.md 1011 Google.Spacing 'e.D' should have one space.
content/influxdb/v1/about_the_project/release-notes.md 1171 Google.Spacing 'l.M' should have one space.
content/influxdb/v1/about_the_project/release-notes.md 1208 Google.Spacing 'y.E' should have one space.
content/influxdb/v1/about_the_project/release-notes.md 1227 Google.Spacing 'y.E' should have one space.
Warnings (12)
File Line Rule Message
content/influxdb/v1/about_the_project/release-notes.md 163 InfluxDataDocs.Spelling Did you really mean 'buildtsi'?
content/influxdb/v1/about_the_project/release-notes.md 588 InfluxDataDocs.Spelling Did you really mean 'inmem'?
content/influxdb/v1/about_the_project/release-notes.md 664 InfluxDataDocs.Spelling Did you really mean 'inmem'?
content/influxdb/v1/about_the_project/release-notes.md 932 InfluxDataDocs.Spelling Did you really mean 'deletetsm'?
content/influxdb/v1/about_the_project/release-notes.md 1050 Google.Colons ': W' should be in lowercase.
content/influxdb/v1/about_the_project/release-notes.md 1192 InfluxDataDocs.Spelling Did you really mean 'dereference'?
content/influxdb/v1/about_the_project/release-notes.md 1237 InfluxDataDocs.Spelling Did you really mean 'dereference'?
content/influxdb/v1/about_the_project/release-notes.md 1355 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb/v1/about_the_project/release-notes.md 1634 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb/v1/about_the_project/release-notes.md 1855 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb/v1/about_the_project/release-notes.md 1857 Google.Colons ': E' should be in lowercase.
content/influxdb/v1/about_the_project/release-notes.md 1867 InfluxDataDocs.Spelling Did you really mean 'ident'?

Check failed — fix 10 error(s) before merging.

@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Release version check

Product Release notes data/products.yml Status
influxdb (latest_patches.v1) 1.13.0 1.13.0 ✅ in sync

💡 Badge new features with the version

Documenting a new feature? Add a version badge in the page frontmatter — the
same mechanism used elsewhere in the docs:

  • metadata: [InfluxDB 3 Core v3.11+] — badge list under the page title
  • updated_in: v3.11 — an "Updated in v3.11" badge
  • introduced: v3.11 — a "‹Product› v3.11+" badge
  • menu.params.state: new — a "NEW" pill on the sidebar nav item

For inline version text, use {{< latest-patch >}} / {{< current-version >}},
which read the value from data/products.yml so it stays correct automatically.

@github-actions github-actions Bot added product:shared Shared content across products product:v1 InfluxDB v1 OSS product:v1-enterprise InfluxDB Enterprise v1 labels Sep 2, 2026
@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

🔗 Link Check Results — Link Check Bot

10 broken link(s) found — fix them before merging.

Metric Value
Files Checked 3
Total Links 1322
Errors 10
Warnings 11
Success Rate 97.881996%

Broken Links

Source File Broken URL Error Report
content/influxdb/v1/administration/monitor/measurements-internal/_index.md #hh-database-enterprise-only Fragment not found: #hh-database-enterprise-only Report
content/influxdb/v1/administration/monitor/measurements-internal/_index.md #tsm1-cache Fragment not found: #tsm1-cache Report
content/influxdb/v1/administration/monitor/measurements-internal/_index.md #tsm1-engine Fragment not found: #tsm1-engine Report
content/influxdb/v1/administration/monitor/measurements-internal/_index.md #tsm1-filestore Fragment not found: #tsm1-filestore Report
content/influxdb/v1/administration/monitor/measurements-internal/_index.md #tsm1-wal Fragment not found: #tsm1-wal Report
content/enterprise_influxdb/v1/administration/monitor/measurements-internal/_index.md #hh-database-enterprise-only Fragment not found: #hh-database-enterprise-only Report
content/enterprise_influxdb/v1/administration/monitor/measurements-internal/_index.md #tsm1-cache Fragment not found: #tsm1-cache Report
content/enterprise_influxdb/v1/administration/monitor/measurements-internal/_index.md #tsm1-engine Fragment not found: #tsm1-engine Report
content/enterprise_influxdb/v1/administration/monitor/measurements-internal/_index.md #tsm1-filestore Fragment not found: #tsm1-filestore Report
content/enterprise_influxdb/v1/administration/monitor/measurements-internal/_index.md #tsm1-wal Fragment not found: #tsm1-wal Report
⚠️ 11 warning(s) (do not fail CI)
Source File URL Issue
content/enterprise_influxdb/v1/administration/monitor/measurements-internal/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb/v1/about_the_project/release-notes/_index.md file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v1/api/debug File not found. Check if file exists and path is correct: File not found. Check …
content/influxdb/v1/about_the_project/release-notes/_index.md file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v1/api/debug File not found. Check if file exists and path is correct: File not found. Check …
content/influxdb/v1/about_the_project/release-notes/_index.md file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v1/api/buckets-v2-compatible File not found. Check if file exists and path is correct: File not found. Check …
content/influxdb/v1/about_the_project/release-notes/_index.md file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v1/api/delete-v2-compatible File not found. Check if file exists and path is correct: File not found. Check …
content/influxdb/v1/about_the_project/release-notes/_index.md file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v1/api/query File not found. Check if file exists and path is correct: File not found. Check …
content/influxdb/v1/about_the_project/release-notes/_index.md file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v1/api/delete-v2-compatible File not found. Check if file exists and path is correct: File not found. Check …
content/influxdb/v1/about_the_project/release-notes/_index.md file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v1/api/buckets-v2-compatible File not found. Check if file exists and path is correct: File not found. Check …
content/influxdb/v1/about_the_project/release-notes/_index.md file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v1/api/debug File not found. Check if file exists and path is correct: File not found. Check …
content/influxdb/v1/about_the_project/release-notes/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb/v1/administration/monitor/measurements-internal/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…

Full details: workflow run summary and artifact. Last updated: 2026-09-04 16:47:45 UTC

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.

🟡 Changes recommended

The v1.8.3 release-note bullet still claims “track number of values” but now links to #httpd, which doesn’t contain a values-written stat; it should be corrected to point to (and describe) pointsWrittenOK.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Removes _internal stat fields that engineering confirmed are retired or never emitted from the shared InfluxDB v1 internal-monitoring documentation, and updates a v1.8.3 release-notes link to avoid pointing at a removed anchor.

Changes:

  • Removed httpd.valuesWrittenOK, write.pointsWrittenOK, write.valuesWrittenOK, and write.subWriteDrop from the _internal measurements reference (including TOC entries and field sections).
  • Removed the prior inline “VERIFY (live instance)” caveat block now that #7684 has been resolved.
  • Updated a v1.8.3 release-note link away from the removed #valueswrittenok anchor.
File summaries
File Description
content/shared/influxdb-v1/administration/monitor/measurements-internal.md Drops retired/never-emitted _internal fields (and associated TOC entries) from the shared v1 monitoring reference.
content/influxdb/v1/about_the_project/release-notes.md Adjusts the v1.8.3 release-note link target to avoid a removed anchor in measurements-internal.
Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread content/influxdb/v1/about_the_project/release-notes.md Outdated
@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

📦 PR Preview — Preview Bot

Status Details
Result ✅ DEPLOYED (full site)
Preview View preview
Build time 92s
Last updated 2026-09-04 16:49:29 UTC
Changed pages (3)

Preview auto-deploys on push. Will be cleaned up when PR closes.

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:shared Shared content across products product:v1-enterprise InfluxDB Enterprise v1 product:v1 InfluxDB v1 OSS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Verify possibly-retired InfluxDB _internal fields: httpd.valuesWrittenOK, write.pointsWrittenOK/subWriteDrop/valuesWrittenOK, hh_database

3 participants