karafka 1.4.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (102) hide show
  1. checksums.yaml +7 -0
  2. checksums.yaml.gz.sig +2 -0
  3. data.tar.gz.sig +0 -0
  4. data/.coditsu/ci.yml +3 -0
  5. data/.console_irbrc +11 -0
  6. data/.diffend.yml +3 -0
  7. data/.github/FUNDING.yml +3 -0
  8. data/.github/ISSUE_TEMPLATE/bug_report.md +50 -0
  9. data/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
  10. data/.github/workflows/ci.yml +52 -0
  11. data/.gitignore +69 -0
  12. data/.rspec +1 -0
  13. data/.ruby-gemset +1 -0
  14. data/.ruby-version +1 -0
  15. data/CHANGELOG.md +566 -0
  16. data/CODE_OF_CONDUCT.md +46 -0
  17. data/CONTRIBUTING.md +41 -0
  18. data/Gemfile +14 -0
  19. data/Gemfile.lock +139 -0
  20. data/MIT-LICENCE +18 -0
  21. data/README.md +99 -0
  22. data/bin/karafka +19 -0
  23. data/certs/mensfeld.pem +25 -0
  24. data/config/errors.yml +39 -0
  25. data/docker-compose.yml +17 -0
  26. data/karafka.gemspec +43 -0
  27. data/lib/karafka.rb +72 -0
  28. data/lib/karafka/app.rb +53 -0
  29. data/lib/karafka/attributes_map.rb +62 -0
  30. data/lib/karafka/backends/inline.rb +16 -0
  31. data/lib/karafka/base_consumer.rb +57 -0
  32. data/lib/karafka/base_responder.rb +226 -0
  33. data/lib/karafka/cli.rb +54 -0
  34. data/lib/karafka/cli/base.rb +78 -0
  35. data/lib/karafka/cli/console.rb +31 -0
  36. data/lib/karafka/cli/flow.rb +48 -0
  37. data/lib/karafka/cli/info.rb +31 -0
  38. data/lib/karafka/cli/install.rb +66 -0
  39. data/lib/karafka/cli/server.rb +71 -0
  40. data/lib/karafka/code_reloader.rb +67 -0
  41. data/lib/karafka/connection/api_adapter.rb +161 -0
  42. data/lib/karafka/connection/batch_delegator.rb +55 -0
  43. data/lib/karafka/connection/builder.rb +18 -0
  44. data/lib/karafka/connection/client.rb +117 -0
  45. data/lib/karafka/connection/listener.rb +71 -0
  46. data/lib/karafka/connection/message_delegator.rb +36 -0
  47. data/lib/karafka/consumers/batch_metadata.rb +10 -0
  48. data/lib/karafka/consumers/callbacks.rb +71 -0
  49. data/lib/karafka/consumers/includer.rb +64 -0
  50. data/lib/karafka/consumers/responders.rb +24 -0
  51. data/lib/karafka/consumers/single_params.rb +15 -0
  52. data/lib/karafka/contracts.rb +10 -0
  53. data/lib/karafka/contracts/config.rb +21 -0
  54. data/lib/karafka/contracts/consumer_group.rb +206 -0
  55. data/lib/karafka/contracts/consumer_group_topic.rb +19 -0
  56. data/lib/karafka/contracts/responder_usage.rb +54 -0
  57. data/lib/karafka/contracts/server_cli_options.rb +31 -0
  58. data/lib/karafka/errors.rb +51 -0
  59. data/lib/karafka/fetcher.rb +42 -0
  60. data/lib/karafka/helpers/class_matcher.rb +88 -0
  61. data/lib/karafka/helpers/config_retriever.rb +46 -0
  62. data/lib/karafka/helpers/inflector.rb +26 -0
  63. data/lib/karafka/helpers/multi_delegator.rb +32 -0
  64. data/lib/karafka/instrumentation/logger.rb +58 -0
  65. data/lib/karafka/instrumentation/monitor.rb +70 -0
  66. data/lib/karafka/instrumentation/proctitle_listener.rb +36 -0
  67. data/lib/karafka/instrumentation/stdout_listener.rb +140 -0
  68. data/lib/karafka/params/batch_metadata.rb +26 -0
  69. data/lib/karafka/params/builders/batch_metadata.rb +30 -0
  70. data/lib/karafka/params/builders/params.rb +38 -0
  71. data/lib/karafka/params/builders/params_batch.rb +25 -0
  72. data/lib/karafka/params/metadata.rb +20 -0
  73. data/lib/karafka/params/params.rb +50 -0
  74. data/lib/karafka/params/params_batch.rb +60 -0
  75. data/lib/karafka/patches/ruby_kafka.rb +47 -0
  76. data/lib/karafka/persistence/client.rb +29 -0
  77. data/lib/karafka/persistence/consumers.rb +45 -0
  78. data/lib/karafka/persistence/topics.rb +48 -0
  79. data/lib/karafka/process.rb +60 -0
  80. data/lib/karafka/responders/builder.rb +36 -0
  81. data/lib/karafka/responders/topic.rb +55 -0
  82. data/lib/karafka/routing/builder.rb +89 -0
  83. data/lib/karafka/routing/consumer_group.rb +61 -0
  84. data/lib/karafka/routing/consumer_mapper.rb +34 -0
  85. data/lib/karafka/routing/proxy.rb +46 -0
  86. data/lib/karafka/routing/router.rb +29 -0
  87. data/lib/karafka/routing/topic.rb +62 -0
  88. data/lib/karafka/routing/topic_mapper.rb +53 -0
  89. data/lib/karafka/serialization/json/deserializer.rb +27 -0
  90. data/lib/karafka/serialization/json/serializer.rb +31 -0
  91. data/lib/karafka/server.rb +86 -0
  92. data/lib/karafka/setup/config.rb +223 -0
  93. data/lib/karafka/setup/configurators/water_drop.rb +36 -0
  94. data/lib/karafka/setup/dsl.rb +21 -0
  95. data/lib/karafka/status.rb +29 -0
  96. data/lib/karafka/templates/application_consumer.rb.erb +7 -0
  97. data/lib/karafka/templates/application_responder.rb.erb +11 -0
  98. data/lib/karafka/templates/karafka.rb.erb +92 -0
  99. data/lib/karafka/version.rb +7 -0
  100. data/log/.gitkeep +0 -0
  101. metadata +325 -0
  102. metadata.gz.sig +4 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: e1bc3a30364a87750723e5c338cdddffb6c6c4c2965e12a7379fbe96a6e7756c
