org.apache.cassandra.config

Class GuardrailsOptions

java.lang.Object

org.apache.cassandra.config.GuardrailsOptions

All Implemented Interfaces:

GuardrailsConfig

public class GuardrailsOptions
extends java.lang.Object
implements GuardrailsConfig

Configuration settings for guardrails populated from the Yaml file.

Note that the settings here must only be used to build the GuardrailsConfig class and not directly by the code checking each guarded constraint. That code should use the higher level abstractions defined in Guardrails).

We have 2 variants of guardrails, soft (warn) and hard (fail) limits, each guardrail having either one of the variants or both. Note in particular that hard limits only make sense for guardrails triggering during query execution. For other guardrails, say one triggering during compaction, aborting that compaction does not make sense.

Additionally, each individual setting should have a specific value (typically -1 for numeric settings), that allows to disable the corresponding guardrail.

Constructor Summary

Constructors

Constructor and Description
GuardrailsOptions(Config config)

Method Summary

Modifier and Type	Method and Description
boolean	getAllowFilteringEnabled() Returns whether ALLOW FILTERING property is allowed.
DataStorageSpec.LongBytesBound	getCollectionSizeFailThreshold()
DataStorageSpec.LongBytesBound	getCollectionSizeWarnThreshold()
int	getColumnsPerTableFailThreshold()
int	getColumnsPerTableWarnThreshold()
boolean	getCompactTablesEnabled() Returns whether users can create new COMPACT STORAGE tables
DataStorageSpec.LongBytesBound	getDataDiskUsageMaxDiskSize()
int	getDataDiskUsagePercentageFailThreshold()
int	getDataDiskUsagePercentageWarnThreshold()
boolean	getDropTruncateTableEnabled() Returns whether TRUNCATE or DROP table are allowed
int	getFieldsPerUDTFailThreshold()
int	getFieldsPerUDTWarnThreshold()
boolean	getGroupByEnabled() Returns whether GROUP BY functionality is allowed
int	getInSelectCartesianProductFailThreshold()
int	getInSelectCartesianProductWarnThreshold()
int	getItemsPerCollectionFailThreshold()
int	getItemsPerCollectionWarnThreshold()
int	getKeyspacesFailThreshold()
int	getKeyspacesWarnThreshold()
int	getMaterializedViewsPerTableFailThreshold()
int	getMaterializedViewsPerTableWarnThreshold()
int	getMinimumReplicationFactorFailThreshold()
int	getMinimumReplicationFactorWarnThreshold()
int	getPageSizeFailThreshold()
int	getPageSizeWarnThreshold()
int	getPartitionKeysInSelectFailThreshold()
int	getPartitionKeysInSelectWarnThreshold()
boolean	getReadBeforeWriteListOperationsEnabled() Returns whether list operations that require read before write are allowed.
java.util.Set<ConsistencyLevel>	getReadConsistencyLevelsDisallowed()
java.util.Set<ConsistencyLevel>	getReadConsistencyLevelsWarned()
boolean	getSecondaryIndexesEnabled()
int	getSecondaryIndexesPerTableFailThreshold()
int	getSecondaryIndexesPerTableWarnThreshold()
java.util.Set<java.lang.String>	getTablePropertiesDisallowed()
java.util.Set<java.lang.String>	getTablePropertiesIgnored()
java.util.Set<java.lang.String>	getTablePropertiesWarned()
int	getTablesFailThreshold()
int	getTablesWarnThreshold()
boolean	getUncompressedTablesEnabled() Returns whether tables can be uncompressed
boolean	getUserTimestampsEnabled() Returns whether user-provided timestamps are allowed.
java.util.Set<ConsistencyLevel>	getWriteConsistencyLevelsDisallowed()
java.util.Set<ConsistencyLevel>	getWriteConsistencyLevelsWarned()
void	setAllowFilteringEnabled(boolean enabled)
void	setCollectionSizeThreshold(DataStorageSpec.LongBytesBound warn, DataStorageSpec.LongBytesBound fail)
void	setColumnsPerTableThreshold(int warn, int fail)
void	setCompactTablesEnabled(boolean enabled)
void	setDataDiskUsageMaxDiskSize(DataStorageSpec.LongBytesBound diskSize)
void	setDataDiskUsagePercentageThreshold(int warn, int fail)
void	setDropTruncateTableEnabled(boolean enabled)
void	setFieldsPerUDTThreshold(int warn, int fail)
void	setGroupByEnabled(boolean enabled)
void	setInSelectCartesianProductThreshold(int warn, int fail)
void	setItemsPerCollectionThreshold(int warn, int fail)
void	setKeyspacesThreshold(int warn, int fail)
void	setMaterializedViewsPerTableThreshold(int warn, int fail)
void	setMinimumReplicationFactorThreshold(int warn, int fail)
void	setPageSizeThreshold(int warn, int fail)
void	setPartitionKeysInSelectThreshold(int warn, int fail)
void	setReadBeforeWriteListOperationsEnabled(boolean enabled)
void	setReadConsistencyLevelsDisallowed(java.util.Set<ConsistencyLevel> consistencyLevels)
void	setReadConsistencyLevelsWarned(java.util.Set<ConsistencyLevel> consistencyLevels)
void	setSecondaryIndexesEnabled(boolean enabled)
void	setSecondaryIndexesPerTableThreshold(int warn, int fail)
void	setTablePropertiesDisallowed(java.util.Set<java.lang.String> properties)
void	setTablePropertiesIgnored(java.util.Set<java.lang.String> properties)
void	setTablePropertiesWarned(java.util.Set<java.lang.String> properties)
void	setTablesThreshold(int warn, int fail)
void	setUncompressedTablesEnabled(boolean enabled)
void	setUserTimestampsEnabled(boolean enabled)
void	setWriteConsistencyLevelsDisallowed(java.util.Set<ConsistencyLevel> consistencyLevels)
void	setWriteConsistencyLevelsWarned(java.util.Set<ConsistencyLevel> consistencyLevels)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GuardrailsOptions

