sprockit.Property
[ v1.3 ] [ v1.4 ] [ v1.5 ] [ Back to Sprockit home page ]
This table contains properties (configuration options) and associated values used to control aspects of Sprockit's behaviour.
Columns
Column name1) | Column type | Description | Notes | |
---|---|---|---|---|
PK | PropertyName | NVARCHAR(128) | Unique property identifier. | |
PropertyValue | NVARCHAR(MAX) | The value currently configured for this property. | ||
DataType | NVARCHAR(128) | The property's data type. | ||
Description | NVARCHAR(512) | A description of the property. |
Relationships
Relationships with integrity enforced by a foreign key constraint have identifiers prefixed with FK; others are prefixed RL.
References to other tables
Attributes (in this table) | Referenced table | Referenced attributes (in referenced table) |
|
---|---|---|---|
(None). |
References to this table from others
Relationship | Attributes (in referencing table) | Referenced attributes (in this table) |
---|---|---|
(None). |
Notes
The following properties are available:
BatchTimeout
Since Sprockit v1.4. You can prevent batches from over-running (and causing subsequent batches to fail to start) by specifiying a batch timeout, in minutes, that will cause the process manager (if still running) to exit before the next scheduled start. By default this is set to 1425 – this is an appropriate value for an ETL batch that is scheduled to start every 24 hours.
If you wish batches to have no effective timeout, set this property to a high number. 32767 is the SMALLINT type maximum value and corresponds to a timeout period exceeding three weeks.
DefaultIndexRebuildFragmentationThreshold
Since Sprockit v1.213. Sprockit can optionally be configured to perform index maintenance tasks. This option, expressed as a percentage, indicates the maximum fragmentation permitted in an index by default before it requires maintenance.
DefaultIndexRebuildMode
Since Sprockit v1.213. Sprockit can optionally be configured to perform index maintenance tasks. This option controls Sprockit's default index maintenance behaviour.
IndexMaintenanceLogLevel
Since Sprockit v1.213. Sprockit can optionally be configured to perform index maintenance tasks. This option controls how much index maintenance activity is reported in sprockit.IndexMaintenanceTask.
LogRetentionPeriod
Sprockit trims its own log tables by removing entries over a certain age at each execution. This option specifies that age in days.
The option can be disabled (no logs trimmed) by setting its value to -1
. This is particularly important if you rely on sprockit.Execution entries to track ETL process lineage.
Log entry retention periods for sprockit.SqlActivity and sprockit.SsisPerformanceCounters are specified separately by the properties SqlActivityRetentionPeriod
and SsisPerfmonRetentionPeriod
respectively.
MaxConcurrentHandlers
The maximum number of process handlers permitted to run at the same time.
Typically you will find that end-to-end processing time decreases as this option's value increases, but only up to a point – a value too low will fail to make use of available resources, while a value too high will cause individual processes to become starved and slow down. You should tune this value to make best use of your system's resources.
ProcessManagerAgentJobName
The name of the SQL Agent Job which runs the process manager.
You can change the name of the agent job if you wish, but you should also update this property value to match. (The property is used at upgrade and by utility SP sprockit.usp__StopRunningBatch
to identify the process manager job).
ProcessManagerPollInterval
Sprockit's process manager runs in an infinite loop as long as processes are running. At each iteration, the process manager:
- assesses handler capacity and demand, and adds a new handler if indicated;
- logs current SQL Server activity;
- logs current SSIS performance counters;
- waits for a number of seconds.
The number of seconds it waits before entering the next iteration is specified by this property.
RollingAverageBatchCount
The rolling average batch count indicates the number of (most recent, successful) executions to be used by Sprockit when calculating a process's average duration (recorded in sprockit.Process.[AvgDuration]).
RollingAverageBatchDays
Since Sprockit v1.5. This bitmask value indicates which days are to be included in rolling average calculation. This can be useful if you reserve certain days of the week for atypical processing workloads (e.g. large batch processing at weekends) and wish to prevent them from influencing branch weight calculation. The appropriate value for this property can be calculated by summing the contributors corresponding to required days as follows:
Day number2) | Contributor |
---|---|
1 | 1 |
2 | 2 |
3 | 4 |
4 | 8 |
5 | 16 |
6 | 32 |
7 | 64 |
The default value of RollingAverageBatchDays
is 127; i.e. the sum of all contributors.
Batches are excluded by RollingAverageBatchDays
after selection by RollingAverageBatchCount
– a value of RollingAverageBatchDays
less than 127 will have the effect of reducing the number of batches included in rolling average calculation to below the number specified by RollingAverageBatchCount
.
SprockitVersion
Indicates the version of Sprockit currently installed.
SqlActivityRetentionPeriod
Since Sprockit v1.5. Sprockit trims its SQL Server activity log by removing entries over a certain age at each execution. This option specifies that age in days.
For other logs this is controlled by the LogRetentionPeriod
property, but this log can grow more quickly than others so you may wish to trim it more frequently (particularly if you have disabled general log trimming to enable support for process lineage tracking).
SsisPerfmonRetentionPeriod
Since Sprockit v1.5. Sprockit trims its SSIS performance counters log by removing entries over a certain age at each execution. This option specifies that age in days.
For other logs this is controlled by the LogRetentionPeriod
property, but this log can grow more quickly than others so you may wish to trim it more frequently (particularly if you have disabled general log trimming to enable support for process lineage tracking).
Page generated from database metadata by DbScout.
DATEPART(WeekDay, <batch [StartDateTime]>)
.