4
+ data.tar.gz: 073fe6b2ffe1d7cbd53670330cd14780b48dda4f364a4ba160a42c13a1914c2d
5
+ SHA512:
6
+ metadata.gz: d7bbc41af65bf2590d7e045e552b10121f202b7a031681c7ac5d20148e8c6c053eced4aa98ece0661a1ead6df1c163b8d03e06b19ca5f83346c4575ec10489c7
7
+ data.tar.gz: 522f1a73478633269333f04ebdfffb988e26a405b659e44bf44da5757b105dd24bc16f3214415d4258c325c1c4fa899f54ef322a335b31b859dda131a70e2021
@@ -0,0 +1,2 @@
1
+ R�ظ#o��B�d� ��Us��ˠl�˧�Π,��!�V��a��5��1i*�~��/��Ս��`����ͨ�;*p�<R�SDN�����e�ҥ5'|7�ho*�;VԦm�,!��l��I���-��$��� �Jy��'�ߗ%��!_^��6$`(M�3}��{�1,��K]|�E%�!�\�P�N�r)� ����?n%ҷȅ�����c+/?�5>�w�|Ic5L%N��,?�xN��������4h�
2
+ (��|&&���]7'�@�)!��XM���N��e��������u�Wm�h������
Binary file
@@ -0,0 +1,3 @@
1
+ repository_id: 'd4482d42-f6b5-44ba-a5e4-00989ac519ee'
2
+ api_key: <%= ENV['CODITSU_API_KEY'] %>
3
+ api_secret: <%= ENV['CODITSU_API_SECRET'] %>
@@ -0,0 +1,11 @@
1
+ # irbrc for Karafka console
2
+
3
+ IRB.conf[:AUTO_INDENT] = true
4
+ IRB.conf[:SAVE_HISTORY] = 1000
5
+ IRB.conf[:USE_READLINE] = true
6
+ IRB.conf[:HISTORY_FILE] = ".irb-history"
7
+ IRB.conf[:LOAD_MODULES] = [] unless IRB.conf.key?(:LOAD_MODULES)
8
+
9
+ unless IRB.conf[:LOAD_MODULES].include?('irb/completion')
10
+ IRB.conf[:LOAD_MODULES] << 'irb/completion'
11
+ end
@@ -0,0 +1,3 @@
1
+ project_id: 'de9b9933-7610-4cc4-b69b-f7e3e3c5e797'
2
+ shareable_id: '68a8c626-b605-40ad-ac45-e3961ad7c57d'
3
+ shareable_key: 'a3ec2dac-fba2-4b6c-b181-49e927b15057'
@@ -0,0 +1,3 @@
1
+ # These are supported funding model platforms
2
+
3
+ open_collective: karafka
@@ -0,0 +1,50 @@
1
+ ---
2
+ name: Bug Report
3
+ about: Report an issue with Karafka you've discovered.
4
+ ---
5
+
6
+ *Be clear, concise and precise in your description of the problem.
7
+ Open an issue with a descriptive title and a summary in grammatically correct,
8
+ complete sentences.*
9
+
10
+ *Use the template below when reporting bugs. Please, make sure that
11
+ you're running the latest stable Karafka and that the problem you're reporting
12
+ hasn't been reported (and potentially fixed) already.*
13
+
14
+ *Before filing the ticket you should replace all text above the horizontal
15
+ rule with your own words.*
16
+
17
+ --------
18
+
19
+ ## Expected behavior
20
+
21
+ Describe here how you expected Karafka to behave in this particular situation.
22
+
23
+ ## Actual behavior
24
+
25
+ Describe here what actually happened.
26
+
27
+ ## Steps to reproduce the problem
28
+
29
+ This is extremely important! Providing us with a reliable way to reproduce
30
+ a problem will expedite its solution.
31
+
32
+ ## Your setup details
33
+
34
+ Please provide kafka version and the output of `karafka info` or `bundle exec karafka info` if using Bundler.
35
+
36
+ Here's an example:
37
+
38
+ ```
39
+ $ [bundle exec] karafka info
40
+ Karafka version: 1.3.0
41
+ Ruby version: 2.6.3
42
+ Ruby-kafka version: 0.7.9
43
+ Application client id: karafka-local
44
+ Backend: inline
45
+ Batch fetching: true
46
+ Batch consuming: true
47
+ Boot file: /app/karafka/karafka.rb
48
+ Environment: development
49
+ Kafka seed brokers: ["kafka://kafka:9092"]
50
+ ```
@@ -0,0 +1,20 @@
1
+ ---
2
+ name: Feature Request
3
+ about: Suggest new Karafka features or improvements to existing features.
4
+ ---
5
+
6
+ ## Is your feature request related to a problem? Please describe.
7
+
8
+ A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9
+
10
+ ## Describe the solution you'd like
11
+
12
+ A clear and concise description of what you want to happen.
13
+
14
+ ## Describe alternatives you've considered
15
+
16
+ A clear and concise description of any alternative solutions or features you've considered.
17
+
18
+ ## Additional context
19
+
20
+ Add any other context or screenshots about the feature request here.
@@ -0,0 +1,52 @@
1
+ name: ci
2
+
3
+ on:
4
+ push:
5
+ schedule:
6
+ - cron: '0 1 * * *'
7
+
8
+ jobs:
9
+ specs:
10
+ runs-on: ubuntu-latest
11
+ strategy:
12
+ fail-fast: false
13
+ matrix:
14
+ ruby:
15
+ - '2.7'
16
+ - '2.6'
17
+ - '2.5'
18
+ include:
19
+ - ruby: '2.7'
20
+ coverage: 'true'
21
+ steps:
22
+ - uses: actions/checkout@v2
23
+ - name: Install package dependencies
24
+ run: "[ -e $APT_DEPS ] || sudo apt-get install -y --no-install-recommends $APT_DEPS"
25
+ - name: Set up Ruby
26
+ uses: ruby/setup-ruby@v1
27
+ with:
28
+ ruby-version: ${{matrix.ruby}}
29
+ - name: Install latest bundler
30
+ run: |
31
+ gem install bundler --no-document
32
+ bundle config set without 'tools benchmarks docs'
33
+ - name: Bundle install
34
+ run: |
35
+ bundle config set without development
36
+ bundle install --jobs 4 --retry 3
37
+ - name: Run Kafka with docker-compose
38
+ run: docker-compose up -d
39
+ - name: Run all tests
40
+ env:
41
+ GITHUB_COVERAGE: ${{matrix.coverage}}
42
+ run: bundle exec rspec
43
+ coditsu:
44
+ runs-on: ubuntu-latest
45
+ strategy:
46
+ fail-fast: false
47
+ steps:
48
+ - uses: actions/checkout@v2
49
+ with:
50
+ fetch-depth: 0
51
+ - name: Run Coditsu
52
+ run: \curl -sSL https://api.coditsu.io/run/ci | bash
@@ -0,0 +1,69 @@
1
+ # bundler state
2
+ /.bundle
3
+ /vendor/bundle/
4
+ /vendor/ruby/
5
+ /ruby/
6
+ app.god
7
+
8
+ # minimal Rails specific artifacts
9
+ /.coditsu/local.yml
10
+ db/*.sqlite3
11
+ /log/development.log
12
+ /log/production.log
13
+ /log/test.log
14
+ /tmp/*
15
+ *.gem
16
+ *.~
17
+
18
+ # various artifacts
19
+ **.war
20
+ *.rbc
21
+ *.sassc
22
+ .byebug_history
23
+ .redcar/
24
+ .capistrano/
25
+ .sass-cache
26
+ /config/god/sidekiq.rb
27
+ /config/puma.rb
28
+ /coverage.data
29
+ /coverage/
30
+ /doc/api/
31
+ /doc/app/
32
+ /doc/yard
33
+ /doc/features.html
34
+ /doc/specs.html
35
+ /spec/tmp/*
36
+ /cache
37
+ /capybara*
38
+ /capybara-*.html
39
+ /gems
40
+ /specifications
41
+ rerun.txt
42
+ pickle-email-*.html
43
+
44
+ # If you find yourself ignoring temporary files generated by your text editor
45
+ # or operating system, you probably want to add a global ignore instead:
46
+ # git config --global core.excludesfile ~/.gitignore_global
47
+ #
48
+ # Here are some files you may want to ignore globally:
49
+
50
+ # scm revert files
51
+ **.orig
52
+
53
+ # Mac finder artifacts
54
+ .DS_Store
55
+
56
+ # Netbeans project directory
57
+ /nbproject
58
+
59
+ # RubyMine project files
60
+ .idea
61
+
62
+ # Textmate project files
63
+ /*.tmproj
64
+
65
+ # vim artifacts
66
+ **.swp
67
+
68
+ # documentation
69
+ .yardoc
data/.rspec ADDED
@@ -0,0 +1 @@
1
+ --require spec_helper
@@ -0,0 +1 @@
1
+ karafka
@@ -0,0 +1 @@
1
+ 2.7.1
@@ -0,0 +1,566 @@
1
+ # Karafka framework changelog
2
+
3
+ ## 1.4.0.rc1 (2020-08-25)
4
+ - Rename `Karafka::Params::Metadata` to `Karafka::Params::BatchMetadata`
5
+ ` Rename consumer `#metadata` to `#batch_metadata`
6
+ - Separate metadata (including Karafka native metadata) from the root of params
7
+ - Remove metadata hash dependency
8
+ - Remove params dependency on a hash in favour of PORO
9
+ - Remove batch metadata dependency on a hash
10
+ - Remove MultiJson in favour of JSON in the default deserializer
11
+ - allow accessing all the metadata without accessing the payload
12
+ - freeze params and underlying elements except for the mutable payload
13
+ - provide access to raw payload after serialization
14
+ - fixes a bug where a non-deserializable (error) params would be marked as deserialized after first unsuccessful deserialization attempt
15
+ - fixes bug where karafka would mutate internal ruby-kafka state
16
+ - fixes bug where topic name in metadata would not be mapped using topic mappers
17
+ - simplifies the params and params batch API, before `#payload` usage, it won't be deserialized
18
+ - removes the `#[]` API from params to prevent from accessing raw data in a different way than #raw_payload
19
+ - makes the params batch operations consistent as params payload is deserialized only when accessed explicitly
20
+
21
+ ## 1.3.7 (2020-08-11)
22
+ - #599 - Allow metadata access without deserialization attempt (rabotyaga)
23
+ - Sync with ruby-kafka `1.2.0` api
24
+
25
+ ## 1.3.6 (2020-04-24)
26
+ - #583 - Use Karafka.logger for CLI messages (prikha)
27
+ - #582 - Cannot only define seed brokers in consumer groups
28
+
29
+ ## 1.3.5 (2020-04-02)
30
+ - #578 - ThreadError: can't be called from trap context patch
31
+
32
+ ## 1.3.4 (2020-02-17)
33
+ - `dry-configurable` upgrade (solnic)
34
+ - Remove temporary `thor` patches that are no longer needed
35
+
36
+ ## 1.3.3 (2019-12-23)
37
+ - Require `delegate` to fix missing dependency in `ruby-kafka`
38
+
39
+ ## 1.3.2 (2019-12-23)
40
+ - #561 - Allow `thor` 1.0.x usage in Karafka
41
+ - #567 - Ruby 2.7.0 support + unfreeze of a frozen string fix
42
+
43
+ ## 1.3.1 (2019-11-11)
44
+ - #545 - Makes sure the log directory exists when is possible (robertomiranda)
45
+ - Ruby 2.6.5 support
46
+ - #551 - add support for DSA keys
47
+ - #549 - Missing directories after `karafka install` (nijikon)
48
+
49
+ ## 1.3.0 (2019-09-09)
50
+ - Drop support for Ruby 2.4
51
+ - YARD docs tags cleanup
52
+
53
+ ## 1.3.0.rc1 (2019-07-31)
54
+ - Drop support for Kafka 0.10 in favor of native support for Kafka 0.11.
55
+ - Update ruby-kafka to the 0.7 version
56
+ - Support messages headers receiving
57
+ - Message bus unification
58
+ - Parser available in metadata
59
+ - Cleanup towards moving to a non-global state app management
60
+ - Drop Ruby 2.3 support
61
+ - Support for Ruby 2.6.3
62
+ - `Karafka::Loader` has been removed in favor of Zeitwerk
63
+ - Schemas are now contracts
64
+ - #393 - Reorganize responders - removed `multiple_usage` constrain
65
+ - #388 - ssl_client_cert_chain sync
66
+ - #300 - Store value in a value key and replace its content with parsed version - without root merge
67
+ - #331 - Disallow building groups without topics
68
+ - #340 - Instrumentation unification. Better and more consistent naming
69
+ - #340 - Procline instrumentation for a nicer process name
70
+ - #342 - Change default for `fetcher_max_queue_size` from `100` to `10` to lower max memory usage
71
+ - #345 - Cleanup exceptions names
72
+ - #341 - Split connection delegator into batch delegator and single_delegator
73
+ - #351 - Rename `#retrieve!` to `#parse!` on params and `#parsed` to `parse!` on params batch.
74
+ - #351 - Adds '#first' for params_batch that returns parsed first element from the params_batch object.
75
+ - #360 - Single params consuming mode automatically parses data specs
76
+ - #359 - Divide mark_as_consumed into mark_as_consumed and mark_as_consumed!
77
+ - #356 - Provide a `#values` for params_batch to extract only values of objects from the params_batch
78
+ - #363 - Too shallow ruby-kafka version lock
79
+ - #354 - Expose consumer heartbeat
80
+ - #377 - Remove the persistent setup in favor of persistence
81
+ - #375 - Sidekiq Backend parser mismatch
82
+ - #369 - Single consumer can support more than one topic
83
+ - #288 - Drop dependency on `activesupport` gem
84
+ - #371 - SASL over SSL
85
+ - #392 - Move params redundant data to metadata
86
+ - #335 - Metadata access from within the consumer
87
+ - #402 - Delayed reconnection upon critical failures
88
+ - #405 - `reconnect_timeout` value is now being validated
89
+ - #437 - Specs ensuring that the `#437` won't occur in the `1.3` release
90
+ - #426 - ssl client cert key password
91
+ - #444 - add certificate and private key validation
92
+ - #460 - Decouple responder "parser" (generator?) from topic.parser (benissimo)
93
+ - #463 - Split parsers into serializers / deserializers
94
+ - #473 - Support SASL OAuthBearer Authentication
95
+ - #475 - Disallow subscribing to the same topic with multiple consumers
96
+ - #485 - Setting shutdown_timeout to nil kills the app without waiting for anything
97
+ - #487 - Make listeners as instances
98
+ - #29 - Consumer class names must have the word "Consumer" in it in order to work (Sidekiq backend)
99
+ - #491 - irb is missing for console to work
100
+ - #502 - Karafka process hangs when sending multiple sigkills
101
+ - #506 - ssl_verify_hostname sync
102
+ - #483 - Upgrade dry-validation before releasing 1.3
103
+ - #492 - Use Zeitwerk for code reload in development
104
+ - #508 - Reset the consumers instances upon reconnecting to a cluster
105
+ - [#530](https://github.com/karafka/karafka/pull/530) - expose ruby and ruby-kafka version
106
+ - [534](https://github.com/karafka/karafka/pull/534) - Allow to use headers in the deserializer object
107
+ - [#319](https://github.com/karafka/karafka/pull/328) - Support for exponential backoff in pause
108
+
109
+ ## 1.2.11
110
+ - [#470](https://github.com/karafka/karafka/issues/470) Karafka not working with dry-configurable 0.8
111
+
112
+ ## 1.2.10
113
+ - [#453](https://github.com/karafka/karafka/pull/453) require `Forwardable` module
114
+
115
+ ## 1.2.9
116
+ - Critical exceptions now will cause consumer to stop instead of retrying without a break
117
+ - #412 - Fix dry-inflector dependency lock in gemspec
118
+ - #414 - Backport to 1.2 the delayed retry upon failure
119
+ - #437 - Raw message is no longer added to params after ParserError raised
120
+
121
+ ## 1.2.8
122
+ - #408 - Responder Topic Lookup Bug on Heroku
123
+
124
+ ## 1.2.7
125
+ - Unlock Ruby-kafka version with a warning
126
+
127
+ ## 1.2.6
128
+ - Lock WaterDrop to 1.2.3
129
+ - Lock Ruby-Kafka to 0.6.x (support for 0.7 will be added in Karafka 1.3)
130
+ - #382 - Full logging with AR, etc for development mode when there is Rails integration
131
+
132
+ ## 1.2.5
133
+ - #354 - Expose consumer heartbeat
134
+ - #373 - Async producer not working properly with responders
135
+
136
+ ## 1.2.4
137
+ - #332 - Fetcher for max queue size
138
+
139
+ ## 1.2.3
140
+ - #313 - support PLAINTEXT and SSL for scheme
141
+ - #288 - drop activesupport callbacks in favor of notifications
142
+ - #320 - Pausing indefinitely with nil pause timeout doesn't work
143
+ - #318 - Partition pausing doesn't work with custom topic mappers
144
+ - Rename ConfigAdapter to ApiAdapter to better reflect what it does
145
+ - #317 - Manual offset committing doesn't work with custom topic mappers
146
+
147
+ ## 1.2.2
148
+ - #312 - Broken for ActiveSupport 5.2.0
149
+
150
+ ## 1.2.1
151
+ - #304 - Unification of error instrumentation event details
152
+ - #306 - Using file logger from within a trap context upon shutdown is impossible
153
+
154
+ ## 1.2.0
155
+ - Spec improvements
156
+ - #260 - Specs missing randomization
157
+ - #251 - Shutdown upon non responding (unreachable) cluster is not possible
158
+ - #258 - Investigate lowering requirements on activesupport
159
+ - #246 - Alias consumer#mark_as_consumed on controller
160
+ - #259 - Allow forcing key/partition key on responders
161
+ - #267 - Styling inconsistency
162
+ - #242 - Support setting the max bytes to fetch per request
163
+ - #247 - Support SCRAM once released
164
+ - #271 - Provide an after_init option to pass a configuration block
165
+ - #262 - Error in the monitor code for NewRelic
166
+ - #241 - Performance metrics
167
+ - #274 - Rename controllers to consumers
168
+ - #184 - Seek to
169
+ - #284 - Dynamic Params parent class
170
+ - #275 - ssl_ca_certs_from_system
171
+ - #296 - Instrument forceful exit with an error
172
+ - Replaced some of the activesupport parts with dry-inflector
173
+ - Lower ActiveSupport dependency
174
+ - Remove configurators in favor of the after_init block configurator
175
+ - Ruby 2.5.0 support
176
+ - Renamed Karafka::Connection::Processor to Karafka::Connection::Delegator to match incoming naming conventions
177
+ - Renamed Karafka::Connection::Consumer to Karafka::Connection::Client due to #274
178
+ - Removed HashWithIndifferentAccess in favor of a regular hash
179
+ - JSON parsing defaults now to string keys
180
+ - Lower memory usage due to less params data internal details
181
+ - Support multiple ```after_init``` blocks in favor of a single one
182
+ - Renamed ```received_at``` to ```receive_time``` to follow ruby-kafka and WaterDrop conventions
183
+ - Adjust internal setup to easier map Ruby-Kafka config changes
184
+ - System callbacks reorganization
185
+ - Added ```before_fetch_loop``` configuration block for early client usage (```#seek```, etc)
186
+ - Renamed ```after_fetched``` to ```after_fetch``` to normalize the naming convention
187
+ - Instrumentation on a connection delegator level
188
+ - Added ```params_batch#last``` method to retrieve last element after unparsing
189
+ - All params keys are now strings
190
+
191
+ ## 1.1.2
192
+ - #256 - Default kafka.seed_brokers configuration is created in invalid format
193
+
194
+ ## 1.1.1
195
+ - #253 - Allow providing a global per app parser in config settings
196
+
197
+ ## 1.1.0
198
+ - Gem bump
199
+ - Switch from Celluloid to native Thread management
200
+ - Improved shutdown process
201
+ - Introduced optional fetch callbacks and moved current the ```after_received``` there as well
202
+ - Karafka will raise Errors::InvalidPauseTimeout exception when trying to pause but timeout set to 0
203
+ - Allow float for timeouts and other time based second settings
204
+ - Renamed MessagesProcessor to Processor and MessagesConsumer to Consumer - we don't process and don't consumer anything else so it was pointless to keep this "namespace"
205
+ - #232 - Remove unused ActiveSupport require
206
+ - #214 - Expose consumer on a controller layer
207
+ - #193 - Process shutdown callbacks
208
+ - Fixed accessibility of ```#params_batch``` from the outside of the controller
209
+ - connection_pool config options are no longer required
210
+ - celluloid config options are no longer required
211
+ - ```#perform``` is now renamed to ```#consume``` with warning level on using the old one (deprecated)
212
+ - #235 - Rename perform to consume
213
+ - Upgrade to ruby-kafka 0.5
214
+ - Due to redesign of Waterdrop concurrency setting is no longer needed
215
+ - #236 - Manual offset management
216
+ - WaterDrop 1.0.0 support with async
217
+ - Renamed ```batch_consuming``` option to ```batch_fetching``` as it is not a consumption (with processing) but a process of fetching messages from Kafka. The messages is considered consumed, when it is processed.
218
+ - Renamed ```batch_processing``` to ```batch_consuming``` to resemble Kafka concept of consuming messages.
219
+ - Renamed ```after_received``` to ```after_fetched``` to normalize the naming conventions.
220
+ - Responders support the per topic ```async``` option.
221
+
222
+ ## 1.0.1
223
+ - #210 - LoadError: cannot load such file -- [...]/karafka.rb
224
+ - Ruby 2.4.2 as a default (+travis integration)
225
+ - JRuby upgrade
226
+ - Expanded persistence layer (moved to a namespace for easier future development)
227
+ - #213 - Misleading error when non-existing dependency is required
228
+ - #212 - Make params react to #topic, #partition, #offset
229
+ - #215 - Consumer group route dynamic options are ignored
230
+ - #217 - check RUBY_ENGINE constant if RUBY_VERSION is missing (#217)
231
+ - #218 - add configuration setting to control Celluloid's shutdown timeout
232
+ - Renamed Karafka::Routing::Mapper to Karafka::Routing::TopicMapper to match naming conventions
233
+ - #219 - Allow explicit consumer group names, without prefixes
234
+ - Fix to early removed pid upon shutdown of demonized process
235
+ - max_wait_time updated to match https://github.com/zendesk/ruby-kafka/issues/433
236
+ - #230 - Better uri validation for seed brokers (incompatibility as the kafka:// or kafka+ssl:// is required)
237
+ - Small internal docs fixes
238
+ - Dry::Validation::MissingMessageError: message for broker_schema? was not found
239
+ - #238 - warning: already initialized constant Karafka::Schemas::URI_SCHEMES
240
+
241
+ ## 1.0.0
242
+
243
+ ### Closed issues:
244
+
245
+ - #103 - Env for logger is loaded 2 early (on gem load not on app init)
246
+ - #142 - Possibility to better control Kafka consumers (consumer groups management)
247
+ - #150 - Add support for start_from_beginning on a per topic basis
248
+ - #154 - Support for min_bytes and max_wait_time on messages consuming
249
+ - #160 - Reorganize settings to better resemble ruby-kafka requirements
250
+ - #164 - If we decide to have configuration per topic, topic uniqueness should be removed
251
+ - #165 - Router validator
252
+ - #166 - Params and route reorganization (new API)
253
+ - #167 - Remove Sidekiq UI from Karafka
254
+ - #168 - Introduce unique IDs of routes
255
+ - #171 - Add kafka message metadata to params
256
+ - #176 - Transform Karafka::Connection::Consumer into a module
257
+ - #177 - Monitor not reacting when kafka killed with -9
258
+ - #175 - Allow single consumer to subscribe to multiple topics
259
+ - #178 - Remove parsing failover when cannot unparse data
260
+ - #174 - Extended config validation
261
+ - ~~#180 - Switch from JSON parser to yajl-ruby~~
262
+ - #181 - When responder is defined and not used due to ```respond_with``` not being triggered in the perform, it won't raise an exception.
263
+ - #188 - Rename name in config to client id
264
+ - #186 - Support ruby-kafka ```ssl_ca_cert_file_path``` config
265
+ - #189 - karafka console does not preserve history on exit
266
+ - #191 - Karafka 0.6.0rc1 does not work with jruby / now it does :-)
267
+ - Switch to multi json so everyone can use their favourite JSON parser
268
+ - Added jruby support in general and in Travis
269
+ - #196 - Topic mapper does not map topics when subscribing thanks to @webandtech
270
+ - #96 - Karafka server - possibility to run it only for a certain topics
271
+ - ~~karafka worker cli option is removed (please use sidekiq directly)~~ - restored, bad idea
272
+ - (optional) pausing upon processing failures ```pause_timeout```
273
+ - Karafka console main process no longer intercepts irb errors
274
+ - Wiki updates
275
+ - #204 - Long running controllers
276
+ - Better internal API to handle multiple usage cases using ```Karafka::Controllers::Includer```
277
+ - #207 - Rename before_enqueued to after_received
278
+ - #147 - De-attach Karafka from Sidekiq by extracting Sidekiq backend
279
+
280
+ ### New features and improvements
281
+
282
+ - batch processing thanks to ```#batch_consuming``` flag and ```#params_batch``` on controllers
283
+ - ```#topic``` method on an controller instance to make a clear distinction in between params and route details
284
+ - Changed routing model (still compatible with 0.5) to allow better resources management
285
+ - Lower memory requirements due to object creation limitation (2-3 times less objects on each new message)
286
+ - Introduced the ```#batch_consuming``` config flag (config for #126) that can be set per each consumer_group
287
+ - Added support for partition, offset and partition key in the params hash
288
+ - ```name``` option in config renamed to ```client_id```
289
+ - Long running controllers with ```persistent``` flag on a topic config level, to make controller instances persistent between messages batches (single controller instance per topic per partition no per messages batch) - turned on by default
290
+
291
+ ### Incompatibilities
292
+
293
+ - Default boot file is renamed from app.rb to karafka.rb
294
+ - Removed worker glass as dependency (now and independent gem)
295
+ - ```kafka.hosts``` option renamed to ```kafka.seed_brokers``` - you don't need to provide all the hosts to work with Kafka
296
+ - ```start_from_beginning``` moved into kafka scope (```kafka.start_from_beginning```)
297
+ - Router no longer checks for route uniqueness - now you can define same routes for multiple kafkas and do a lot of crazy stuff, so it's your responsibility to check uniqueness
298
+ - Change in the way we identify topics in between Karafka and Sidekiq workers. If you upgrade, please make sure, all the jobs scheduled in Sidekiq are finished before the upgrade.
299
+ - ```batch_mode``` renamed to ```batch_fetching```
300
+ - Renamed content to value to better resemble ruby-kafka internal messages naming convention
301
+ - When having a responder with ```required``` topics and not using ```#respond_with``` at all, it will raise an exception
302
+ - Renamed ```inline_mode``` to ```inline_processing``` to resemble other settings conventions
303
+ - Renamed ```inline_processing``` to ```backend``` to reach 1.0 future compatibility
304
+ - Single controller **needs** to be used for a single topic consumption
305
+ - Renamed ```before_enqueue``` to ```after_received``` to better resemble internal logic, since for inline backend, there is no enqueue.
306
+ - Due to the level on which topic and controller are related (class level), the dynamic worker selection is no longer available.
307
+ - Renamed params #retrieve to params #retrieve! to better reflect what it does
308
+
309
+ ### Other changes
310
+ - PolishGeeksDevTools removed (in favour of Coditsu)
311
+ - Waaaaaay better code quality thanks to switching from dev tools to Coditsu
312
+ - Gem bump
313
+ - Cleaner internal API
314
+ - SRP
315
+ - Better settings proxying and management between ruby-kafka and karafka
316
+ - All internal validations are now powered by dry-validation
317
+ - Better naming conventions to reflect Kafka reality
318
+ - Removed Karafka::Connection::Message in favour of direct message details extraction from Kafka::FetchedMessage
319
+
320
+ ## 0.5.0.3
321
+ - #132 - When Kafka is gone, should reconnect after a time period
322
+ - #136 - new ruby-kafka version + other gem bumps
323
+ - ruby-kafka update
324
+ - #135 - NonMatchingRouteError - better error description in the code
325
+ - #140 - Move Capistrano Karafka to a different specific gem
326
+ - #110 - Add call method on a responder class to alias instance build and call
327
+ - #76 - Configs validator
328
+ - #138 - Possibility to have no worker class defined if inline_mode is being used
329
+ - #145 - Topic Mapper
330
+ - Ruby update to 2.4.1
331
+ - Gem bump x2
332
+ - #158 - Update docs section on heroku usage
333
+ - #150 - Add support for start_from_beginning on a per topic basis
334
+ - #148 - Lower Karafka Sidekiq dependency
335
+ - Allow karafka root to be specified from ENV
336
+ - Handle SIGTERM as a shutdown command for kafka server to support Heroku deployment
337
+
338
+ ## 0.5.0.2
339
+ - Gems update x3
340
+ - Default Ruby set to 2.3.3
341
+ - ~~Default Ruby set to 2.4.0~~
342
+ - Readme updates to match bug fixes and resolved issues
343
+ - #95 - Allow options into responder
344
+ - #98 - Use parser when responding on a topic
345
+ - #114 - Option to configure waterdrop connection pool timeout and concurrency
346
+ - #118 - Added dot in topic validation format
347
+ - #119 - add support for authentication using SSL
348
+ - #121 - JSON as a default for standalone responders usage
349
+ - #122 - Allow on capistrano role customization
350
+ - #125 - Add support to batch incoming messages
351
+ - #130 - start_from_beginning flag on routes and default
352
+ - #128 - Monitor caller_label not working with super on inheritance
353
+ - Renamed *inline* to *inline_mode* to stay consistent with flags that change the way karafka works (#125)
354
+ - Dry-configurable bump to 0.5 with fixed proc value evaluation on retrieve patch (internal change)
355
+
356
+ ## 0.5.0.1
357
+ - Fixed inconsistency in responders non-required topic definition. Now only required: false available
358
+ - #101 - Responders fail when multiple_usage true and required false
359
+ - fix error on startup from waterdrop #102
360
+ - Waterdrop 0.3.2.1 with kafka.hosts instead of kafka_hosts
361
+ - #105 - Karafka::Monitor#caller_label not working with inherited monitors
362
+ - #99 - Standalone mode (without Sidekiq)
363
+ - #97 - Buffer responders single topics before send (pre-validation)
364
+ - Better control over consumer thanks to additional config options
365
+ - #111 - Dynamic worker assignment based on the income params
366
+ - Long shutdown time fix
367
+
368
+ ## 0.5.0
369
+ - Removed Zookeeper totally as dependency
370
+ - Better group and partition rebalancing
371
+ - Automatic thread management (no need for tuning) - each topic is a separate actor/thread
372
+ - Moved from Poseidon into Ruby-Kafka
373
+ - No more max_concurrency setting
374
+ - After you define your App class and routes (and everything else) you need to add execute App.boot!
375
+ - Manual consuming is no longer available (no more karafka consume command)
376
+ - Karafka topics CLI is no longer available. No Zookeeper - no global topic discovery
377
+ - Dropped ZK as dependency
378
+ - karafka info command no longer prints details about Zookeeper
379
+ - Better shutdown
380
+ - No more autodiscovery via Zookeeper - instead, the whole cluster will be discovered directly from Kafka
381
+ - No more support for Kafka 0.8
382
+ - Support for Kafka 0.9
383
+ - No more need for ActorCluster, since now we have a single thread (and Kafka connection) per topic
384
+ - Ruby 2.2.* support dropped
385
+ - Using App name as a Kafka client_id
386
+ - Automatic Capistrano integration
387
+ - Responders support for handling better responses pipe-lining and better responses flow description and design (see README for more details)
388
+ - Gem bump
389
+ - Readme updates
390
+ - karafka flow CLI command for printing the application flow
391
+ - Some internal refactoring
392
+
393
+ ## 0.4.2
394
+ - #87 - Re-consume mode with crone for better Rails/Rack integration
395
+ - Moved Karafka server related stuff into separate Karafka::Server class
396
+ - Renamed Karafka::Runner into Karafka::Fetcher
397
+ - Gem bump
398
+ - Added chroot option to Zookeeper options
399
+ - Moved BROKERS_PATH into config from constant
400
+ - Added Karafka consume CLI action for a short running single consumption round
401
+ - Small fixes to close broken connections
402
+ - Readme updates
403
+
404
+ ## 0.4.1
405
+ - Explicit throw(:abort) required to halt before_enqueue (like in Rails 5)
406
+ - #61 - autodiscovery of Kafka brokers based on Zookeeper data
407
+ - #63 - Graceful shutdown with current offset state during data processing
408
+ - #65 - Example of NewRelic monitor is outdated
409
+ - #71 - Setup should be executed after user code is loaded
410
+ - Gem bump x3
411
+ - Rubocop remarks
412
+ - worker_timeout config option has been removed. It now needs to be defined manually by the framework user because WorkerGlass::Timeout can be disabled and we cannot use Karafka settings on a class level to initialize user code stuff
413
+ - Moved setup logic under setup/Setup namespace
414
+ - Better defaults handling
415
+ - #75 - Kafka and Zookeeper options as a hash
416
+ - #82 - Karafka autodiscovery fails upon caching of configs
417
+ - #81 - Switch config management to dry configurable
418
+ - Version fix
419
+ - Dropped support for Ruby 2.1.*
420
+ - Ruby bump to 2.3.1
421
+
422
+ ## 0.4.0
423
+ - Added WaterDrop gem with default configuration
424
+ - Refactoring of config logic to simplify adding new dependencies that need to be configured based on #setup data
425
+ - Gem bump
426
+ - Readme updates
427
+ - Renamed cluster to actor_cluster for method names
428
+ - Replaced SidekiqGlass with generic WorkerGlass lib
429
+ - Application bootstrap in app.rb no longer required
430
+ - Karafka.boot needs to be executed after all the application files are loaded (template updated)
431
+ - Small loader refactor (no API changes)
432
+ - Ruby 2.3.0 support (default)
433
+ - No more rake tasks
434
+ - Karafka CLI instead of rake tasks
435
+ - Worker cli command allows passing additional options directly to Sidekiq
436
+ - Renamed concurrency to max_concurrency - it describes better what happens - Karafka will use this number of threads only when required
437
+ - Added wait_timeout that allows us to tune how long should we wait on a single socket connection (single topic) for new messages before going to next one (this applies to each thread separately)
438
+ - Rubocop remarks
439
+ - Removed Sinatra and Puma dependencies
440
+ - Karafka Cli internal reorganization
441
+ - Karafka Cli routes task
442
+ - #37 - warn log for failed parsing of a message
443
+ - #43 - wrong constant name
444
+ - #44 - Method name conflict
445
+ - #48 - Cannot load such file -- celluloid/current
446
+ - #46 - Loading application
447
+ - #45 - Set up monitor in config
448
+ - #47 - rake karafka:run uses app.rb only
449
+ - #53 - README update with Sinatra/Rails integration description
450
+ - #41 - New Routing engine
451
+ - #54 - Move Karafka::Workers::BaseWorker to Karafka::BaseWorker
452
+ - #55 - ApplicationController and ApplicationWorker
453
+
454
+ ## 0.3.2
455
+ - Karafka::Params::Params lazy load merge keys with string/symbol names priorities fix
456
+
457
+ ## 0.3.1
458
+ - Renamed Karafka::Monitor to Karafka::Process to represent a Karafka process wrapper
459
+ - Added Karafka::Monitoring that allows to add custom logging and monitoring with external libraries and systems
460
+ - Moved logging functionality into Karafka::Monitoring default monitoring
461
+ - Added possibility to provide own monitoring as long as in responds to #notice and #notice_error
462
+ - Standardized logging format for all logs
463
+
464
+ ## 0.3.0
465
+ - Switched from custom ParserError for each parser to general catching of Karafka::Errors::ParseError and its descendants
466
+ - Gem bump
467
+ - Fixed #32 - now when using custom workers that does not inherit from Karafka::BaseWorker perform method is not required. Using custom workers means that the logic that would normally lie under #perform, needs to be executed directly from the worker.
468
+ - Fixed #31 - Technically didn't fix because this is how Sidekiq is meant to work, but provided possibility to assign custom interchangers that allow to bypass JSON encoding issues by converting data that goes to Redis to a required format (and parsing it back when it is fetched)
469
+ - Added full parameters lazy load - content is no longer loaded during #perform_async if params are not used in before_enqueue
470
+ - No more namespaces for Redis by default (use separate DBs)
471
+
472
+ ## 0.1.21
473
+ - Sidekiq 4.0.1 bump
474
+ - Gem bump
475
+ - Added direct celluloid requirement to Karafka (removed from Sidekiq)
476
+
477
+ ## 0.1.19
478
+ - Internal call - schedule naming change
479
+ - Enqueue to perform_async naming in controller to follow Sidekiq naming convention
480
+ - Gem bump
481
+
482
+ ## 0.1.18
483
+ - Changed Redis configuration options into a single hash that is directly passed to Redis setup for Sidekiq
484
+ - Added config.ru to provide a Sidekiq web UI (see README for more details)
485
+
486
+ ## 0.1.17
487
+ - Changed Karafka::Connection::Cluster tp Karafka::Connection::ActorCluster to distinguish between a single thread actor cluster for multiple topic connection and a future feature that will allow process clusterization.
488
+ - Add an ability to use user-defined parsers for a messages
489
+ - Lazy load params for before callbacks
490
+ - Automatic loading/initializing all workers classes during startup (so Sidekiq won't fail with unknown workers exception)
491
+ - Params are now private to controller
492
+ - Added bootstrap method to app.rb
493
+
494
+ ## 0.1.16
495
+ - Cluster level error catching for all exceptions so actor is not killer
496
+ - Cluster level error logging
497
+ - Listener refactoring (QueueConsumer extracted)
498
+ - Karafka::Connection::QueueConsumer to wrap around fetching logic - technically we could replace Kafka with any other messaging engine as long as we preserve the same API
499
+ - Added debug env for debugging purpose in applications
500
+
501
+ ## 0.1.15
502
+ - Fixed max_wait_ms vs socket_timeout_ms issue
503
+ - Fixed closing queue connection after Poseidon::Errors::ProtocolError failure
504
+ - Fixed wrong logging file selection based on env
505
+ - Extracted Karafka::Connection::QueueConsumer object to wrap around queue connection
506
+
507
+ ## 0.1.14
508
+ - Rake tasks for listing all the topics on Kafka server (rake kafka:topics)
509
+
510
+ ## 0.1.13
511
+ - Ability to assign custom workers and use them bypassing Karafka::BaseWorker (or its descendants)
512
+ - Gem bump
513
+
514
+ ## 0.1.12
515
+ - All internal errors went to Karafka::Errors namespace
516
+
517
+ ## 0.1.11
518
+ - Rescuing all the "before Sidekiq" processing so errors won't affect other incoming messages
519
+ - Fixed dying actors after connection error
520
+ - Added a new app status - "initializing"
521
+ - Karafka::Status model cleanup
522
+
523
+ ## 0.1.10
524
+ - Added possibility to specify redis namespace in configuration (failover to app name)
525
+ - Renamed redis_host to redis_url in configuration
526
+
527
+ ## 0.1.9
528
+ - Added worker logger
529
+
530
+ ## 0.1.8
531
+ - Dropped local env support in favour of [Envlogic](https://github.com/karafka/envlogic) - no changes in API
532
+
533
+ ## 0.1.7
534
+ - Karafka option for Redis hosts (not localhost only)
535
+
536
+ ## 0.1.6
537
+ - Added better concurency by clusterization of listeners
538
+ - Added graceful shutdown
539
+ - Added concurency that allows to handle bigger applications with celluloid
540
+ - Karafka controllers no longer require group to be defined (created based on the topic and app name)
541
+ - Karafka controllers no longer require topic to be defined (created based on the controller name)
542
+ - Readme updates
543
+
544
+ ## 0.1.5
545
+ - Celluloid support for listeners
546
+ - Multi target logging (STDOUT and file)
547
+
548
+ ## 0.1.4
549
+ - Renamed events to messages to follow Apache Kafka naming convention
550
+
551
+ ## 0.1.3
552
+ - Karafka::App.logger moved to Karafka.logger
553
+ - README updates (Usage section was added)
554
+
555
+ ## 0.1.2
556
+ - Logging to log/environment.log
557
+ - Karafka::Runner
558
+
559
+ ## 0.1.1
560
+ - README updates
561
+ - Rake tasks updates
562
+ - Rake installation task
563
+ - Changelog file added
564
+
565
+ ## 0.1.0
566
+ - Initial framework code