Skip to content

Conversation

jgarman
Copy link
Contributor

@jgarman jgarman commented Apr 20, 2017

No description provided.

Copy link

@DRoglic DRoglic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Suggested minor changes to descriptions of some fields

description: "Optional - Priority of the filter. Higher priority filters are guaranteed to be used first. Negative priorities can be used as well. Default priority is 0"
internal:
type: boolean
description: "Internally provided exclusion (ex. through alliance). Not yet implemented."
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would simply say:
description: This field is not used yet. Can be omitted.

description: "Optional - True to capture metrics for this filter even when disabled. Defaults to true. Note: If we are metering disabled filter, we will resort to metering small sample set to reduce performance impact"
hit_rate:
type: float
description: "measured 15-min hit rate for a given filter as a rate (e.g. 0.01 equals to 1% hit rate). Note that this metrics will be available only for filters that are enabled or have trackMetrics turned on. Also, this metrics counts hit rate of the process, based on pathFilters, commandLineFilters and md5Filters. It doesn't take into the account the individual event hit rate."
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should add note that this is a read-only field

description: "measured 15-min hit rate for a given filter as a rate (e.g. 0.01 equals to 1% hit rate). Note that this metrics will be available only for filters that are enabled or have trackMetrics turned on. Also, this metrics counts hit rate of the process, based on pathFilters, commandLineFilters and md5Filters. It doesn't take into the account the individual event hit rate."
name:
type: string
description: "Name of this filter - displayed in the UI"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't have UI for this feature yet, so comment "displayed in the UI" should be removed from both this and the next property

description: "Optional - Which OS should this filter apply to (bitfield mask: 1:windows, 2:osx, 4:linux). Defaults to 7 (all OSs)"
global:
type: boolean
description: "Optional - True to apply to all sensor groups. Defaults to true"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add the note that group_ids and sensor_ids fields are ignored if global is set to true

type: string
md5_filters:
type: array
description: "Optional - Array of MD5sums to filter."
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Array of MD5 checksums. Processes that match these MD5s will be filtered

@jgarman jgarman merged commit 4951277 into master May 1, 2017
@jgarman jgarman deleted the ingress-filter-6.1 branch May 1, 2017 13:23
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