Skip to content

Fix https://github.com/performancecopilot/pcp/issues/2562#2633

Open
christianhorn wants to merge 3 commits into
performancecopilot:mainfrom
christianhorn:push-docs
Open

Fix https://github.com/performancecopilot/pcp/issues/2562#2633
christianhorn wants to merge 3 commits into
performancecopilot:mainfrom
christianhorn:push-docs

Conversation

@christianhorn

Copy link
Copy Markdown
Collaborator

No description provided.

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Repository UI (inherited), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 099ad698-8f64-46b1-8c39-31e2203dec72

📥 Commits

Reviewing files that changed from the base of the PR and between 15be1a4 and 9f4f24e.

📒 Files selected for processing (1)
  • docs/using-the-push-model/index.rst
✅ Files skipped from review due to trivial changes (1)
  • docs/using-the-push-model/index.rst

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added a new technical note explaining how to use PCP’s pmlogger PUSH model, contrasting it with the PULL approach.
    • Included collector setup steps (PCP installation, enabling services, and TCP port configuration) and walkthroughs for pushing an existing archive and configuring continuous live metric streaming.

Walkthrough

A new documentation page describes PCP’s pmlogger PUSH model, including roles, collector setup, archive transfer with pmlogpush, and continuous metric forwarding using a remote logging configuration.

Changes

pmlogger PUSH model documentation

Layer / File(s) Summary
Introduction, roles, and PUSH model concept
docs/using-the-push-model/index.rst
Adds the page heading and intro, defines client and collector roles, contrasts PULL and PUSH collection, and notes PCP 7.0.3+ support.
Collector setup
docs/using-the-push-model/index.rst
Describes installing PCP, enabling pmcd and pmproxy, and allowing inbound TCP connections on port 44322.
Archive push example
docs/using-the-push-model/index.rst
Shows pmlogpush for an existing archive, the collector storage location, and directory-based verification.
Continuous push example
docs/using-the-push-model/index.rst
Shows replacing the local control config with a remote entry, restarting pmlogger, and verifying data with pcp output and pmlogsummary.

Possibly related issues

Poem

A rabbit hops where logs now stream,
From client to collector in a tidy beam.
pmlogpush thumps, then pmlogsummary sings,
And PUSH-model docs spread helpful wings.

🚥 Pre-merge checks | ✅ 3 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive No description was provided, so there is no meaningful summary of the changeset. Add a short description explaining the new PUSH model documentation and its purpose.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title is related to the actual change by referencing the issue being fixed, but it does not describe the docs update itself.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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.

Actionable comments posted: 5

🤖 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.

Inline comments:
In `@docs/using-the-push-model/index.rst`:
- Line 71: Fix the spelling error on line 71 in the documentation file where the
word "movifying" is misspelled. Change "movifying" to "modifying" in the
sentence that begins with "We are movifying an existing pmlogger config which
stores metrics locally in archive files:". This is a simple typo correction to
ensure the documentation uses correct English spelling.
- Line 21: Correct the spelling error in the documentation file by locating the
word "decomissioned" on line 21 and changing it to "decommissioned" (add the
missing 'm' to make it the correct spelling). The context is in a sentence about
removing pmlogger configuration when a client system is decommissioned.
- Line 11: The sentence containing "In most cases, for data collection systems
in 2 roles are used:" has awkward grammatical structure. Fix this by revising
the phrasing to improve clarity, such as replacing "for data collection systems
in 2 roles are used" with "for data collection, 2 roles are used" to create a
more grammatically correct and readable sentence.
- Line 39: The systemctl enable command on line 39 uses em-dashes (––now)
instead of regular hyphens (--now), which will cause the command to fail when
copy-pasted by users. Replace the em-dashes with two regular hyphens in the
`––now` argument to make the documented command functional and executable.
- Line 96: The command on line 96 contains an incorrect backslash escape
sequence before the `-4` argument. Remove the backslash escape before `-4` so
that the piped command to head reads as `head -4` without any escape characters.
The backslash is unnecessary and causes the argument to not be interpreted
correctly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Repository UI (inherited), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 58c8207d-bf31-4dab-be95-97b7a54571d7

📥 Commits

Reviewing files that changed from the base of the PR and between 1c256b8 and 715b0e4.

📒 Files selected for processing (1)
  • docs/using-the-push-model/index.rst

Comment thread docs/using-the-push-model/index.rst Outdated
Comment thread docs/using-the-push-model/index.rst Outdated
Comment thread docs/using-the-push-model/index.rst Outdated
Comment thread docs/using-the-push-model/index.rst Outdated
Comment thread docs/using-the-push-model/index.rst Outdated
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.

1 participant