public GuardrailsOptions(Config config)

Method Detail

getKeyspacesWarnThreshold

public int getKeyspacesWarnThreshold()

Specified by:

getKeyspacesWarnThreshold in interface GuardrailsConfig

Returns:

The threshold to warn when creating more user keyspaces than threshold.

getKeyspacesFailThreshold

public int getKeyspacesFailThreshold()

Specified by:

getKeyspacesFailThreshold in interface GuardrailsConfig

Returns:

The threshold to fail when creating more user keyspaces than threshold.

setKeyspacesThreshold

public void setKeyspacesThreshold(int warn,
                                  int fail)

getTablesWarnThreshold

public int getTablesWarnThreshold()

Specified by:

getTablesWarnThreshold in interface GuardrailsConfig

Returns:

The threshold to warn when creating more user tables than threshold.

getTablesFailThreshold

public int getTablesFailThreshold()

Specified by:

getTablesFailThreshold in interface GuardrailsConfig

Returns:

The threshold to fail when creating more user tables than threshold.

setTablesThreshold

public void setTablesThreshold(int warn,
                               int fail)

getColumnsPerTableWarnThreshold

public int getColumnsPerTableWarnThreshold()

Specified by:

getColumnsPerTableWarnThreshold in interface GuardrailsConfig

Returns:

The threshold to warn when creating more columns per table than threshold.

getColumnsPerTableFailThreshold

public int getColumnsPerTableFailThreshold()

Specified by:

getColumnsPerTableFailThreshold in interface GuardrailsConfig

Returns:

The threshold to fail when creating more columns per table than threshold.

setColumnsPerTableThreshold

public void setColumnsPerTableThreshold(int warn,
                                        int fail)

getSecondaryIndexesPerTableWarnThreshold

public int getSecondaryIndexesPerTableWarnThreshold()

Specified by:

getSecondaryIndexesPerTableWarnThreshold in interface GuardrailsConfig

Returns:

The threshold to warn when creating more secondary indexes per table than threshold.

getSecondaryIndexesPerTableFailThreshold

public int getSecondaryIndexesPerTableFailThreshold()

Specified by:

getSecondaryIndexesPerTableFailThreshold in interface GuardrailsConfig

Returns:

The threshold to fail when creating more secondary indexes per table than threshold.

setSecondaryIndexesPerTableThreshold

public void setSecondaryIndexesPerTableThreshold(int warn,
                                                 int fail)

