public class HTTPRequestToggles extends Object
Constructor and Description |
---|
HTTPRequestToggles()
Initialize new
HTTPRequestToggles with defaults |
Modifier and Type | Method and Description |
---|---|
static HTTPRequestToggles |
fromPipelineOptions(HTTPRequest.HTTPRequestOptions o)
Initialize
HTTPRequestToggles using HTTPRequest pipeline options |
Long |
getAlertSuppressionDurationSeconds()
Get duration to suppress alerts (when using session windows)
|
Double |
getAnalysisThresholdModifier()
Get analysis threshold modifier
|
String |
getCidrExclusionList()
Get CIDR exclusion list path
|
Double |
getClampThresholdMaximum()
Get clamp threshold maximum
|
Boolean |
getEnableEndpointAbuseAnalysis()
Get endpoint abuse analysis setting
|
Boolean |
getEnableEndpointSequenceAbuseAnalysis()
Get endpoint abuse analysis setting
|
Boolean |
getEnableErrorRateAnalysis()
Get error rate analysis setting
|
Boolean |
getEnableHardLimitAnalysis()
Get hard limit analysis setting
|
Boolean |
getEnableNatDetection()
Get enable NAT detection setting
|
Boolean |
getEnablePerEndpointErrorRateAnalysis()
Get enable per endpoint error rate analysis setting
|
Boolean |
getEnableSessionLimitAnalysis()
Get enable session limit analysis setting
|
Boolean |
getEnableSourceCorrelator()
Get enable source correlator
|
Boolean |
getEnableStatusCodeRateAnalysis()
Get status code rate analysis setting
|
Boolean |
getEnableThresholdAnalysis()
Get threshold analysis setting
|
Boolean |
getEnableUserAgentBlocklistAnalysis()
Get user agent blocklist analysis setting
|
String[] |
getEndpointAbuseCustomVarianceSubstrings()
Get endpoint abuse custom variance substrings
|
Boolean |
getEndpointAbuseExtendedVariance()
Get endpoint abuse extended variance
|
String[] |
getEndpointAbusePath()
Get endpoint abuse path
|
Integer |
getEndpointAbuseSuppressRecovery()
Get endpoint abuse suppress recovery
|
String[] |
getEndpointSequenceAbusePatterns()
Get endpoint abuse path
|
Integer |
getEndpointSequenceAbuseSuppressRecovery()
Get endpoint abuse timing suppress recovery
|
Long |
getErrorSessionGapDurationMinutes()
Get session gap duration for session windows of only error events
|
String[] |
getFilterRequestPath()
Get filter request path
|
Long |
getHardLimitRequestCount()
Get hard limit request count
|
Boolean |
getIgnoreCloudProviderRequests()
Get ignore cloud provider requests
|
Boolean |
getIgnoreInternalRequests()
Get ignore internal requests
|
String[] |
getIncludeUrlHostRegex()
Get include URL host regex
|
String |
getKnownGatewaysPath()
Get path to list of inital nat gateways
|
Long |
getMaxClientErrorRate()
Get max client error rate
|
Long |
getMaxClientStatusCodeRate()
Get max client status code rate
|
String |
getMonitoredResource()
Get monitored resource
|
Long |
getPerEndpointErrorRateAlertSuppressionDurationSeconds()
Get alert suppression duration for per endpoint error rate
|
String[] |
getPerEndpointErrorRatePaths()
Get paths for per endpoint error rate analysis
|
Integer |
getPerEndpointErrorRateSuppressRecovery()
Get paths for per endpoint error rate analysis
|
Double |
getRequiredMinimumAverage()
Get required minimum average
|
Long |
getRequiredMinimumClients()
Get required minimum clients
|
Long |
getRequiredMinimumRequestsPerClient()
Get required minimum number of requests per client
|
Long |
getSessionGapDurationMinutes()
Get session gap duration minutes
|
String[] |
getSessionLimitAnalysisPaths()
Get session analysis pathes
|
Integer |
getSessionLimitAnalysisSuppressRecovery()
Get session limit analysis suppress recovery
|
Double |
getSourceCorrelatorAlertPercentage()
Get source correlator alert percentage
|
Integer |
getSourceCorrelatorMinimumAddresses()
Get source correlator minimum addresses
|
Integer |
getStatusCodeRateAnalysisCode()
Get code for client status code rate analysis
|
String |
getUserAgentBlocklistPath()
Get user agent blocklist path
|
void |
setAlertSuppressionDurationSeconds(Long value)
Set duration to suppress alerts (when using session windows)
|
void |
setAnalysisThresholdModifier(Double value)
Set analysis threshold modifier
|
void |
setCidrExclusionList(String value)
Set CIDR exclusion list path
|
void |
setClampThresholdMaximum(Double value)
Set clamp threshold maximum
|
void |
setEnableEndpointAbuseAnalysis(Boolean enableEndpointAbuseAnalysis)
Set endpoint abuse analysis setting
|
void |
setEnableEndpointSequenceAbuseAnalysis(Boolean enableEndpointSequenceAbuseAnalysis)
Set endpoint sequence abuse analysis
|
void |
setEnableErrorRateAnalysis(Boolean enableErrorRateAnalysis)
Set error rate analysis setting
|
void |
setEnableHardLimitAnalysis(Boolean enableHardLimitAnalysis)
Set hard limit analysis setting
|
void |
setEnableNatDetection(Boolean value)
Set enable NAT detection setting
|
void |
setEnablePerEndpointErrorRateAnaysis(Boolean value)
Set enable per endpoint error rate analysis setting
|
void |
setEnableSessionLimitAnalysis(Boolean enableSessionLimitAnalysis)
Set enable session limit analysis setting
|
void |
setEnableStatusCodeRateAnalysis(Boolean enableStatusCodeRateAnalysis)
Set enable status code rate analysis setting
|
void |
setEnableThresholdAnalysis(Boolean enableThresholdAnalysis)
Set threshold analysis setting
|
void |
setEnableUserAgentBlocklistAnalysis(Boolean enableUserAgentBlocklistAnalysis)
Set user agent blocklist analysis setting
|
void |
setEndpointAbuseCustomVarianceSubstrings(String[] value)
Set endpoint abuse custom variance substrings
|
void |
setEndpointAbuseExtendedVariance(Boolean value)
Set endpoint abuse extended variance
|
void |
setEndpointAbusePath(String[] value)
Set endpoint abuse path
|
void |
setEndpointAbuseSuppressRecovery(Integer value)
Set endpoint abuse suppress recovery
|
void |
setEndpointSequenceAbusePattern(String[] value)
Set endpoint abuse path
|
void |
setEndpointSequenceAbuseSuppressRecovery(Integer value)
Set endpoint abuse timing suppress recovery
|
void |
setErrorSessionGapDurationMinutes(Long errorSessionGapDurationMinutes)
Set session gap duration for session windows of only error events
|
void |
setFilterRequestPath(String[] value)
Set filter request path
|
void |
setHardLimitRequestCount(Long value)
Set hard limit request count
|
void |
setIgnoreCloudProviderRequests(Boolean value)
Set ignore cloud provider requests
|
void |
setIgnoreInternalRequests(Boolean value)
Set ignore internal requests
|
void |
setIncludeUrlHostRegex(String[] value)
Set include URL host regex
|
void |
setKnownGatewaysPath(String value)
Path to list of inital nat gateways
|
void |
setMaxClientErrorRate(Long value)
Set max client error rate
|
void |
setMaxClientStatusCodeRate(Long value)
Set max client status code rate
|
void |
setMonitoredResource(String value)
Set monitored resource
|
void |
setPerEndpointErrorRateAlertSuppressionDurationSeconds(Long perEndpointErrorRateAlertSuppressionDurationSeconds)
Set alert suppression duration for per endpoint error rate
|
void |
setPerEndpointErrorRatePaths(String[] value)
Set enable per endpoint error rate analysis setting
|
void |
setPerEndpointErrorRateSuppressRecovery(Integer value)
Set enable per endpoint error rate analysis setting
|
void |
setRequiredMinimumAverage(Double value)
Set required minimum average
|
void |
setRequiredMinimumClients(Long value)
Set required minimum clients
|
void |
setRequiredMinimumRequestsPerClient(Long value)
Set required minimum number of requests per client
|
void |
setSessionGapDurationMinutes(Long value)
Set session gap duration minutes
|
void |
setSessionLimitAnalysisPaths(String[] value)
Set session analysis pathes
|
void |
setSessionLimitAnalysisSuppressRecovery(Integer value)
Set session limit analysis suppress recovery
|
void |
setSourceCorrelatorAlertPercentage(Double sourceCorrelatorAlertPercentage)
Set source correlator alert percentage
|
void |
setSourceCorrelatorMinimumAddresses(Integer sourceCorrelatorMinimumAddresses)
Set source correlator minimum addresses
|
void |
setStatusCodeAnalysisCode(Integer value)
Set code for client status code rate analysis
|
void |
setUserAgentBlocklistPath(String value)
Set user agent blocklist path
|
EventFilter |
toStandardFilter()
Convert the toggles to a standard EventFilter for use in HTTPRequest
|
public HTTPRequestToggles()
HTTPRequestToggles
with defaultspublic void setEnableNatDetection(Boolean value)
value
- Booleanpublic Boolean getEnableNatDetection()
public void setKnownGatewaysPath(String value)
value
- Booleanpublic String getKnownGatewaysPath()
public void setEnableThresholdAnalysis(Boolean enableThresholdAnalysis)
enableThresholdAnalysis
- Booleanpublic Boolean getEnableThresholdAnalysis()
public void setAnalysisThresholdModifier(Double value)
value
- Valuepublic Double getAnalysisThresholdModifier()
public void setRequiredMinimumAverage(Double value)
value
- Doublepublic Double getRequiredMinimumAverage()
public void setRequiredMinimumClients(Long value)
value
- Longpublic Long getRequiredMinimumClients()
public void setClampThresholdMaximum(Double value)
value
- Doublepublic Double getClampThresholdMaximum()
public void setRequiredMinimumRequestsPerClient(Long value)
value
- Longpublic Long getRequiredMinimumRequestsPerClient()
public void setEnableErrorRateAnalysis(Boolean enableErrorRateAnalysis)
enableErrorRateAnalysis
- Booleanpublic Boolean getEnableErrorRateAnalysis()
public void setMaxClientErrorRate(Long value)
value
- Longpublic Long getMaxClientErrorRate()
public void setEnableEndpointAbuseAnalysis(Boolean enableEndpointAbuseAnalysis)
enableEndpointAbuseAnalysis
- Booleanpublic Boolean getEnableEndpointAbuseAnalysis()
public void setEndpointAbusePath(String[] value)
value
- String[]public String[] getEndpointAbusePath()
public void setEndpointAbuseExtendedVariance(Boolean value)
value
- Booleanpublic Boolean getEndpointAbuseExtendedVariance()
public void setEndpointAbuseCustomVarianceSubstrings(String[] value)
value
- String[]public String[] getEndpointAbuseCustomVarianceSubstrings()
public void setEndpointAbuseSuppressRecovery(Integer value)
value
- Integerpublic Integer getEndpointAbuseSuppressRecovery()
public void setSessionGapDurationMinutes(Long value)
value
- Longpublic Long getSessionGapDurationMinutes()
public void setAlertSuppressionDurationSeconds(Long value)
value
- Longpublic Long getAlertSuppressionDurationSeconds()
public void setEnableEndpointSequenceAbuseAnalysis(Boolean enableEndpointSequenceAbuseAnalysis)
enableEndpointSequenceAbuseAnalysis
- Booleanpublic Boolean getEnableEndpointSequenceAbuseAnalysis()
public void setEndpointSequenceAbusePattern(String[] value)
value
- String[]public String[] getEndpointSequenceAbusePatterns()
public void setEndpointSequenceAbuseSuppressRecovery(Integer value)
value
- Integerpublic Integer getEndpointSequenceAbuseSuppressRecovery()
public void setEnableHardLimitAnalysis(Boolean enableHardLimitAnalysis)
enableHardLimitAnalysis
- Booleanpublic Boolean getEnableHardLimitAnalysis()
public void setHardLimitRequestCount(Long value)
value
- Longpublic Long getHardLimitRequestCount()
public void setEnableUserAgentBlocklistAnalysis(Boolean enableUserAgentBlocklistAnalysis)
enableUserAgentBlocklistAnalysis
- Booleanpublic Boolean getEnableUserAgentBlocklistAnalysis()
public void setUserAgentBlocklistPath(String value)
value
- Stringpublic String getUserAgentBlocklistPath()
public Boolean getEnablePerEndpointErrorRateAnalysis()
public void setEnablePerEndpointErrorRateAnaysis(Boolean value)
value
- public String[] getPerEndpointErrorRatePaths()
public void setPerEndpointErrorRatePaths(String[] value)
value
- public Integer getPerEndpointErrorRateSuppressRecovery()
public void setPerEndpointErrorRateSuppressRecovery(Integer value)
value
- public Long getErrorSessionGapDurationMinutes()
public void setErrorSessionGapDurationMinutes(Long errorSessionGapDurationMinutes)
errorSessionGapDurationMinutes
- Doublepublic Long getPerEndpointErrorRateAlertSuppressionDurationSeconds()
public void setPerEndpointErrorRateAlertSuppressionDurationSeconds(Long perEndpointErrorRateAlertSuppressionDurationSeconds)
perEndpointErrorRateAlertSuppressionDurationSeconds
- longpublic void setEnableStatusCodeRateAnalysis(Boolean enableStatusCodeRateAnalysis)
enableStatusCodeRateAnalysis
- Booleanpublic Boolean getEnableStatusCodeRateAnalysis()
public void setMaxClientStatusCodeRate(Long value)
value
- Longpublic Long getMaxClientStatusCodeRate()
public void setStatusCodeAnalysisCode(Integer value)
value
- Integerpublic Integer getStatusCodeRateAnalysisCode()
public void setEnableSessionLimitAnalysis(Boolean enableSessionLimitAnalysis)
enableSessionLimitAnalysis
- Booleanpublic Boolean getEnableSessionLimitAnalysis()
public void setSessionLimitAnalysisPaths(String[] value)
value
- String[]public String[] getSessionLimitAnalysisPaths()
public void setSessionLimitAnalysisSuppressRecovery(Integer value)
value
- Integerpublic Integer getSessionLimitAnalysisSuppressRecovery()
public void setFilterRequestPath(String[] value)
value
- String[]public String[] getFilterRequestPath()
public void setIncludeUrlHostRegex(String[] value)
value
- String[]public String[] getIncludeUrlHostRegex()
public void setCidrExclusionList(String value)
value
- Stringpublic String getCidrExclusionList()
public void setIgnoreCloudProviderRequests(Boolean value)
value
- Booleanpublic Boolean getIgnoreCloudProviderRequests()
public void setIgnoreInternalRequests(Boolean value)
value
- Booleanpublic Boolean getIgnoreInternalRequests()
public void setMonitoredResource(String value)
value
- Stringpublic String getMonitoredResource()
public Boolean getEnableSourceCorrelator()
public void setSourceCorrelatorMinimumAddresses(Integer sourceCorrelatorMinimumAddresses)
sourceCorrelatorMinimumAddresses
- Integerpublic Integer getSourceCorrelatorMinimumAddresses()
public void setSourceCorrelatorAlertPercentage(Double sourceCorrelatorAlertPercentage)
sourceCorrelatorAlertPercentage
- Doublepublic Double getSourceCorrelatorAlertPercentage()
public EventFilter toStandardFilter()
Note that this filter does not apply any form of address exclusion if indicated in the
toggles. This must be handled outside of the event filter, typically within HTTPRequestElementFilter
.
public static HTTPRequestToggles fromPipelineOptions(HTTPRequest.HTTPRequestOptions o)
HTTPRequestToggles
using HTTPRequest
pipeline options
This function exists primarily for conversion of legacy pipeline options to operational pipeline toggles. It is intended to ease migration for invocations of the HTTPRequest pipeline that monitor a single service.
o
- Pipeline optionsCopyright © 2022. All rights reserved.