Skip to content

update management env vars with NB_PPROF_ADDR#854

Merged
pascal-fischer merged 2 commits into
mainfrom
add-pprof-addr-env-var
Jul 15, 2026
Merged

update management env vars with NB_PPROF_ADDR#854
pascal-fischer merged 2 commits into
mainfrom
add-pprof-addr-env-var

Conversation

@pascal-fischer

@pascal-fischer pascal-fischer commented Jul 15, 2026

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation
    • Added documentation for the NB_PPROF_ADDR runtime environment variable, including its use for enabling pprof on a specified address.

@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The self-hosted environment variable documentation now lists NB_PPROF_ADDR as an advanced runtime variable for enabling pprof on a specified address.

Changes

Self-hosted runtime documentation

Layer / File(s) Summary
Document NB_PPROF_ADDR
src/pages/selfhosted/environment-variables.mdx
Adds NB_PPROF_ADDR to the Advanced Runtime Variables table.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Poem

I’m a rabbit with a doc to share,
Pprof now has an address there.
NB_PPROF_ADDR joins the row,
Clear runtime notes now neatly grow—
Hop, hop, shipped with care!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: adding NB_PPROF_ADDR to the management environment variables docs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch add-pprof-addr-env-var

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint install failed: one or more packages not found in the registry.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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

🧹 Nitpick comments (1)
src/pages/selfhosted/environment-variables.mdx (1)

133-133: 🔒 Security & Privacy | 🔵 Trivial | ⚡ Quick win

Clarify the pprof endpoint and exposure risk.

Document that this starts a Go pprof HTTP endpoint, include an address example such as localhost:6060, and advise restricting externally reachable bindings. The existing client documentation already provides this more actionable description.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/pages/selfhosted/environment-variables.mdx` at line 133, Update the
NB_PPROF_ADDR entry in the environment-variable documentation to state that it
starts a Go pprof HTTP endpoint, include a localhost:6060 address example, and
advise binding only to restricted or non-public interfaces when external
exposure is not intended.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@src/pages/selfhosted/environment-variables.mdx`:
- Line 133: Update the NB_PPROF_ADDR entry in the environment-variable
documentation to state that it starts a Go pprof HTTP endpoint, include a
localhost:6060 address example, and advise binding only to restricted or
non-public interfaces when external exposure is not intended.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5a16defb-ea09-4706-828e-6f3a744a5f67

📥 Commits

Reviewing files that changed from the base of the PR and between 32fcf94 and 3a08f50.

📒 Files selected for processing (1)
  • src/pages/selfhosted/environment-variables.mdx

@pascal-fischer
pascal-fischer merged commit 37d20b2 into main Jul 15, 2026
3 checks passed
@pascal-fischer
pascal-fischer deleted the add-pprof-addr-env-var branch July 15, 2026 10:05
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.

2 participants