getMaterializedViewsPerTableWarnThreshold

public int getMaterializedViewsPerTableWarnThreshold()

Specified by:

getMaterializedViewsPerTableWarnThreshold in interface GuardrailsConfig

Returns:

The threshold to warn when creating more materialized views per table than threshold.

getPartitionKeysInSelectWarnThreshold

public int getPartitionKeysInSelectWarnThreshold()

Specified by:

getPartitionKeysInSelectWarnThreshold in interface GuardrailsConfig

Returns:

The threshold to warn when partition keys in select more than threshold.

getPartitionKeysInSelectFailThreshold

public int getPartitionKeysInSelectFailThreshold()

Specified by:

getPartitionKeysInSelectFailThreshold in interface GuardrailsConfig

Returns:

The threshold to fail when partition keys in select more than threshold.

setPartitionKeysInSelectThreshold

public void setPartitionKeysInSelectThreshold(int warn,
                                              int fail)

getMaterializedViewsPerTableFailThreshold

public int getMaterializedViewsPerTableFailThreshold()

Specified by:

getMaterializedViewsPerTableFailThreshold in interface GuardrailsConfig

Returns:

The threshold to fail when creating more materialized views per table than threshold.

setMaterializedViewsPerTableThreshold

public void setMaterializedViewsPerTableThreshold(int warn,
                                                  int fail)

getPageSizeWarnThreshold

public int getPageSizeWarnThreshold()

Specified by:

getPageSizeWarnThreshold in interface GuardrailsConfig

Returns:

The threshold to warn when page size exceeds given size.

getPageSizeFailThreshold

public int getPageSizeFailThreshold()

Specified by:

getPageSizeFailThreshold in interface GuardrailsConfig

Returns:

The threshold to fail when page size exceeds given size.

setPageSizeThreshold

public void setPageSizeThreshold(int warn,
                                 int fail)

getTablePropertiesWarned

public java.util.Set<java.lang.String> getTablePropertiesWarned()

Specified by:

getTablePropertiesWarned in interface GuardrailsConfig

Returns:

The table properties that are warned about when creating or altering a table.

setTablePropertiesWarned

public void setTablePropertiesWarned(java.util.Set<java.lang.String> properties)

getTablePropertiesIgnored

public java.util.Set<java.lang.String> getTablePropertiesIgnored()

Specified by:

getTablePropertiesIgnored in interface GuardrailsConfig

Returns:

The table properties that are ignored when creating or altering a table.

setTablePropertiesIgnored

public void setTablePropertiesIgnored(java.util.Set<java.lang.String> properties)

getTablePropertiesDisallowed

public java.util.Set<java.lang.String> getTablePropertiesDisallowed()

Specified by:

getTablePropertiesDisallowed in interface GuardrailsConfig

Returns:

The table properties that are disallowed when creating or altering a table.

setTablePropertiesDisallowed

public void setTablePropertiesDisallowed(java.util.Set<java.lang.String> properties)

getUserTimestampsEnabled

public boolean getUserTimestampsEnabled()

Description copied from interface: GuardrailsConfig

Returns whether user-provided timestamps are allowed.

Specified by:

getUserTimestampsEnabled in interface GuardrailsConfig

Returns:

true if user-provided timestamps are allowed, false otherwise.

setUserTimestampsEnabled

public void setUserTimestampsEnabled(boolean enabled)

getGroupByEnabled

public boolean getGroupByEnabled()

Description copied from interface: GuardrailsConfig

Returns whether GROUP BY functionality is allowed

Specified by:

getGroupByEnabled in interface GuardrailsConfig

Returns:

true if allowed, false otherwise.

setGroupByEnabled

public void setGroupByEnabled(boolean enabled)

getDropTruncateTableEnabled

public boolean getDropTruncateTableEnabled()

Description copied from interface: GuardrailsConfig

Returns whether TRUNCATE or DROP table are allowed

Specified by:

getDropTruncateTableEnabled in interface GuardrailsConfig

Returns:

true if allowed, false otherwise.

setDropTruncateTableEnabled

public void setDropTruncateTableEnabled(boolean enabled)

getSecondaryIndexesEnabled

public boolean getSecondaryIndexesEnabled()

