docs: added paragraph about vmsingle scraping#1895
Merged
Conversation
Contributor
There was a problem hiding this comment.
1 issue found across 5 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/resources/vmsingle.md">
<violation number="1" location="docs/resources/vmsingle.md:81">
P3: The inline code span for `Selector` is missing a closing backtick, which breaks Markdown rendering in the table row.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
6b67f7f to
562394b
Compare
vrutkovs
reviewed
Feb 27, 2026
docs/resources/vmsingle.md
Outdated
Comment on lines
+47
to
+48
| These objects tell VMSingle from which targets and how to collect metrics and | ||
| generate part of [VMSingle](https://docs.victoriametrics.com/victoriametrics/vmsingle/) scrape configuration. |
Collaborator
There was a problem hiding this comment.
Suggested change
| These objects tell VMSingle from which targets and how to collect metrics and | |
| generate part of [VMSingle](https://docs.victoriametrics.com/victoriametrics/vmsingle/) scrape configuration. | |
| These objects specify which targets VMSingle should scrape and how to collect metrics, | |
| and generate part of the [VMSingle](https://docs.victoriametrics.com/victoriametrics/vmsingle/) scrape configuration. |
docs/resources/vmsingle.md
Outdated
| These objects tell VMSingle from which targets and how to collect metrics and | ||
| generate part of [VMSingle](https://docs.victoriametrics.com/victoriametrics/vmsingle/) scrape configuration. | ||
|
|
||
| To enable scraping on VMSingle just need to set `spec.ingestOnlyMode: false`. |
Collaborator
There was a problem hiding this comment.
Suggested change
| To enable scraping on VMSingle just need to set `spec.ingestOnlyMode: false`. | |
| To enable scraping on VMSingle, set `spec.ingestOnlyMode` to `false`. |
docs/resources/vmsingle.md
Outdated
Comment on lines
+52
to
+53
| For filtering scrape objects `VMSingle` uses selectors. | ||
| Selectors are defined with suffixes - `NamespaceSelector` and `Selector` for each type of scrape objects in spec of `VMSingle`: |
Collaborator
There was a problem hiding this comment.
Suggested change
| For filtering scrape objects `VMSingle` uses selectors. | |
| Selectors are defined with suffixes - `NamespaceSelector` and `Selector` for each type of scrape objects in spec of `VMSingle`: | |
| `VMSingle` uses selectors to filter scrape objects. Selectors are defined using the `NamespaceSelector` and `Selector` suffixes for each scrape object type in the VMSingle spec: |
docs/resources/vmsingle.md
Outdated
| For filtering scrape objects `VMSingle` uses selectors. | ||
| Selectors are defined with suffixes - `NamespaceSelector` and `Selector` for each type of scrape objects in spec of `VMSingle`: | ||
|
|
||
| - `serviceScrapeNamespaceSelector` and `serviceScrapeSelector` for selecting [VMServiceScrape](https://docs.victoriametrics.com/operator/resources/vmservicescrape/) objects, |
Collaborator
There was a problem hiding this comment.
Suggested change
| - `serviceScrapeNamespaceSelector` and `serviceScrapeSelector` for selecting [VMServiceScrape](https://docs.victoriametrics.com/operator/resources/vmservicescrape/) objects, | |
| - `serviceScrapeNamespaceSelector` and `serviceScrapeSelector` for [VMServiceScrape](https://docs.victoriametrics.com/operator/resources/vmservicescrape/) objects, |
docs/resources/vmsingle.md
Outdated
| Selectors are defined with suffixes - `NamespaceSelector` and `Selector` for each type of scrape objects in spec of `VMSingle`: | ||
|
|
||
| - `serviceScrapeNamespaceSelector` and `serviceScrapeSelector` for selecting [VMServiceScrape](https://docs.victoriametrics.com/operator/resources/vmservicescrape/) objects, | ||
| - `podScrapeNamespaceSelector` and `podScrapeSelector` for selecting [VMPodScrape](https://docs.victoriametrics.com/operator/resources/vmpodscrape/) objects, |
Collaborator
There was a problem hiding this comment.
Suggested change
| - `podScrapeNamespaceSelector` and `podScrapeSelector` for selecting [VMPodScrape](https://docs.victoriametrics.com/operator/resources/vmpodscrape/) objects, | |
| - `podScrapeNamespaceSelector` and `podScrapeSelector` for [VMPodScrape](https://docs.victoriametrics.com/operator/resources/vmpodscrape/) objects, |
docs/resources/vmsingle.md
Outdated
| Following rules are applied: | ||
|
|
||
| - If `...NamespaceSelector` and `...Selector` both undefined, then by default select nothing. With option set - `spec.selectAllByDefault: true`, select all objects of given type. | ||
| - If `...NamespaceSelector` defined, `...Selector` undefined, then all objects are matching at namespaces for given `...NamespaceSelector`. |
Collaborator
There was a problem hiding this comment.
Suggested change
| - If `...NamespaceSelector` defined, `...Selector` undefined, then all objects are matching at namespaces for given `...NamespaceSelector`. | |
| - If `...NamespaceSelector` is defined and `...Selector` is undefined, all objects in the namespaces matched by ...NamespaceSelector are selected. |
docs/resources/vmsingle.md
Outdated
|
|
||
| - If `...NamespaceSelector` and `...Selector` both undefined, then by default select nothing. With option set - `spec.selectAllByDefault: true`, select all objects of given type. | ||
| - If `...NamespaceSelector` defined, `...Selector` undefined, then all objects are matching at namespaces for given `...NamespaceSelector`. | ||
| - If `...NamespaceSelector` undefined, `...Selector` defined, then all objects at `VMSingle`'s namespaces are matching for given `...Selector`. |
Collaborator
There was a problem hiding this comment.
Suggested change
| - If `...NamespaceSelector` undefined, `...Selector` defined, then all objects at `VMSingle`'s namespaces are matching for given `...Selector`. | |
| - If `...NamespaceSelector` is undefined and `...Selector` is defined, all objects in VMSingle’s namespaces matching ...Selector are selected. |
docs/resources/vmsingle.md
Outdated
| - If `...NamespaceSelector` and `...Selector` both undefined, then by default select nothing. With option set - `spec.selectAllByDefault: true`, select all objects of given type. | ||
| - If `...NamespaceSelector` defined, `...Selector` undefined, then all objects are matching at namespaces for given `...NamespaceSelector`. | ||
| - If `...NamespaceSelector` undefined, `...Selector` defined, then all objects at `VMSingle`'s namespaces are matching for given `...Selector`. | ||
| - If `...NamespaceSelector` and `...Selector` both defined, then only objects at namespaces matched `...NamespaceSelector` for given `...Selector` are matching. |
Collaborator
There was a problem hiding this comment.
Suggested change
| - If `...NamespaceSelector` and `...Selector` both defined, then only objects at namespaces matched `...NamespaceSelector` for given `...Selector` are matching. | |
| - If `...NamespaceSelector` and `...Selector` both are defined, then only objects in the namespaces matched by...NamespaceSelector for the given ...Selector are matching. |
docs/resources/vmsingle.md
Outdated
| - If `...NamespaceSelector` undefined, `...Selector` defined, then all objects at `VMSingle`'s namespaces are matching for given `...Selector`. | ||
| - If `...NamespaceSelector` and `...Selector` both defined, then only objects at namespaces matched `...NamespaceSelector` for given `...Selector` are matching. | ||
|
|
||
| Here's a more visual and more detailed view: |
Collaborator
There was a problem hiding this comment.
Suggested change
| Here's a more visual and more detailed view: | |
| Below is a more visual and detailed view: |
docs/resources/vmsingle.md
Outdated
| | *any* | undefined | *any* | **defined** | all objects of given type (`...`) only at `VMSingle`'s namespace | | ||
| | *any* | **defined** | *any* | **defined** | all objects of given type (`...`) only at `VMSingle`'s namespace for given `...Selector` | | ||
|
|
||
| More details about `WATCH_NAMESPACE` variable you can read in [this doc](https://docs.victoriametrics.com/operator/configuration/#namespaced-mode). |
Collaborator
There was a problem hiding this comment.
Suggested change
| More details about `WATCH_NAMESPACE` variable you can read in [this doc](https://docs.victoriametrics.com/operator/configuration/#namespaced-mode). | |
| For more details about the `WATCH_NAMESPACE` variable, see [this doc](https://docs.victoriametrics.com/operator/configuration/#namespaced-mode). |
562394b to
9fd1e0c
Compare
9fd1e0c to
1e73978
Compare
Contributor
Author
|
@vrutkovs |
vrutkovs
approved these changes
Feb 27, 2026
vrutkovs
pushed a commit
that referenced
this pull request
Mar 3, 2026
AndrewChubatiuk
added a commit
that referenced
this pull request
Mar 3, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
added scraping section to vmsingle docs
Summary by cubic
Added a “Scraping” section to VMSingle docs explaining how to enable scraping (ingestOnlyMode: false), listing supported scrape objects, and outlining selector rules (selectAllByDefault, WATCH_NAMESPACE) with examples to scope targets.
Also updated availability tags to mark operator-only features, renamed “Custom resources” to “Resources,” and cleaned up selector docs (including link updates) and minor formatting.
Written for commit 1e73978. Summary will update on new commits.