-
Notifications
You must be signed in to change notification settings - Fork 214
/
connectivity.conf
1322 lines (1108 loc) · 61.5 KB
/
connectivity.conf
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
ditto {
service-name = "connectivity"
mongodb {
database = "connectivity"
database = ${?MONGO_DB_DATABASE}
}
extensions {
# Factory for custom connection priority provider.
connection-priority-provider-factory = "org.eclipse.ditto.connectivity.service.messaging.persistence.UsageBasedPriorityProviderFactory"
# Factory for custom client actor props.
client-actor-props-factory = "org.eclipse.ditto.connectivity.service.messaging.DefaultClientActorPropsFactory"
# Factory for getting a fully-fledged Hono factory for a particular base connection.
hono-connection-factory = "org.eclipse.ditto.connectivity.service.messaging.hono.DefaultHonoConnectionFactory"
# Extension for custom message mapper behaviour
message-mapper-extension = "org.eclipse.ditto.connectivity.service.mapping.NoOpMessageMapperExtension"
signal-enrichment-provider {
// Beware: Despite similarities with gateway signal-enrichment providers,
// this class is different and not compatible with them.
extension-class = "org.eclipse.ditto.connectivity.service.mapping.DefaultConnectivitySignalEnrichmentProvider"
extension-config {
cache {
# enable/disable caching
enabled = true
enabled = ${?CONNECTIVITY_SIGNAL_ENRICHMENT_CACHE_ENABLED}
# how many things to cache in total on a single cluster node
maximum-size = 20000
maximum-size = ${?CONNECTIVITY_SIGNAL_ENRICHMENT_CACHE_MAXIMUM_SIZE}
# maximum duration of inconsistency after e.g. a policy update
expire-after-create = 2m
expire-after-create = ${?CONNECTIVITY_SIGNAL_ENRICHMENT_CACHE_EXPIRE_AFTER_CREATE}
}
# timeout for all facades
ask-timeout = 10s
ask-timeout = ${?CONNECTIVITY_SIGNAL_ENRICHMENT_ASK_TIMEOUT}
}
}
connection-enforcer-actor-props-factory = org.eclipse.ditto.connectivity.service.enforcement.NoOpEnforcerActorPropsFactory
# Provider for a custom connectivity-command interceptor.
custom-connectivity-command-interceptor-provider = "org.eclipse.ditto.connectivity.service.messaging.validation.NoOpConnectivityCommandInterceptorProvider"
pre-enforcer-provider.extension-config.pre-enforcers = [
"org.eclipse.ditto.policies.enforcement.pre.CommandWithOptionalEntityPreEnforcer"
]
message-mapper-provider {
extension-class = "org.eclipse.ditto.connectivity.service.mapping.MessageMapperProvider"
extension-config {
message-mappers = [
"org.eclipse.ditto.connectivity.service.mapping.DittoMessageMapper"
"org.eclipse.ditto.connectivity.service.mapping.CloudEventsMapper"
"org.eclipse.ditto.connectivity.service.mapping.ConnectionStatusMessageMapper"
"org.eclipse.ditto.connectivity.service.mapping.ImplicitThingCreationMessageMapper"
"org.eclipse.ditto.connectivity.service.mapping.javascript.JavaScriptMessageMapperRhino"
"org.eclipse.ditto.connectivity.service.mapping.NormalizedMessageMapper"
"org.eclipse.ditto.connectivity.service.mapping.RawMessageMapper"
"org.eclipse.ditto.connectivity.service.mapping.UpdateTwinWithLiveResponseMessageMapper"
]
}
}
snapshot-adapter = "org.eclipse.ditto.connectivity.service.messaging.persistence.ConnectionMongoSnapshotAdapter"
}
mapping-strategy.implementation = "org.eclipse.ditto.connectivity.api.ConnectivityMappingStrategies"
persistence.operations.delay-after-persistence-actor-shutdown = 5s
persistence.operations.delay-after-persistence-actor-shutdown = ${?DELAY_AFTER_PERSISTENCE_ACTOR_SHUTDOWN}
connectivity {
hono {
base-uri = "tcp://localhost:9092"
base-uri = ${?HONO_CONNECTION_URI}
validate-certificates = false
validate-certificates = ${?HONO_CONNECTION_VALIDATE_CERTIFICATE}
sasl-mechanism = "PLAIN"
sasl-mechanism = ${?HONO_CONNECTION_SASL_MECHANISM}
bootstrap-servers = "localhost:9092"
bootstrap-servers = ${?HONO_CONNECTION_BOOTSTRAP_SERVERS}
username = "honoUsername"
username = ${?HONO_CONNECTION_HONO_USERNAME}
password = "honoPassword"
password = ${?HONO_CONNECTION_HONO_PASSWORD}
}
user-indicated-errors-base = [
# Kafka
{exceptionName: "org.apache.kafka.common.errors.SaslAuthenticationException", messagePattern: ".*"}
{exceptionName: "org.apache.kafka.common.errors.UnsupportedSaslMechanismException", messagePattern: ".*"}
{exceptionName: "org.apache.kafka.common.errors.IllegalSaslStateException", messagePattern: ".*"}
{exceptionName: "org.apache.kafka.common.errors.SslAuthenticationException", messagePattern: ".*"}
{exceptionName: "org.apache.kafka.common.errors.TimeoutException", messagePattern: ".*"}
# MQTT
{exceptionName: "com.hivemq.client.mqtt.exceptions.ConnectionClosedException", messagePattern: "Server closed connection without DISCONNECT.*"}
{exceptionName: "com.hivemq.client.mqtt.exceptions.ConnectionClosedException", messagePattern: "io.netty.channel.unix.Errors$NativeIoException.*"}
# MQTT 3.1.1 - treat error codes from the broker as user indicated errors
{exceptionName: "com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3ConnAckException", messagePattern: ".*"}
{exceptionName: "com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3DisconnectException", messagePattern: ".*"}
{exceptionName: "com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3PubAckException", messagePattern: ".*"}
{exceptionName: "com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3PubRecException", messagePattern: ".*"}
{exceptionName: "com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3SubAckException", messagePattern: ".*"}
{exceptionName: "com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3UnsubAckException", messagePattern: ".*"}
# MQTT 5 - treat error codes from the broker as user indicated errors
{exceptionName: "com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5AuthException", messagePattern: ".*"}
{exceptionName: "com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5ConnAckException", messagePattern: ".*"}
{exceptionName: "com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5DisconnectException", messagePattern: ".*"}
{exceptionName: "com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5PubAckException", messagePattern: ".*"}
{exceptionName: "com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5PubRecException", messagePattern: ".*"}
{exceptionName: "com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5SubAckException", messagePattern: ".*"}
{exceptionName: "com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5UnsubAckException", messagePattern: ".*"}
# RabbitMQ
{exceptionName: "com.rabbitmq.client.AuthenticationFailureException", messagePattern: ".*"}
{exceptionName: "com.rabbitmq.client.ShutdownSignalException", messagePattern: ".*"}
{exceptionName: "javax.net.ssl.SSLException", messagePattern: ".*"}
{exceptionName: "java.net.SocketException", messagePattern: "Socket closed.*"}
# SSH Tunnel
{exceptionName: "java.nio.channels.UnresolvedAddressException", messagePattern: ".*"}
{exceptionName: "org.apache.sshd.common.SshException", messagePattern: ".*authentication.*"}
{exceptionName: "java.net.ConnectException", messagePattern: ".*Connection refused.*"}
{exceptionName: "java.lang.RuntimeException", messagePattern: ".*load key from.*"} //thrown when private key could not be loaded
# AMQP 1.0
{exceptionName: "org.apache.qpid.jms.provider.ProviderException", messagePattern: ".*"}
{exceptionName: "org.apache.qpid.jms.provider.exceptions.ProviderSecurityException", messagePattern: ".*"}
{exceptionName: "org.apache.qpid.jms.provider.exceptions.ProviderInvalidDestinationException", messagePattern: ".*"}
{exceptionName: "org.apache.qpid.jms.JmsOperationTimedOutException", messagePattern: ".*"}
# HTTP
{exceptionName: "org.eclipse.ditto.jwt.model.JwtInvalidException", messagePattern: ".*"}
{exceptionName: "org.apache.pekko.http.impl.engine.client.OutgoingConnectionBlueprint.UnexpectedConnectionClosureException", messagePattern: ".*"}
{exceptionName: "org.apache.pekko.stream.StreamTcpException", messagePattern: ".*Connection reset by peer.*"}
# Common cert exceptions
{exceptionName: "java.security.cert.CertificateException", messagePattern: ".*"}
{exceptionName: "java.security.cert.CertPathValidatorException", messagePattern: ".*"}
{exceptionName: "sun.security.provider.certpath.SunCertPathBuilderException", messagePattern: ".*"}
]
user-indicated-errors-extended = []
user-indicated-errors-extended = ${?USER_INDICATED_ERRORS}
user-indicated-errors = ${ditto.connectivity.user-indicated-errors-base} ${ditto.connectivity.user-indicated-errors-extended}
connection {
# A comma separated string of hostnames to which http requests will allowed. This overrides the blocked
# hostnames i.e if a host is blocked *and* allowed, it will be allowed.
allowed-hostnames = "hono-endpoint"
#allowed-hostnames = "localhost"
allowed-hostnames = ${?CONNECTIVITY_CONNECTION_ALLOWED_HOSTNAMES}
# A comma separated string of blocked hostnames to which no http requests will be sent out.
# Set it to an empty string to permit outgoing HTTP connections against private IP addresses.
blocked-hostnames = ""
#blocked-hostnames = "localhost"
blocked-hostnames = ${?CONNECTIVITY_CONNECTION_BLOCKED_HOSTNAMES}
# A comma separated string of blocked subnets to which no http requests will be sent out.
# Specify subnets to block in CIDR format e.g. "11.1.0.0/16"
blocked-subnets = ""
blocked-subnets = ${?CONNECTIVITY_CONNECTION_BLOCKED_SUBNETS}
# A regex which is used to determine blocked hostnames.
blocked-host-regex = ""
blocked-host-regex = ${?CONNECTIVITY_CONNECTION_BLOCKED_HOST_REGEX}
# Number of sources per connection
max-source-number = 4
max-source-number = ${?CONNECTION_SOURCE_NUMBER}
# Number of targets per connection
max-target-number = 4
max-target-number = ${?CONNECTION_TARGET_NUMBER}
encryption {
# Enables encryption on connection fields recorded in the db
encryption-enabled = false
encryption-enabled = ${?CONNECTIVITY_CONNECTION_ENCRYPTION_ENABLED}
# The 256bit AES symmetrical key used for encription
symmetrical-key = ""
symmetrical-key = ${?CONNECTIVITY_CONNECTION_ENCRYPTION_KEY}
# A List of Json pointers to the fields to be encrypted
json-pointers = ["/uri",
"/credentials/key",
"/sshTunnel/credentials/password",
"/sshTunnel/credentials/privateKey",
"/credentials/parameters/accessKey",
"/credentials/parameters/secretKey",
"/credentials/parameters/sharedKey",
"/credentials/clientSecret"
]
json-pointers = ${?CONNECTIVITY_CONNECTION_ENCRYPTION_POINTERS}
}
supervisor {
exponential-backoff {
min = 1s
max = 120s
random-factor = 1.0
corrupted-receive-timeout = 600s
}
# For connectivity, this local ask timeout has to be higher as e.g. "openConnection" commands performed in a
# "staged" way will lead to quite some response times.
local-ask {
timeout = 50s
timeout = ${?THINGS_SUPERVISOR_LOCAL_ASK_TIMEOUT}
}
}
snapshot {
# the interval when to do snapshot for a Connection which had changes to it
interval = 15m
interval = ${?CONNECTION_SNAPSHOT_INTERVAL} # may be overridden with this environment variable
# the threshold after how many changes to a Connection to do a snapshot
threshold = 10
threshold = ${?CONNECTION_SNAPSHOT_THRESHOLD} # may be overridden with this environment variable
}
event {
# define the DittoHeaders to persist when persisting events to the journal
# those can e.g. be retrieved as additional "audit log" information when accessing a historical connection revision
historical-headers-to-persist = [
#"ditto-originator" # who (user-subject/connection-pre-auth-subject) issued the event
#"correlation-id"
]
historical-headers-to-persist = ${?CONNECTION_EVENT_HISTORICAL_HEADERS_TO_PERSIST}
}
activity-check {
# the interval of how long to keep a closed, "inactive" Connection in memory
inactive-interval = 45m
inactive-interval = ${?CONNECTION_ACTIVITY_CHECK_INTERVAL} # may be overridden with this environment variable
# the interval of how long to keep a deleted Connection in memory:
deleted-interval = 5m
deleted-interval = ${?CONNECTION_ACTIVITY_CHECK_DELETED_INTERVAL}
}
# how long for connection actor to wait for response from client actors
# by default this value is very high because connection establishment can take very long and if we timeout too
# early the connection is not subscribed for events properly
# this timeout needs to be smaller then ditto.gateway.http.request-timeout in gateway.conf
client-actor-ask-timeout = 55s
client-actor-ask-timeout = ${?CONNECTIVITY_CLIENT_ACTOR_ASK_TIMEOUT}
# how often the connection actor will retry starting a failing client actor. If exceeded, errors will be
# escalated to the supervisor, which will effectively cause the whole connection to be restarted.
client-actor-restarts-before-escalation = 3
client-actor-restarts-before-escalation = ${?CONNECTIVITY_CLIENT_ACTOR_RETRIES_BEFORE_ESCALATION}
# Whether to start 1 client actor on each node or to start all client actors on the same node.
# It is not possible to start multiple client actors on multiple nodes.
all-client-actors-on-one-node = false
all-client-actors-on-one-node = ${?CONNECTIVITY_ALL_CLIENT_ACTORS_ON_ONE_NODE}
shutdown-timeout = 3s
shutdown-timeout = ${?CONNECTION_SHUTDOWN_TIMEOUT}
acknowledgement {
# lifetime of ack forwarder. Must be bigger than the largest possible command timeout (60s)
forwarder-fallback-timeout = 65s
# lifetime of collector of source acknowledgements. usually terminates before this long when all acks arrive.
collector-fallback-lifetime = 100s
# how long to wait on the collector before acknowledging negatively on the transport layer.
collector-fallback-ask-timeout = 120s
# size budget for the payload of issued acknowledgements by a connection target.
issued-max-bytes = 100000
issued-max-bytes = ${?CONNECTIVITY_ACKNOWLEDGEMENT_ISSUED_MAX_BYTES}
}
# how often to attempt acknowledgement label declaration for as long as it is not successful
ack-label-declare-interval = 10s
ack-label-declare-interval = ${?CONNECTIVITY_ACK_LABEL_DECLARE_INTERVAL}
priority-update-interval = 24h
priority-update-interval = ${?CONNECTIVITY_PRIORITY_UPDATE_INTERVAL}
amqp10 {
consumer {
# When to forget an NAcked redelivery=true message -- those may be consumed by another consumer
# Equal to the max time interval per redelivery per message during subscriber downtime
redelivery-expectation-timeout = 120s
redelivery-expectation-timeout = ${?AMQP10_CONSUMER_REDELIVERY_EXPECTATION_TIMEOUT}
throttling {
enabled = false
enabled = ${?AMQP10_CONSUMER_THROTTLING_ENABLED}
enabled = ${?AMQP10_CONSUMER_RATE_LIMIT_ENABLED} # this is an alias which previously was used
# Interval at which the consumer is throttled. Must be > 0s.
interval = 1s
interval = ${?AMQP10_CONSUMER_THROTTLING_INTERVAL}
# The maximum number of messages the consumer is allowed to receive within the configured
# throttling interval e.g. 100 msgs/s. Must be > 0.
limit = 100
limit = ${?AMQP10_CONSUMER_THROTTLING_LIMIT}
# Throttling detection tolerance in percent e.g. for a tolerance of 5% if consumed messages are above
# limit - 5% per interval the source is considered throttled.
throttling-detection-tolerance = 0.05
throttling-detection-tolerance = ${?AMQP_10_CONSUMER_THROTTLING_DETECTION_TOLERANCE}
# How many unacknowledged messages are allowed at any time as factor of ${limit} - must be >= 1.0
# This limit couples latency with throughput (long latency before ack -> lower throughput)
max-in-flight-factor = 2.0
max-in-flight-factor = ${?AMQP10_CONSUMER_THROTTLING_MAX_IN_FLIGHT_FACTOR}
}
}
publisher {
# If a message can't be published it is put in a queue. Further messages are dropped when the queue is full.
max-queue-size = 1000
max-queue-size = ${?AMQP10_PUBLISHER_MAX_QUEUE_SIZE}
# Messages to publish in parallel per AMQP-Publisher (one per connectivity client)
# jms-connection-handling-dispatcher will be used.
parallelism = 10
parallelism = ${?AMQP10_PUBLISHER_PARALLELISM}
}
// How many producers to cache per client actor (in addition to static addresses).
// If 0 or negative, no message can be sent to any reply-to address or addresses containing placeholders that
// do not match any target address.
producer-cache-size = 10
producer-cache-size = ${?AMQP10_PRODUCER_CACHE_SIZE}
global-connect-timeout = 15s
global-connect-timeout = ${?AMQP10_GLOBAL_CONNECT_TIMEOUT}
global-send-timeout = 60s
global-send-timeout = ${?AMQP10_GLOBAL_SEND_TIMEOUT}
global-request-timeout = 5s
global-request-timeout = ${?AMQP10_GLOBAL_REQUEST_TIMEOUT}
global-prefetch-policy-all-count = 10
global-prefetch-policy-all-count = ${?AMQP10_GLOBAL_PREFETCH_POLICY_ALL_COUNT}
# Configuration for backoff of the producers and consumers. This will be used when the creation of a consumer
# or producer fails with an error message of the JMS client (can happen when e.g. user is not authorized
# on a source/target).
# As the actor will instantly try to re-establish the sours/targets, this may lead to a lot of error logs.
# Thats why this backoff configuration is used. On the first error the actor will wait min-timeout before
# retrying to establish the source/target, afterwards it will increase its waiting time step by step until
# max-timeout.
backoff.timeout {
# initial / minimum timeout when backing off
min-timeout = 1s
min-timeout = ${?AMQP10_BACK_OFF_MIN_TIMEOUT}
# maximum backoff timeout
max-timeout = 10m
max-timeout = ${?AMQP10_BACK_OFF_MAX_TIMEOUT}
}
hmac-algorithms {
az-sasl = "org.eclipse.ditto.connectivity.service.messaging.signing.AzSaslSigningFactory"
}
initial-consumer-resource-status-ask-timeout = 500ms
initial-consumer-resource-status-ask-timeout = ${?AMQP10_INITIAL_CONSUMER_RESOURCE_STATUS_ASK_TIMEOUT}
}
amqp091 {
publisher {
# Lifetime of an entry in the cache 'outstandingAcks'.
# It is an upper bound for the timeout of any command requesting acknowledgements from this publisher.
# Ideally between the maximum timeout (60s) and the acknowledgement forwarder lifetime (100s).
# No other publisher actor requires a cache TTL config because their clients take care of message ID tracking.
pending-ack-ttl = 1m
}
}
mqtt {
# maximum mumber of MQTT messages to buffer in a source (presumably for at-least-once and exactly-once delivery)
source-buffer-size = 8
source-buffer-size = ${?CONNECTIVITY_MQTT_SOURCE_BUFFER_SIZE}
# If a message can't be published it is put in a queue. Further messages are dropped when the queue is full.
max-queue-size = 1000
max-queue-size = ${?CONNECTIVITY_MQTT_MAX_QUEUE_SIZE}
# The number of threads to use for the underlying event loop of the MQTT client.
# When configured to "0", the size is determined based on "the available processor cores * 2".
event-loop-threads = 0
event-loop-threads = ${?CONNECTIVITY_MQTT_EVENT_LOOP_THREADS}
## The following configuration settings are used as defaults for "specificConfic" settings of each created MQTT
## connection - if not specified otherwise, those defaults are applied.
# Indicates whether subscriber CONN messages should set clean-session or clean-start flag to true.
clean-session = false
clean-session = ${?CONNECTIVITY_MQTT_CLEAN_SESSION}
# Indicates whether the client should reconnect to enforce a redelivery for a failed acknowledgement.
reconnect-for-redelivery = false
reconnect-for-redelivery = ${?CONNECTIVITY_MQTT_RECONNECT_FOR_REDELIVERY}
# The amount of time that a reconnect will be delayed after a failed acknowledgement
reconnect-for-redelivery-delay = 10s
reconnect-for-redelivery-delay = ${?CONNECTIVITY_MQTT_RECONNECT_FOR_REDELIVERY_DELAY}
# The amount of time that messages should be buffered after disconnect
session-expiry-interval = 60s
session-expiry-interval = ${?CONNECTIVITY_MQTT_SESSION_EXPIRY_INTERVAL}
# Indicates whether a separate client should be used for publishing. This could be useful when
# reconnect-for-redelivery is set to true to avoid that the publisher has downtimes.
separate-publisher-client = false
separate-publisher-client = ${?CONNECTIVITY_MQTT_SEPARATE_PUBLISHER_CLIENT}
reconnect {
# The minimum reconnect timeout for when the MQTT broker closed the MQTT connection.
min-timeout-for-mqtt-broker-initiated-disconnect = 1s
min-timeout-for-mqtt-broker-initiated-disconnect = ${?CONNECTIVITY_MQTT_RECONNECT_MIN_TIMEOUT_FOR_MQTT_BROKER_INITIATED_DISCONNECT}
backoff.timeout {
# the minimum timeout for MQTT client reconnections - "0s" reconnects immediately
min-timeout = 0s
min-timeout = ${?CONNECTIVITY_MQTT_RECONNECT_BACKOFF_TIMEOUT_MIN}
# the maximum timeout, once expontential backoff reached this max, the max is used instead
max-timeout = 1m
max-timeout = ${?CONNECTIVITY_MQTT_RECONNECT_BACKOFF_TIMEOUT_MAX}
}
}
# Configuration properties for MQTT consumer throttling.
throttling {
# Even if MQTT consumer trottling is disabled, the "Max inflight"
# messages will still be determined with `limit` and
# `max-in-flight-factor` configuration values – so increase them if
# you need more "max inflight" processed messages in Ditto.
enabled = false
enabled = ${?MQTT_CONSUMER_THROTTLING_ENABLED}
# Interval at which the consumer is throttled. Must be > 0s.
interval = 1s
interval = ${?MQTT_CONSUMER_THROTTLING_INTERVAL}
# The maximum number of messages the consumer is allowed to receive
# within the configured throttling interval e.g. 100 msgs/s.
# Must be > 0.
limit = 100
limit = ${?MQTT_CONSUMER_THROTTLING_LIMIT}
}
# MQTT 5 only.
# The Client uses this value to limit the number of QoS 1 and QoS 2
# publications that it is willing to process concurrently.
# There is no mechanism to limit the QoS 0 publications that the Server
# might try to send.
# Minimum value is 1, maximum value is 65535; default is the maximum.
# The Receive Maximum of the server cannot be configured by Ditto.
receive-maximum-client = 65535
receive-maximum-client = ${?CONNECTIVITY_MQTT_CLIENT_RECEIVE_MAXIMUM}
}
http-push {
# How many messages to buffer in the publisher actor before dropping them. Each takes up to 100 KB heap space.
max-queue-size = 1000
max-queue-size = ${?CONNECTIVITY_HTTP_PUSH_MAX_QUEUE_SIZE}
request-timeout = 60s
request-timeout = ${?CONNECTIVITY_HTTP_PUSH_REQUEST_TIMEOUT}
# proxy config
proxy {
enabled = false
enabled = ${?CONNECTIVITY_HTTP_PROXY_ENABLED}
hostname = ${?CONNECTIVITY_HTTP_PROXY_HOST}
port = ${?CONNECTIVITY_HTTP_PROXY_PORT}
username = ${?CONNECTIVITY_HTTP_PROXY_USERNAME}
password = ${?CONNECTIVITY_HTTP_PROXY_PASSWORD}
}
hmac-algorithms {
aws4-hmac-sha256 = "org.eclipse.ditto.connectivity.service.messaging.httppush.AwsRequestSigningFactory"
az-monitor-2016-04-01 =
"org.eclipse.ditto.connectivity.service.messaging.httppush.AzMonitorRequestSigningFactory"
az-sasl = "org.eclipse.ditto.connectivity.service.messaging.signing.AzSaslSigningFactory"
}
oauth2 {
token-cache {
# how many tokens to cache
maximum-size = 1
maximum-size = ${?CONNECTIVITY_HTTP_OAUTH2_CACHE_SIZE}
}
# Maximum clock skew of OAuth2 token endpoints. Access tokens are refreshed this long before expiration.
max-clock-skew = 60s
max-clock-skew = ${?CONNECTIVITY_HTTP_OAUTH2_MAX_CLOCK_SKEW}
# Whether to enforce HTTPS for OAuth2 token endpoints. Should be `true` for production environments
# in order not to transmit client secrets in plain text.
enforce-https = true
enforce-https = ${?CONNECTIVITY_HTTP_OAUTH2_ENFORCE_HTTPS}
}
omit-request-body-methods = ["GET", "DELETE"]
omit-request-body-methods = ${?CONNECTIVITY_HTTP_OMIT_REQUEST_BODY_METHODS}
}
kafka {
consumer {
throttling {
# even if Kafka trottling is disabled, the "Max inflight" messages will still be determined with `limit`
# and `max-in-flight-factor` configuration values - so increase them if you need more "max inflight"
# processed messages in Ditto
enabled = false
enabled = ${?KAFKA_CONSUMER_THROTTLING_ENABLED}
# Interval at which the consumer is throttled. Must be > 0s.
interval = 1s
interval = ${?KAFKA_CONSUMER_THROTTLING_INTERVAL}
# The maximum number of messages the consumer is allowed to receive within the configured
# throttling interval e.g. 100 msgs/s. Must be > 0.
limit = 100
limit = ${?KAFKA_CONSUMER_THROTTLING_LIMIT}
# Throttling detection tolerance in percent e.g. for a tolerance of 5% if consumed messages are above
# limit - 5% per interval the source is considered throttled.
throttling-detection-tolerance = 0.05
throttling-detection-tolerance = ${?KAFKA_CONSUMER_THROTTLING_DETECTION_TOLERANCE}
# How many unacknowledged messages are allowed at any time as factor of ${limit} - must be >= 1.0
# This limit couples latency with throughput (long latency before ack -> lower throughput)
max-in-flight-factor = 2.0
max-in-flight-factor = ${?KAFKA_CONSUMER_THROTTLING_MAX_IN_FLIGHT_FACTOR}
}
restart {
exponential-backoff {
min = 100ms
min = ${?KAFKA_CONSUMER_RESTART_BACK_OFF_MIN}
max = 60s
min = ${?KAFKA_CONSUMER_RESTART_BACK_OFF_MAX}
random-factor = 1.0
random-factor = ${?KAFKA_CONSUMER_RESTART_BACK_OFF_RANDOM_FACTOR}
}
}
pekko-connectors = ${pekko.kafka.consumer} # resolve defaults from reference.conf
pekko-connectors = {
use-dispatcher = "kafka-consumer-dispatcher"
poll-interval = 50ms
stop-timeout = 0s
connection-checker {
# Flag to turn on connection checker
enable = true
# Amount of attempts to be performed after a first connection failure occurs
# Required, non-negative integer
max-retries = 1
# Interval for the connection check. Used as the base for exponential retry.
check-interval = 5s
# Check interval multiplier for backoff interval
# Required, positive number
backoff-factor = 1.0
}
# Properties defined by org.apache.kafka.clients.consumer.ConsumerConfig
# can be defined in this configuration section.
kafka-clients {
enable.auto.commit = true
fetch.max.wait.ms = 2500
fetch.max.wait.ms = ${?KAFKA_CONSUMER_FETCH_MAX_WAIT_MS}
metadata.max.age.ms = 180000
metadata.max.age.ms = ${?KAFKA_CONNECTION_MAX_IDLE_MS}
connections.max.idle.ms = 180000
connections.max.idle.ms = ${?KAFKA_CONNECTION_MAX_IDLE_MS}
# The timeout used to detect client failures when using Kafka's group management facility.
# The client sends periodic heartbeats to indicate its liveness to the broker.
# If no heartbeats are received by the broker before the expiration of this session timeout,
# then the broker will remove this client from the group and initiate a rebalance.
session.timeout.ms = 10000
session.timeout.ms = ${?KAFKA_SESSION_TIMEOUT_MS}
# The expected time between heartbeats to the consumer coordinator when using Kafka's group management facilities.
# Heartbeats are used to ensure that the consumer's session stays active and to facilitate rebalancing
# when new consumers join or leave the group.
# The value must be set lower than `session.timeout.ms`, but typically should be set no higher
# than 1/3 of that value:
heartbeat.interval.ms = 3000
heartbeat.interval.ms = ${?KAFKA_HEARTBEAT_INTERVAL_MS}
}
}
metric-collecting-interval = 10s
metric-collecting-interval = ${?KAFKA_METRIC_COLLECTING_INTERVAL}
# Timeout before the consumer is initialized and considered "ready".
init-timeout-seconds = 3
init-timeout-seconds = ${?KAFKA_CONSUMER_INIT_TIMEOUT_SECONDS}
}
committer {
pekko-connectors = ${pekko.kafka.committer} # resolve defaults from reference.conf
pekko-connectors = {
# Maximum number of messages in a single commit batch
max-batch = 1000
max-batch = ${?KAFKA_COMMITTER_MAX_BATCH}
# Maximum interval between commits
max-interval = 10s
max-interval = ${?KAFKA_COMMITTER_MAX_INTERVAL}
}
}
producer {
# If a message can't be published it is put in a queue. Further messages are dropped when the queue is full.
queue-size = 1000
queue-size = ${?KAFKA_PRODUCER_QUEUE_SIZE}
# Messages to publish in parallel per Kafka-Publisher (one per connectivity client)
parallelism = 10
parallelism = ${?KAFKA_PRODUCER_PARALLELISM}
# Minimum duration before restarting the Kafka-Publisher stream
min-backoff = 1s
min-backoff = ${?KAFKA_PRODUCER_MIN_BACKOFF}
# Maximum duration before restarting the Kafka-Publisher stream
max-backoff = 10s
max-backoff = ${?KAFKA_PRODUCER_MAX_BACKOFF}
# Random factor to vary the restart backoff
random-factor = 0.2
random-factor = ${?KAFKA_PRODUCER_RANDOM_FACTOR}
# Maximum restarts within duration before failing the Kafka-Publisher stream
max-restarts-count = 3
max-restarts-count = ${?KAFKA_PRODUCER_MAX_RESTARTS_COUNT}
max-restarts-within = 90s
max-restarts-within = ${?KAFKA_PRODUCER_MAX_RESTARTS_WITHIN}
# Timeout before the producer is initialized and considered "ready".
init-timeout-seconds = 3
init-timeout-seconds = ${?KAFKA_PRODUCER_INIT_TIMEOUT_SECONDS}
pekko-connectors = ${pekko.kafka.producer} # resolve defaults from reference.conf
pekko-connectors {
use-dispatcher = "kafka-producer-dispatcher"
# Properties defined by org.apache.kafka.clients.producer.ProducerConfig
# can be defined in this configuration section.
kafka-clients {
# Close idle connections after the number of milliseconds specified by this config.
# When a message should be produced after a connection was closed because of this timeout, the client
# simply opens the connection again, so for producers there is no need to increase this value:
connections.max.idle.ms = 180000
connections.max.idle.ms = ${?KAFKA_CONNECTION_MAX_IDLE_MS}
metadata.max.age.ms = 180000
metadata.max.age.ms = ${?KAFKA_CONNECTION_MAX_IDLE_MS}
# The maximum amount of time in milliseconds to wait when reconnecting to a broker that has repeatedly failed to connect.
# If provided, the backoff per host will increase exponentially for each consecutive connection failure, up to this maximum.
reconnect.backoff.max.ms = 10000 # default: 1000
# The base amount of time to wait before attempting to reconnect to a given host.
# This avoids repeatedly connecting to a host in a tight loop.
reconnect.backoff.ms = 500 # default: 50
# Request acknowledgement
acks = "1"
# Disable automatic retry
retries = 0
# Max wait before 1 send attempt fails
request.timeout.ms = 10000 # default: 40000
# Max wait before send fails
delivery.timeout.ms = 10000 # default: 120000
# Max wait for downed broker before connection fails
max.block.ms = 10000 # default: 60000
}
}
}
}
cleanup {
# enabled configures whether background cleanup is enabled or not
# If enabled, stale "snapshot" and "journal" entries will be cleaned up from the MongoDB by a background process
enabled = true
enabled = ${?CLEANUP_ENABLED}
# history-retention-duration configures the duration of how long to "keep" events and snapshots before being
# allowed to remove them in scope of cleanup.
# If this e.g. is set to 30d - then effectively an event history of 30 days would be available via the read
# journal.
history-retention-duration = 30d
history-retention-duration = ${?CLEANUP_HISTORY_RETENTION_DURATION}
# quiet-period defines how long to stay in a state where the background cleanup is not yet started
# Applies after:
# - starting the service
# - each "completed" background cleanup run (all entities were cleaned up)
quiet-period = 5m
quiet-period = ${?CLEANUP_QUIET_PERIOD}
# interval configures how often a "credit decision" is made.
# The background cleanup works with a credit system and does only generate new "cleanup credits" if the MongoDB
# currently has capacity to do cleanups.
interval = 60s
interval = ${?CLEANUP_INTERVAL}
# timer-threshold configures the maximum database latency to give out credit for cleanup actions.
# If write operations to the MongoDB within the last `interval` had a `max` value greater to the configured
# threshold, no new cleanup credits will be issued for the next `interval`.
# Which throttles cleanup when MongoDB is currently under heavy (write) load.
timer-threshold = 150ms
timer-threshold = ${?CLEANUP_TIMER_THRESHOLD}
# credits-per-batch configures how many "cleanup credits" should be generated per `interval` as long as the
# write operations to the MongoDB are less than the configured `timer-threshold`.
# Limits the rate of cleanup actions to this many per credit decision interval.
# One credit means that the "journal" and "snapshot" entries of one entity are cleaned up each `interval`.
credits-per-batch = 1
credits-per-batch = ${?CLEANUP_CREDITS_PER_BATCH}
# reads-per-query configures the number of snapshots to scan per MongoDB query.
# Configuring this to high values will reduce the need to query MongoDB too often - it should however be aligned
# with the amount of "cleanup credits" issued per `interval` - in order to avoid long running queries.
reads-per-query = 100
reads-per-query = ${?CLEANUP_READS_PER_QUERY}
# writes-per-credit configures the number of documents to delete for each credit.
# If for example one entity would have 1000 journal entries to cleanup, a `writes-per-credit` of 100 would lead
# to 10 delete operations performed against MongoDB.
writes-per-credit = 100
writes-per-credit = ${?CLEANUP_WRITES_PER_CREDIT}
# delete-final-deleted-snapshot configures whether for a deleted entity, the final snapshot (containing the
# "deleted" information) should be deleted or not.
# If the final snapshot is not deleted, re-creating the entity will cause that the recreated entity starts with
# a revision number 1 higher than the previously deleted entity. If the final snapshot is deleted as well,
# recreation of an entity with the same ID will lead to revisionNumber=1 after its recreation.
delete-final-deleted-snapshot = false
delete-final-deleted-snapshot = ${?CLEANUP_DELETE_FINAL_DELETED_SNAPSHOT}
}
}
mapping {
# the buffer size used for the queue in the message mapping processor actor
buffer-size = 500
buffer-size = ${?CONNECTIVITY_SIGNAL_ENRICHMENT_BUFFER_SIZE}
# parallelism to use for signal enriching a single message in the message mapping processor actor
# when configured too low, throughput of signal enrichment will be low
parallelism = 100
parallelism = ${?CONNECTIVITY_SIGNAL_ENRICHMENT_PARALLELISM}
# maximum parallelism for mapping incoming and outgoing messages for a connection. This setting limits the
# poolSize that users can configure on their connections.
max-pool-size = 5
max-pool-size = ${?CONNECTIVITY_MESSAGE_MAPPING_MAX_POOL_SIZE}
# Whether messages with failed enrichments should be published.
publish-failed-enrichments = false
publish-failed-enrichments = ${?CONNECTIVITY_MESSAGE_MAPPING_PUBLISH_FAILED_ENRICHMENTS}
javascript {
# the maximum script size in bytes of a mapping script to run
# prevents loading big JS dependencies into the script (e.g. jQuery which has ~250kB)
maxScriptSizeBytes = 50000 # 50kB
maxScriptSizeBytes = ${?CONNECTIVITY_MESSAGE_MAPPING_JS_MAX_SCRIPT_SIZE_BYTES}
# the maximum execution time of a mapping script to run
# prevents endless loops and too complex scripts
maxScriptExecutionTime = 500ms
maxScriptExecutionTime = ${?CONNECTIVITY_MESSAGE_MAPPING_JS_MAX_EXECUTION_TIME}
# the maximum call stack depth in the mapping script
# prevents recursions or other too complex computation
maxScriptStackDepth = 25
maxScriptStackDepth = ${?CONNECTIVITY_MESSAGE_MAPPING_JS_MAX_STACK_DEPTH}
# Whether to allow using 'print', 'exit', 'quit' in JavaScript executions, only intended for debugging purposes
allowUnsafeStandardObjects = false
allowUnsafeStandardObjects = ${?CONNECTIVITY_MESSAGE_MAPPING_JS_ALLOW_UNSAFE_STANDARD_OBJECTS}
# The filesystem path where to load CommonJS modules from, by default empty indicating to not load any CommonJS modules
commonJsModulePath = ""
commonJsModulePath = ${?CONNECTIVITY_MESSAGE_MAPPING_JS_COMMON_JS_MODULE_PATH}
}
mapper-limits {
# maximum number of mappers defined in one source
max-source-mappers = 10
# maximum number of messages invoked by a mapper
# defined in source
max-mapped-inbound-messages = 10
# maximum number of mappers defined in one source
max-target-mappers = 10
# maximum number of messages invoked by a mapper
# defined in target
max-mapped-outbound-messages = 10
}
}
persistence-ping {
# journal tag to query to find our which connectionPersistenceActors to ping (reconnect)
journal-tag = ""
journal-tag = ${?RECONNECT_JOURNAL_TAG}
# initial delay for pinging / reconnecting the connections after the PersistencePingActor has been started.
# have a little delay so that connection actors restored with "remember-entities" are not tried to be restored twice
initial-delay = 5s
initial-delay = ${?RECONNECT_INITIAL_DELAY}
# interval for trying to reconnect all started connections.
interval = 10m
interval = ${?RECONNECT_INTERVAL}
# how many events to read in one query
read-journal-batch-size = 500
read-journal-batch-size = ${?RECONNECT_READ_JOURNAL_BATCH_SIZE}
# one of:
# TAGS Elements will be ordered by their tags.
# ID Elements will be ordered by their document ID.
streaming-order = TAGS
streaming-order = ${?PERSISTENCE_PING_STREAMING_ORDER}
# used to throttle pinging of connections, so that not all connections are recovered at the same time
rate {
frequency = 1s
frequency = ${?RECONNECT_RATE_FREQUENCY}
entities = 1
entities = ${?RECONNECT_RATE_ENTITIES}
}
}
connection-ids-retrieval {
# how many events to read in one query
read-journal-batch-size = 500
read-journal-batch-size = ${?CONNECTION_IDS_RETRIEVAL_READ_JOURNAL_BATCH_SIZE}
# how many snapshots to read in one query
read-snapshot-batch-size = 50
read-snapshot-batch-size = ${?CONNECTION_IDS_RETRIEVAL_READ_SNAPSHOT_BATCH_SIZE}
}
client {
# Initial timeout after the init process is triggered.
init-timeout = 5s
init-timeout = ${?CONNECTIVITY_CLIENT_INIT_TIMEOUT}
# Initial timeout when connecting to a remote system. If the connection could not be established after this time,
# the service will try to reconnect. If a failure happened during connecting, then the service will wait
# for at least this time until it will try to reconnect. The max timeout is defined in connecting-max-timeout.
# this timeout needs to be smaller than ditto.connectivity.connection.client-actor-ask-timeout in connectivity.conf
connecting-min-timeout = 50s
connecting-min-timeout = ${?CONNECTIVITY_CLIENT_CONNECTING_MIN_TIMEOUT}
# Max timeout (until reconnecting) when connecting to a remote system.
# Should be greater than connecting-min-timeout.
connecting-max-timeout = 60m
connecting-max-timeout = ${?CONNECTIVITY_CLIENT_CONNECTING_MAX_TIMEOUT}
# How many times we will try to reconnect when connecting to a remote system.
# max time ~= connecting-max-tries * connecting-max-timeout = 50 * 60m = 50h
connecting-max-tries = 50
connecting-max-tries = ${?CONNECTIVITY_CLIENT_CONNECTING_MAX_TRIES}
# Max timeout when actually disconnecting until we're assuming disconnecting failed. The timeout will start
# after a disconnect announcment was sent (see disconnect-announcement-timeout) and disconnecting is actually
# triggered. Thus, the total amount of timeout that might elapse between closing a connection and running into
# the timeout, is: disconnect-announcement-timeout + disconnecting-max-timeout.
disconnecting-max-timeout = 5s
disconnecting-max-timeout = ${?CONNECTIVITY_CLIENT_DISCONNECTING_MAX_TIMEOUT}
# Time that will be waited between sending a disconnect announcement and actually disconnecting.
# When closing a connection, a disconnect announcement (special topic for connection targets) will be sent to
# the client. The connection will wait for disconnect-announcement-timeout before actually disconnecting
# the client.
disconnect-announcement-timeout = 3s
disconnect-announcement-timeout = ${?CONNECTIVITY_CLIENT_DISCONNECT_ANNOUNCEMENT_TIMEOUT}
# Max timeout until waiting for search commands.
subscription-manager-timeout = 60s
subscription-manager-timeout = ${?CONNECTIVITY_CLIENT_SUBSCRIPTION_MANAGER_TIMEOUT}
# how long the service will wait for a successful connection when testing a new connection. If no response is
# received after this duration, the test will be assumed a failure.
testing-timeout = 10s
testing-timeout = ${?CONNECTIVITY_CLIENT_TESTING_TIMEOUT}
# Min backoff after connection failure.
min-backoff = 5s
min-backoff = ${?CONNECTIVITY_CLIENT_MIN_BACKOFF}
# Max backoff after connection failure.
max-backoff = 60m
max-backoff = ${?CONNECTIVITY_CLIENT_MAX_BACKOFF}
# How often to refresh the cache of other client actors if client count > 1
client-actor-refs-notification-delay = 5m
# How often to refresh Ditto pubsub subscriptions
subscription-refresh-delay = 5m
subscription-refresh-delay = ${?CONNECTIVITY_CLIENT_SUBSCRIPTION_REFRESH_INTERVAL}
}
monitoring {
logger {
successCapacity = 10
successCapacity = ${?CONNECTIVITY_LOGGER_SUCCESS_CAPACITY}
failureCapacity = 10
failureCapacity = ${?CONNECTIVITY_LOGGER_FAILURE_CAPACITY}
maxLogSizeBytes = 250000
maxLogSizeBytes = ${?CONNECTIVITY_LOGGER_MAX_LOG_SIZE_BYTES}
logDuration = 1h
logDuration = ${?CONNECTIVITY_LOGGER_LOG_DURATION}
loggingActiveCheckInterval = 5m
loggingActiveCheckInterval = ${?CONNECTIVITY_LOGGER_ACTIVE_CHECK_INTERVAL}
# configuration for FluentPublishingConnectionLogger used to publish connection logs to a fluentd/fluentbit endpoint
publisher {
enabled = false
enabled = ${?CONNECTIVITY_LOGGER_PUBLISHER_ENABLED}
# the log levels to use for logging in the publisher as comma separated list
# supported: "failure" "success"
logLevels = "success,failure"
logLevels = ${?CONNECTIVITY_LOGGER_PUBLISHER_LOG_LEVELS}
# whether to log headers and payload for publisher logs:
logHeadersAndPayload = false
logHeadersAndPayload = ${?CONNECTIVITY_LOGGER_PUBLISHER_LOG_HEADERS_AND_PAYLOAD}
# a specific log-tag to use for the published logs. If null, a default log-tag will be used: "connection:<connection-id>"
log-tag = null
log-tag = ${?CONNECTIVITY_LOGGER_PUBLISHER_LOG_TAG}
# add key/value pairs to this section in order to have them added to published logs
additional-log-context {
# by default empty
}
# fluency is the library used to publish connection logs to a fluentd/fluentbit endpoint
fluency {
## NetworkSender.Config
host = "localhost"
host = ${?CONNECTIVITY_LOGGER_PUBLISHER_FLUENCY_HOST}
port = 24224
port = ${?CONNECTIVITY_LOGGER_PUBLISHER_FLUENCY_PORT}
sslEnabled = false # library default: false
sslEnabled = ${?CONNECTIVITY_LOGGER_PUBLISHER_FLUENCY_SSL_ENABLED}
# Socket connection timeout:
connectionTimeout = 5s # library default: 5s, min: 10ms
connectionTimeout = ${?CONNECTIVITY_LOGGER_PUBLISHER_FLUENCY_CONNECTION_TIMEOUT}
# Socket read timeout:
readTimeout = 5s # library default: 5s, min: 10ms
readTimeout = ${?CONNECTIVITY_LOGGER_PUBLISHER_FLUENCY_READ_TIMEOUT}
## Flusher.Config
# how often to check if a flush was requested from "outside", e.g. by closing the flusher
# and send logs to the endpoint if that was the case:
flushAttemptInterval = 600ms # library default: 600ms, min: 20ms, max: 2000ms
# when closing flusher, wait that long until forcefully stopping flusher:
waitUntilBufferFlushed = 60s # library default: 60s, min: 1s
# when closing flusher, wait that long for resoruces until forcefully stopping:
waitUntilTerminated = 60s # library default: 60s, min: 1s
## Buffer.Config
# the maximum possible log entries total size to buffer in memory:
maxBufferSize = 67108864 # 64 * 1024 * 1024 - library default: 512 * 1024 * 1024 = 512MiB
# the initial chunk size, that much memory is allocated at least per instance:
bufferChunkInitialSize = 1048576 # library default: 1024 * 1024 = 1MiB
# after the buffer reached this size, perform a flush, sending logs to the endpoint:
bufferChunkRetentionSize = 4194304 # library default: 4 * 1024 * 1024 = 4MiB
# after the oldest buffered entry is this old, perform a flush, sending logs to the endpoint:
bufferChunkRetentionTime = 1s # library default: 1s
# Use JVM heap memory for buffer pool, if `false`, memory is allocated via `ByteBuffer.allocateDirect`
jvmHeapBufferMode = false # library default: false
# for file backup mode:
# "In this mode, Fluency takes backup of unsent memory buffers as files when closing and then resends them when restarting"
fileBackupDir = null # library default: null
## ExponentialBackOffRetryStrategy.Config
senderMaxRetryCount = 7 # min: 0 (meaning retries off)
## RetryStrategy.Config