Specified by:

getSecondaryIndexesEnabled in interface GuardrailsConfig

Returns:

Whether creation of secondary indexes is allowed.

setSecondaryIndexesEnabled

public void setSecondaryIndexesEnabled(boolean enabled)

getUncompressedTablesEnabled

public boolean getUncompressedTablesEnabled()

Description copied from interface: GuardrailsConfig

Returns whether tables can be uncompressed

Specified by:

getUncompressedTablesEnabled in interface GuardrailsConfig

Returns:

true if user's can disable compression, false otherwise.

setUncompressedTablesEnabled

public void setUncompressedTablesEnabled(boolean enabled)

getCompactTablesEnabled

public boolean getCompactTablesEnabled()

Description copied from interface: GuardrailsConfig

Returns whether users can create new COMPACT STORAGE tables

Specified by:

getCompactTablesEnabled in interface GuardrailsConfig

Returns:

true if allowed, false otherwise.

setCompactTablesEnabled

public void setCompactTablesEnabled(boolean enabled)

getReadBeforeWriteListOperationsEnabled

public boolean getReadBeforeWriteListOperationsEnabled()

Description copied from interface: GuardrailsConfig

Returns whether list operations that require read before write are allowed.

Specified by:

getReadBeforeWriteListOperationsEnabled in interface GuardrailsConfig

Returns:

true if list operations that require read before write are allowed, false otherwise.

setReadBeforeWriteListOperationsEnabled

public void setReadBeforeWriteListOperationsEnabled(boolean enabled)

getAllowFilteringEnabled

public boolean getAllowFilteringEnabled()

Description copied from interface: GuardrailsConfig

Returns whether ALLOW FILTERING property is allowed.

Specified by:

getAllowFilteringEnabled in interface GuardrailsConfig

Returns:

true if ALLOW FILTERING is allowed, false otherwise.

setAllowFilteringEnabled

public void setAllowFilteringEnabled(boolean enabled)

getInSelectCartesianProductWarnThreshold

public int getInSelectCartesianProductWarnThreshold()

Specified by:

getInSelectCartesianProductWarnThreshold in interface GuardrailsConfig

Returns:

The threshold to warn when an IN query creates a cartesian product with a size exceeding threshold. -1 means disabled.

getInSelectCartesianProductFailThreshold

public int getInSelectCartesianProductFailThreshold()

Specified by:

getInSelectCartesianProductFailThreshold in interface GuardrailsConfig

Returns:

The threshold to prevent IN queries creating a cartesian product with a size exceeding threshold. -1 means disabled.

setInSelectCartesianProductThreshold

public void setInSelectCartesianProductThreshold(int warn,
                                                 int fail)

getReadConsistencyLevelsWarned

public java.util.Set<ConsistencyLevel> getReadConsistencyLevelsWarned()

Specified by:

getReadConsistencyLevelsWarned in interface GuardrailsConfig

Returns:

The consistency levels that are warned about when reading.

setReadConsistencyLevelsWarned

public void setReadConsistencyLevelsWarned(java.util.Set<ConsistencyLevel> consistencyLevels)

getReadConsistencyLevelsDisallowed

public java.util.Set<ConsistencyLevel> getReadConsistencyLevelsDisallowed()

Specified by:

getReadConsistencyLevelsDisallowed in interface GuardrailsConfig

Returns:

The consistency levels that are disallowed when reading.

setReadConsistencyLevelsDisallowed

public void setReadConsistencyLevelsDisallowed(java.util.Set<ConsistencyLevel> consistencyLevels)

getWriteConsistencyLevelsWarned

public java.util.Set<ConsistencyLevel> getWriteConsistencyLevelsWarned()

Specified by:

getWriteConsistencyLevelsWarned in interface GuardrailsConfig

Returns:

The consistency levels that are warned about when writing.

setWriteConsistencyLevelsWarned

public void setWriteConsistencyLevelsWarned(java.util.Set<ConsistencyLevel> consistencyLevels)

getWriteConsistencyLevelsDisallowed

public java.util.Set<ConsistencyLevel> getWriteConsistencyLevelsDisallowed()

Specified by:

getWriteConsistencyLevelsDisallowed in interface GuardrailsConfig

Returns:

The consistency levels that are disallowed when writing.

setWriteConsistencyLevelsDisallowed

public void setWriteConsistencyLevelsDisallowed(java.util.Set<ConsistencyLevel> consistencyLevels)

getCollectionSizeWarnThreshold

@Nullable
public DataStorageSpec.LongBytesBound getCollectionSizeWarnThreshold()

Specified by:

getCollectionSizeWarnThreshold in interface GuardrailsConfig

Returns:

The threshold to warn when encountering a collection with larger data size than threshold.

getCollectionSizeFailThreshold

@Nullable
public DataStorageSpec.LongBytesBound getCollectionSizeFailThreshold()

Specified by:

getCollectionSizeFailThreshold in interface GuardrailsConfig

Returns:

The threshold to prevent collections with larger data size than threshold.

setCollectionSizeThreshold

public void setCollectionSizeThreshold(@Nullable
                                       DataStorageSpec.LongBytesBound warn,
                                       @Nullable
                                       DataStorageSpec.LongBytesBound fail)

getItemsPerCollectionWarnThreshold

public int getItemsPerCollectionWarnThreshold()

Specified by:

getItemsPerCollectionWarnThreshold in interface GuardrailsConfig

Returns:

The threshold to warn when encountering more elements in a collection than threshold.

getItemsPerCollectionFailThreshold

public int getItemsPerCollectionFailThreshold()

Specified by:

getItemsPerCollectionFailThreshold in interface GuardrailsConfig

Returns:

The threshold to prevent collections with more elements than threshold.

setItemsPerCollectionThreshold

public void setItemsPerCollectionThreshold(int warn,
                                           int fail)

getFieldsPerUDTWarnThreshold

public int getFieldsPerUDTWarnThreshold()

Specified by:

getFieldsPerUDTWarnThreshold in interface GuardrailsConfig

Returns:

The threshold to warn when creating a UDT with more fields than threshold.

getFieldsPerUDTFailThreshold

public int getFieldsPerUDTFailThreshold()

Specified by:

getFieldsPerUDTFailThreshold in interface GuardrailsConfig

Returns:

The threshold to fail when creating a UDT with more fields than threshold.

setFieldsPerUDTThreshold

public void setFieldsPerUDTThreshold(int warn,
                                     int fail)

getDataDiskUsagePercentageWarnThreshold

public int getDataDiskUsagePercentageWarnThreshold()

Specified by:

getDataDiskUsagePercentageWarnThreshold in interface GuardrailsConfig

Returns:

The threshold to warn when local disk usage percentage exceeds that threshold. Allowed values are in the range [1, 100], and -1 means disabled.

getDataDiskUsagePercentageFailThreshold

public int getDataDiskUsagePercentageFailThreshold()

Specified by:

getDataDiskUsagePercentageFailThreshold in interface GuardrailsConfig

Returns:

The threshold to fail when local disk usage percentage exceeds that threshold. Allowed values are in the range [1, 100], and -1 means disabled.

setDataDiskUsagePercentageThreshold

public void setDataDiskUsagePercentageThreshold(int warn,
                                                int fail)

getDataDiskUsageMaxDiskSize

public DataStorageSpec.LongBytesBound getDataDiskUsageMaxDiskSize()

Specified by:

getDataDiskUsageMaxDiskSize in interface GuardrailsConfig

Returns:

The max disk size of the data directories when calculating disk usage thresholds, null means disabled.

setDataDiskUsageMaxDiskSize

public void setDataDiskUsageMaxDiskSize(@Nullable
                                        DataStorageSpec.LongBytesBound diskSize)

getMinimumReplicationFactorWarnThreshold

public int getMinimumReplicationFactorWarnThreshold()

Specified by:

getMinimumReplicationFactorWarnThreshold in interface GuardrailsConfig

Returns:

The threshold to warn when replication factor is lesser than threshold.

getMinimumReplicationFactorFailThreshold

public int getMinimumReplicationFactorFailThreshold()

Specified by:

getMinimumReplicationFactorFailThreshold in interface GuardrailsConfig

Returns:

The threshold to fail when replication factor is lesser than threshold.

setMinimumReplicationFactorThreshold

public void setMinimumReplicationFactorThreshold(int warn,
                                                 int fail)