ROX-32449: mention include and exclude filters (custom Prometheus metrics)#104926
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@parametalol: This pull request references ROX-32449 which is a valid jira issue. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
1 similar comment
|
@parametalol: This pull request references ROX-32449 which is a valid jira issue. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci
Bot
added
size/XS
|
Hi @parametalol. Thanks for your PR. I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
/ok-to-test |
openshift-ci
Bot
added
ok-to-test
kcarmichael08
added
RHACS
kcarmichael08
left a comment
kcarmichael08
left a comment
There was a problem hiding this comment.
one suggestion; otherwise, lgtm!
kcarmichael08
added
the
peer-review-done
|
🤖 Mon Feb 02 09:17:52 - Prow CI generated the docs preview: https://104926--ocpdocs-pr.netlify.app/openshift-acs/latest/configuration/monitor-acs.html |
| Each category is configured with a data gathering period and a list of metrics. A metric is associated with a set of labels and their filters. The label filters are regular expressions, applied to the values before aggregation. You can use them to reduce the `/metrics` output to only relevant records. For example, you can use the filter expression `ACTIVE` for label "State" of a policy violation metric to aggregate only active policy violation alerts. | ||
| Each category is configured with a data gathering period and a list of metrics. A metric is associated with a set of labels and their include and exclude filters. The label filters are regular expressions, applied to the values before aggregation. | ||
|
|
||
| You can use the filters to reduce the /metrics output to relevant records. Use include filters to count only values that match and exclude filters to ignore values that do not match. For example, include filter `ACTIVE` for label "State" to aggregate only active policy violation alerts, or exclude filter `false` for label "IsPlatformWorkload" to exclude platform workload vulnerabilities. |
There was a problem hiding this comment.
If we are going to keep the / with metrics (I am not sure why it is there) then I think it should be set off with backticks. Otherwise, no formatting and just use "metrics" if we are just talking about normal metrics output. Does that make sense? I want to avoid our publishing system possible interpreting the / as something other than text.
There was a problem hiding this comment.
The /metrics spelling suggests the URL path of the metrics service. Full URL would read like https://central-api-endpoint/metrics.
See, for another example, modules/vulnerability-management-export-workloads.adoc:
The export uses the
/v1/export/vuln-mgmt/workloadsstreaming API.
There was a problem hiding this comment.
Otherwise I like the paragraph split.
There was a problem hiding this comment.
OK, let's be consistent with how we are already doing it and leave it, then. :)
|
If you squash commits to one, I can merge. |
parametalol
force-pushed
the
michael/ROX-32449-include-and-exclude-filters
branch
from
3a35348 to
dfe6258
Compare
|
@parametalol: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
|
/cherrypick rhacs-docs-4.10 |
|
@kcarmichael08: new pull request created: #105816 DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
5 participants
Version(s):
Issue:
ROX-32449
Link to docs preview:
QE review:
Additional information:
This is an update after backend the filter feature improvement: the single "only matching" filter property (not released) is replaced with include and exclude filters to allow users to express pass ("only matching") and block filters ("everything except").