Doc mongo dashboards improvements #4849
Open
+477
−63
Conversation
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
* Add AI agent configuration files for PMM components (#4817) * Initial plan * Add AI agent configuration files from PR #4683 Extract copilot-instructions.md and AGENT.md files that provide guidelines for AI coding agents working with the PMM codebase. Co-authored-by: ademidoff <81549+ademidoff@users.noreply.github.com> * chore: improve the AI guide * Add purpose section and clarify component-specific AGENT.md convention - Add Purpose section explaining what problem this PR solves - Clarify that each PMM component can have its own AGENT.md file - Provide examples of potential future AGENT.md locations - Make it explicit that this is a per-component pattern Co-authored-by: ademidoff <81549+ademidoff@users.noreply.github.com> * Make documentation evergreen by removing PR-specific language Remove "This PR extracts" phrasing to make the documentation timeless and relevant after the PR is merged. Co-authored-by: ademidoff <81549+ademidoff@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: ademidoff <81549+ademidoff@users.noreply.github.com> Co-authored-by: Alex Demidoff <a@demidoff.me> Co-authored-by: Alex Demidoff <alexander.demidoff@percona.com> * Bump actions/cache from 4.3.0 to 5.0.0 (#4832) Bumps [actions/cache](https://github.com/actions/cache) from 4.3.0 to 5.0.0. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](actions/cache@0057852...a783357) --- updated-dependencies: - dependency-name: actions/cache dependency-version: 5.0.0 dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump github.com/golang-migrate/migrate/v4 from 4.18.1 to 4.19.1 (#4791) * Bump github.com/golang-migrate/migrate/v4 from 4.18.1 to 4.19.1 Bumps [github.com/golang-migrate/migrate/v4](https://github.com/golang-migrate/migrate) from 4.18.1 to 4.19.1. - [Release notes](https://github.com/golang-migrate/migrate/releases) - [Commits](golang-migrate/migrate@v4.18.1...v4.19.1) --- updated-dependencies: - dependency-name: github.com/golang-migrate/migrate/v4 dependency-version: 4.19.1 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * fix: replace the older tink repo with its successor --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Alex Demidoff <a@demidoff.me> * [DOC] agent-env-vars flag for MongoDB * typo * Update documentation/docs/install-pmm/install-pmm-client/connect-database/mongodb.md Co-authored-by: Michael Okoko <10512379+idoqo@users.noreply.github.com> * Update documentation/docs/use/commands/pmm-admin.md Co-authored-by: Michael Okoko <10512379+idoqo@users.noreply.github.com> * Update documentation/docs/use/commands/pmm-admin.md Co-authored-by: Michael Okoko <10512379+idoqo@users.noreply.github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: ademidoff <81549+ademidoff@users.noreply.github.com> Co-authored-by: Alex Demidoff <a@demidoff.me> Co-authored-by: Alex Demidoff <alexander.demidoff@percona.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Michael Okoko <10512379+idoqo@users.noreply.github.com>
catalinaadam
requested review from
BupycHuk,
ademidoff,
idoqo and
maxkondr
and removed request for
a team
catalinaadam
requested review from
Copilot
and removed request for
a team,
BupycHuk,
ademidoff,
idoqo and
maxkondr
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates documentation, fixes a deprecated import, updates dependencies, and adds a new AGENT.md file for AI developer guidelines. The changes primarily focus on documenting the new --agent-env-vars flag for MongoDB monitoring and establishing development guidelines for AI agents working with the PMM codebase.
Key Changes
- Added comprehensive AI agent development guidelines in
managed/AGENT.mdand.github/copilot-instructions.md - Documented the new
--agent-env-varsflag for MongoDB monitoring in user documentation and release notes - Updated deprecated
github.com/google/tink/goimport togithub.com/tink-crypto/tink-go/tink
Reviewed changes
Copilot reviewed 14 out of 15 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| managed/AGENT.md | New AI agent development guidelines for pmm-managed component |
| .github/copilot-instructions.md | New general AI agent guidelines for PMM repository |
| documentation/docs/use/commands/pmm-admin.md | Added documentation for --agent-env-vars flag |
| documentation/docs/release-notes/3.6.0.md | New release notes documenting improvements and fixes |
| documentation/docs/install-pmm/install-pmm-client/connect-database/mongodb.md | Added example of using --agent-env-vars flag |
| managed/utils/encryption/encryption.go | Fixed deprecated tink import |
| go.mod | Updated dependencies to newer versions |
| .github/workflows/*.yml | Updated actions/cache from v4.3.0 to v5.0.0 |
|
|
||
|
|
||
|
|
||
| ## 🚀 Ready to upgrade to PMM 3.5.0? |
There was a problem hiding this comment.
The heading references version 3.5.0, but this is the 3.6.0 release notes. This should be updated to 'Ready to upgrade to PMM 3.6.0?'
Suggested change
| ## 🚀 Ready to upgrade to PMM 3.5.0? | |
| ## 🚀 Ready to upgrade to PMM 3.6.0? |
ademidoff
temporarily deployed
to
Doc_Mongo_dashboards_improvements - pmm-doc-3 PR #4849
Render
Destroyed
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.
PMM-0
Link to the Feature Build: SUBMODULES-0
If this PR adds, removes or alters one or more API endpoints, please review and add or update the relevant API documentation as well:
If this PR is related to some other PRs in this or other repositories, please provide links to those PRs: