33# over STDIN and STDOUT according to the multi-language protocol.
44executableName = node sample_kcl_app.js
55
6+ # The Stream arn: arn:aws:kinesis:<region>:<account id>:stream/<stream name>
7+ # Important: streamArn takes precedence over streamName if both are set
8+ # streamArn = arn:aws:kinesis:us-east-5:000000000000:stream/kclnodejssample
9+
610# The name of an Amazon Kinesis stream to process.
11+ # Important: streamArn takes precedence over streamName if both are set
712streamName = kclnodejssample
813
914# Used by the KCL as the name of this application. Will be used as the name
@@ -27,10 +32,15 @@ processingLanguage = nodejs/0.10
2732# See http://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#API_GetShardIterator_RequestSyntax
2833initialPositionInStream = TRIM_HORIZON
2934
35+ # To specify an initial timestamp from which to start processing records, please specify timestamp value for 'initiatPositionInStreamExtended',
36+ # and uncomment below line with right timestamp value.
37+ # See more from 'Timestamp' under http://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#API_GetShardIterator_RequestSyntax
38+ # initialPositionInStreamExtended = 1636609142
39+
3040# The following properties are also available for configuring the KCL Worker that is created
3141# by the MultiLangDaemon.
3242
33- # Region of the stream for the KCL.
43+ # The KCL defaults to us-east-1
3444regionName = us-east-1
3545
3646# Fail over time in milliseconds. A worker which does not renew it's lease within this time interval
@@ -82,96 +92,4 @@ regionName = us-east-1
8292# If a value is provided then a FixedThreadPool is used with the maximum
8393# active threads set to the provided value. If a non-positive integer or no
8494# value is provided a CachedThreadPool is used.
85- # maxActiveThreads = 0
86-
87- # By default, KCL will emit metrics for Operation, ShardId, and WorkerIdentifier dimensions
88- # Specify the specific dimensions to emit metrics for
89- # metricsEnabledDimensions = Operation,ShardId
90-
91- # ################## KclV3 configurations ###################
92- # NOTE : These are just test configurations to show how to customize
93- # all possible KCLv3 configurations. They are not necessarily the best
94- # default values to use for production.
95-
96- # Coordinator config
97- # Version the KCL needs to operate in. For more details check the KCLv3 migration
98- # documentation. Default is CLIENT_VERSION_CONFIG_3X
99- # clientVersionConfig =
100- # Configurations to control how the CoordinatorState DDB table is created
101- # Default name is applicationName-CoordinatorState in PAY_PER_REQUEST,
102- # with PITR and deletion protection disabled and no tags
103- # coordinatorStateTableName =
104- # coordinatorStateBillingMode =
105- # coordinatorStateReadCapacity =
106- # coordinatorStateWriteCapacity =
107- # coordinatorStatePointInTimeRecoveryEnabled =
108- # coordinatorStateDeletionProtectionEnabled =
109- # coordinatorStateTags =
110-
111- # Graceful handoff config - tuning of the shutdown behavior during lease transfers
112- # default values are 30000 and true respectively
113- # gracefulLeaseHandoffTimeoutMillis =
114- # isGracefulLeaseHandoffEnabled =
115-
116- # WorkerMetricStats table config - control how the DDB table is created
117- # Default name is applicationName-WorkerMetricStats in PAY_PER_REQUEST,
118- # with PITR and deletion protection disabled and no tags
119- # workerMetricsTableName =
120- # workerMetricsBillingMode =
121- # workerMetricsReadCapacity =
122- # workerMetricsWriteCapacity =
123- # workerMetricsPointInTimeRecoveryEnabled =
124- # workerMetricsDeletionProtectionEnabled =
125- # workerMetricsTags =
126-
127- # WorkerUtilizationAwareAssignment config - tune the new KCLv3 Lease balancing algorithm
128- #
129- # frequency of capturing worker metrics in memory. Default is 1s
130- # inMemoryWorkerMetricsCaptureFrequencyMillis =
131-
132- # frequency of reporting worker metric stats to storage. Default is 30s
133- # workerMetricsReporterFreqInMillis =
134-
135- # No. of metricStats that are persisted in WorkerMetricStats ddb table, default is 10
136- # noOfPersistedMetricsPerWorkerMetrics =
137-
138- # Disable use of worker metrics to balance lease, default is false.
139- # If it is true, the algorithm balances lease based on worker's processing throughput.
140- # disableWorkerMetrics =
141-
142- # Max throughput per host 10 MBps, to limit processing to the given value
143- # Default is unlimited.
144-
145- # maxThroughputPerHostKBps =
146- # Dampen the load that is rebalanced during lease re-balancing, default is 60%
147- # dampeningPercentage =
148- # Configures the allowed variance range for worker utilization. The upper
149- # limit is calculated as average * (1 + reBalanceThresholdPercentage/100).
150- # The lower limit is average * (1 - reBalanceThresholdPercentage/100). If
151- # any worker's utilization falls outside this range, lease re-balancing is
152- # triggered. The re-balancing algorithm aims to bring variance within the
153- # specified range. It also avoids thrashing by ensuring the utilization of
154- # the worker receiving the load after re-balancing doesn't exceed the fleet
155- # average. This might cause no re-balancing action even the utilization is
156- # out of the variance range. The default value is 10, representing +/-10%
157- # variance from the average value.
158- # reBalanceThresholdPercentage =
159-
160- # Whether at-least one lease must be taken from a high utilization worker
161- # during re-balancing when there is no lease assigned to that worker which has
162- # throughput is less than or equal to the minimum throughput that needs to be
163- # moved away from that worker to bring the worker back into the allowed variance.
164- # Default is true.
165- # allowThroughputOvershoot =
166-
167- # Lease assignment is performed every failoverTimeMillis but re-balance will
168- # be attempted only once in 5 times based on the below config. Default is 3.
169- # varianceBalancingFrequency =
170-
171- # Alpha value used for calculating exponential moving average of worker's metricStats.
172- # workerMetricsEMAAlpha =
173- # Duration after which workerMetricStats entry from WorkerMetricStats table will
174- # be cleaned up.
175- # Duration format examples: PT15M (15 mins) PT10H (10 hours) P2D (2 days)
176- # Refer to Duration.parse javadocs for more details
177- # staleWorkerMetricsEntryCleanupDuration =
95+ # maxActiveThreads = 0
0 commit comments