Skip to content

docs: remove expose_trace references - #775

Merged
shiva-istari merged 1 commit into
mainfrom
matthewmcneely/remove-expose-trace-refs
Oct 22, 2026
Merged

shiva-istari merged 1 commit into
mainfrom
matthewmcneely/remove-expose-trace-refs

Conversation

@matthewmcneely

@matthewmcneely matthewmcneely commented Sep 21, 2026 •

Copy link
Copy Markdown
Collaborator

Description

dgraph-io/dgraph#9593 removes the expose_trace flag from Dgraph. This PR clears the references to it here, and fixes a long-standing inaccuracy on the debug-information page.

docs-learn/howto/retrieving-debug-information.md

The Metrics section said you need --expose_trace=true to collect /debug/vars from outside the instance, and that it's localhost-only otherwise. That was never true. /debug/vars is served through x.SanitizedDefaultServeMux(), which routes it straight to filteredExpvarHandler with no source-IP check, so anyone who can reach the Alpha or Zero HTTP port can already read it. expose_trace only ever set trace.AuthRequest for the golang.org/x/net/trace endpoints (/debug/requests and /debug/events).

Replaced with what actually happens, plus a note to restrict the port at the network layer if you don't want the metrics public.

installation/lambda-server.md

--expose_trace in the Docker example is copy-paste cruft. It has nothing to do with the lambda server, and pasting it into a production compose file exposes the trace endpoints to any remote caller with sensitive data included. The command behaves identically without it.

Removed from the current page and from the five versioned copies. The flag is valid in those released versions, so this isn't a correctness fix for them, but it's a bad example to ship in any of them. Happy to narrow this to docs/ only if you'd rather leave the version snapshots frozen.

Related

🤖 Generated with Claude Code


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

The `expose_trace` flag is being removed from Dgraph in
dgraph-io/dgraph#9593. Drop it from the lambda-server Docker example and
correct the metrics section of the debug-information page, which
described the flag as gating `/debug/vars`. It never did.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@shiva-istari
shiva-istari force-pushed the matthewmcneely/remove-expose-trace-refs branch from f1e1927 to 8993b6c Compare October 22, 2026 06:54
@shiva-istari
shiva-istari merged commit 3f2d731 into main Oct 22, 2026
4 checks passed
@shiva-istari
shiva-istari deleted the matthewmcneely/remove-expose-trace-refs branch October 22, 2026 07:01
shiva-istari added a commit that referenced this pull request Oct 23, 2026
Cuts the v25.5 documentation version and promotes it to the version
served at the site root, matching the
[v25.5.0](https://github.com/dgraph-io/dgraph/releases/tag/v25.5.0)
release (2026-10-13).

## Summary

- Snapshots `docs/` into `docs_versioned_docs/version-v25.5/` and
`docs-graphql/` into `graphql_versioned_docs/version-v25.5/`, via
`docs:version:docs` and `docs:version:graphql`.
- Sets `lastVersion: 'v25.5'` on both content plugins, with v25.5 at
path `''` and v25.4 moved to `v25.4`.
- Updates the version examples in `README.md`.

The snapshot carries the user-facing docs for v25.5.0 that landed on
`main` ahead of the cut:

- `--security anonymous` (#778)
- `dgraph bulk --tablet_placement` (#779) and `dgraph zero
--rebalance_interval=0` (#780)
- Removal of the `expose_trace` references (#775)
- `listBackups` / `lsbackup` date filtering and `fullManifest` (#755)

## Also in here: unreleased markers for `anonymous`

`main` still labeled the `anonymous` option as unreleased in three
places (`admin/security/anonymous-access.md`, `cli/superflags.md`,
`cli/zero.md`). @shiva-istari's commit from
`shiva/anonymous-option-released` removes them. It never got its own PR,
so I cherry-picked it ahead of the cut (eff4e34, authorship preserved)
to keep the markers out of the v25.5 snapshot.

## Follow-up

The `listBackups` / `lsbackup` features from #755 shipped in dgraph
#9693, which is in every tag from v25.3.4 on. The v25.4 and v25.3
snapshots don't have that content, and it should be backported in a
separate PR.

## URL movement

| Path | Before | After |
|------|--------|-------|
| `/<page>` | v25.4 | v25.5 |
| `/v25.4/<page>` | 404 | v25.4 |
| `/graphql/<page>` | v25.4 | v25.5 |
| `/graphql/v25.4/<page>` | 404 | v25.4 |

## Testing

`npm run build` passes. With `onBrokenLinks: 'throw'`, a clean build is
the link check across all six versions. Verified against the generated
output in `build/`:

- `/` and `/graphql/` both render **v25.5 (latest)**, with v25.4, v25.3,
v25.2, v25.1, and v24.1 in the dropdown.
- `/cli/lsbackup` includes the new `--since-date` flags;
`/v25.4/cli/lsbackup` does not (see Follow-up).
- The v25.5 `anonymous-access` page has no unreleased banner.
- Older-version paths under `/v25.4/`, `/v25.3/`, `/v24.1/`,
`/graphql/v25.4/`, and `/graphql/v25.3/` resolve.

---------

Co-authored-by: Shivaji Kharse <skharse.ctr@istaridigital.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants