├── .gitignore ├── .hgignore ├── .travis.yml ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── LICENSE-MPL-RabbitMQ ├── LICENSE-MPL2 ├── Makefile ├── README.extra.md ├── README.md ├── docs └── sharded_queues.png ├── erlang.mk ├── etc ├── rabbit-hare.config ├── rabbit-test.config └── rkey.sh ├── rabbitmq-components.mk ├── src ├── rabbit_sharding_exchange_decorator.erl ├── rabbit_sharding_exchange_type_modulus_hash.erl ├── rabbit_sharding_interceptor.erl ├── rabbit_sharding_policy_validator.erl ├── rabbit_sharding_shard.erl └── rabbit_sharding_util.erl └── test └── src ├── rabbit_hash_exchange_SUITE.erl └── rabbit_sharding_SUITE.erl /.gitignore: -------------------------------------------------------------------------------- 1 | .sw? 2 | .*.sw? 3 | *.beam 4 | /.erlang.mk/ 5 | /cover/ 6 | /deps/ 7 | /doc/ 8 | /ebin/ 9 | /escript/ 10 | /escript.lock 11 | /logs/ 12 | /plugins/ 13 | /plugins.lock 14 | /sbin/ 15 | /sbin.lock 16 | /xrefr 17 | 18 | /rabbitmq_sharding.d 19 | -------------------------------------------------------------------------------- /.hgignore: -------------------------------------------------------------------------------- 1 | ~$ 2 | \.beam$ 3 | ^build/ 4 | ^dist/ 5 | ^cover/ 6 | ^erl_crash.dump$ 7 | ^ebin/rabbitmq_sharding\.app$ 8 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | # vim:sw=2:et: 2 | 3 | os: linux 4 | dist: xenial 5 | language: elixir 6 | notifications: 7 | email: 8 | recipients: 9 | - alerts@rabbitmq.com 10 | on_success: never 11 | on_failure: always 12 | addons: 13 | apt: 14 | packages: 15 | - awscli 16 | cache: 17 | apt: true 18 | env: 19 | global: 20 | - secure: uA/bYdGfaL4VabgEv2qXHvr+7Uel70wACE7OoJrVTk8s6w543xWKNGgCt4dsOdwVwuo/rbDNXkZ1xMN86HYx7EJS6IxX6C5xG4BLEI2rxAsryxdrALSzjsocbxN71CwZsHO/lpwDKe/wOci0CxhLbFsc0NJEEOTEGONwF+IziKs= 21 | - secure: LX/VG+uGA02GpKCB3m+uqGrr7EKVAYBBxi/K3IPYY3EbJIzKRe+zlSZO46MOjgD9NTLqFPR8oM7toGFOmarWT1YJI/pDutErJlwInTxJ4R1vij/E2z1Dl8CSzKlbK/O7qjIB+MObdz+auPVczrW7oaHHKPRPNV/ZZ0n70TuIqAY= 22 | 23 | # $base_rmq_ref is used by rabbitmq-components.mk to select the 24 | # appropriate branch for dependencies. 25 | - base_rmq_ref=master 26 | 27 | elixir: 28 | - '1.9' 29 | otp_release: 30 | - '21.3' 31 | - '22.2' 32 | 33 | install: 34 | # This project being an Erlang one (we just set language to Elixir 35 | # to ensure it is installed), we don't want Travis to run mix(1) 36 | # automatically as it will break. 37 | skip 38 | 39 | script: 40 | # $current_rmq_ref is also used by rabbitmq-components.mk to select 41 | # the appropriate branch for dependencies. 42 | - make check-rabbitmq-components.mk 43 | current_rmq_ref="${TRAVIS_PULL_REQUEST_BRANCH:-${TRAVIS_BRANCH}}" 44 | - make xref 45 | current_rmq_ref="${TRAVIS_PULL_REQUEST_BRANCH:-${TRAVIS_BRANCH}}" 46 | - make tests 47 | current_rmq_ref="${TRAVIS_PULL_REQUEST_BRANCH:-${TRAVIS_BRANCH}}" 48 | 49 | after_failure: 50 | - | 51 | cd "$TRAVIS_BUILD_DIR" 52 | if test -d logs && test "$AWS_ACCESS_KEY_ID" && test "$AWS_SECRET_ACCESS_KEY"; then 53 | archive_name="$(basename "$TRAVIS_REPO_SLUG")-$TRAVIS_JOB_NUMBER" 54 | 55 | tar -c --transform "s/^logs/${archive_name}/" -f - logs | \ 56 | xz > "${archive_name}.tar.xz" 57 | 58 | aws s3 cp "${archive_name}.tar.xz" s3://server-release-pipeline/travis-ci-logs/ \ 59 | --region eu-west-1 \ 60 | --acl public-read 61 | fi 62 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Code of Conduct 2 | 3 | As contributors and maintainers of this project, and in the interest of fostering an open 4 | and welcoming community, we pledge to respect all people who contribute through reporting 5 | issues, posting feature requests, updating documentation, submitting pull requests or 6 | patches, and other activities. 7 | 8 | We are committed to making participation in this project a harassment-free experience for 9 | everyone, regardless of level of experience, gender, gender identity and expression, 10 | sexual orientation, disability, personal appearance, body size, race, ethnicity, age, 11 | religion, or nationality. 12 | 13 | Examples of unacceptable behavior by participants include: 14 | 15 | * The use of sexualized language or imagery 16 | * Personal attacks 17 | * Trolling or insulting/derogatory comments 18 | * Public or private harassment 19 | * Publishing other's private information, such as physical or electronic addresses, 20 | without explicit permission 21 | * Other unethical or unprofessional conduct 22 | 23 | Project maintainers have the right and responsibility to remove, edit, or reject comments, 24 | commits, code, wiki edits, issues, and other contributions that are not aligned to this 25 | Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors 26 | that they deem inappropriate, threatening, offensive, or harmful. 27 | 28 | By adopting this Code of Conduct, project maintainers commit themselves to fairly and 29 | consistently applying these principles to every aspect of managing this project. Project 30 | maintainers who do not follow or enforce the Code of Conduct may be permanently removed 31 | from the project team. 32 | 33 | This Code of Conduct applies both within project spaces and in public spaces when an 34 | individual is representing the project or its community. 35 | 36 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by 37 | contacting a project maintainer at [info@rabbitmq.com](mailto:info@rabbitmq.com). All complaints will 38 | be reviewed and investigated and will result in a response that is deemed necessary and 39 | appropriate to the circumstances. Maintainers are obligated to maintain confidentiality 40 | with regard to the reporter of an incident. 41 | 42 | This Code of Conduct is adapted from the 43 | [Contributor Covenant](https://contributor-covenant.org), version 1.3.0, available at 44 | [contributor-covenant.org/version/1/3/0/](https://contributor-covenant.org/version/1/3/0/) 45 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | ## Overview 2 | 3 | RabbitMQ projects use pull requests to discuss, collaborate on and accept code contributions. 4 | Pull requests is the primary place of discussing code changes. 5 | 6 | ## How to Contribute 7 | 8 | The process is fairly standard: 9 | 10 | * Fork the repository or repositories you plan on contributing to 11 | * Clone [RabbitMQ umbrella repository](https://github.com/rabbitmq/rabbitmq-public-umbrella) 12 | * `cd umbrella`, `make co` 13 | * Create a branch with a descriptive name in the relevant repositories 14 | * Make your changes, run tests, commit with a [descriptive message](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html), push to your fork 15 | * Submit pull requests with an explanation what has been changed and **why** 16 | * Submit a filled out and signed [Contributor Agreement](https://github.com/rabbitmq/ca#how-to-submit) if needed (see below) 17 | * Be patient. We will get to your pull request eventually 18 | 19 | If what you are going to work on is a substantial change, please first ask the core team 20 | of their opinion on [RabbitMQ mailing list](https://groups.google.com/forum/#!forum/rabbitmq-users). 21 | 22 | 23 | ## Code of Conduct 24 | 25 | See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md). 26 | 27 | 28 | ## Contributor Agreement 29 | 30 | If you want to contribute a non-trivial change, please submit a signed copy of our 31 | [Contributor Agreement](https://github.com/rabbitmq/ca#how-to-submit) around the time 32 | you submit your pull request. This will make it much easier (in some cases, possible) 33 | for the RabbitMQ team at Pivotal to merge your contribution. 34 | 35 | 36 | ## Where to Ask Questions 37 | 38 | If something isn't clear, feel free to ask on our [mailing list](https://groups.google.com/forum/#!forum/rabbitmq-users). 39 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | This package is licensed under the MPL 2.0. For the MPL 2.0, please see LICENSE-MPL-RabbitMQ. 2 | 3 | If you have any questions regarding licensing, please contact us at 4 | info@rabbitmq.com. 5 | -------------------------------------------------------------------------------- /LICENSE-MPL-RabbitMQ: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /LICENSE-MPL2: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at https://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | PROJECT = rabbitmq_sharding 2 | PROJECT_DESCRIPTION = RabbitMQ Sharding Plugin 3 | 4 | define PROJECT_APP_EXTRA_KEYS 5 | {broker_version_requirements, []} 6 | endef 7 | 8 | DEPS = rabbit_common rabbit 9 | TEST_DEPS = rabbitmq_ct_helpers rabbitmq_ct_client_helpers amqp_client 10 | 11 | DEP_EARLY_PLUGINS = rabbit_common/mk/rabbitmq-early-plugin.mk 12 | DEP_PLUGINS = rabbit_common/mk/rabbitmq-plugin.mk 13 | 14 | # FIXME: Use erlang.mk patched for RabbitMQ, while waiting for PRs to be 15 | # reviewed and merged. 16 | 17 | ERLANG_MK_REPO = https://github.com/rabbitmq/erlang.mk.git 18 | ERLANG_MK_COMMIT = rabbitmq-tmp 19 | 20 | include rabbitmq-components.mk 21 | include erlang.mk 22 | -------------------------------------------------------------------------------- /README.extra.md: -------------------------------------------------------------------------------- 1 | # Additional information # 2 | 3 | Here you can find some extra information about how the plugin works 4 | and the reasons for it. 5 | 6 | ## Why do we need this plugin? ## 7 | 8 | RabbitMQ queues are bound to the node where they were first 9 | declared. This means that even if you create a cluster of RabbitMQ 10 | brokers, at some point all message traffic will go to the node where 11 | the queue lives. What this plugin does is to give you a centralized 12 | place where to send your messages, plus __load balancing__ across many 13 | nodes, by adding queues to the other nodes in the cluster. 14 | 15 | The advantage of this setup is that the queues from where your 16 | consumers will get messages will be local to the node where they are 17 | connected. On the other hand, the producers don't need to care about 18 | what's behind the exchange. 19 | 20 | All the plumbing to __automatically maintain__ the shard queues is 21 | done by the plugin. If you add more nodes to the cluster, then the 22 | plugin will __automatically create queues in those nodes__. 23 | 24 | If you remove nodes from the cluster then RabbitMQ will take care of 25 | taking them out of the list of bound queues. Message loss can happen 26 | in the case where a race occurs from a node going away and your 27 | message arriving to the shard exchange. If you can't afford to lose a 28 | message then you can use 29 | [publisher confirms](https://www.rabbitmq.com/confirms.html) to prevent 30 | message loss. 31 | 32 | ## Message Ordering ## 33 | 34 | Message order is maintained per sharded queue, but not globally. This 35 | means that once a message entered a queue, then for that queue and the 36 | set of consumers attached to the queue, ordering will be preserved. 37 | 38 | If you need global ordering then stick with 39 | [mirrored queues](https://www.rabbitmq.com/ha.html). 40 | 41 | ## What strategy is used for picking the queue name ## 42 | 43 | When you issue a `basic.consume`, the plugin will choose the queue 44 | with the _least amount of consumers_. The queue will be local to the 45 | broker your client is connected to. Of course the local sharded queue 46 | will be part of the set of queues that belong to the chosen shard. 47 | 48 | ## Intercepted Channel Behaviour ## 49 | 50 | This plugin works with the new `channel interceptors`. An interceptor 51 | basically allows a plugin to modify parts of an AMQP method. For 52 | example in this plugin case, whenever a user sends a `basic.consume`, 53 | the plugin will map the queue name sent by the user to one of the 54 | sharded queues. 55 | 56 | Also a plugin can decide that a certain AMQP method can't be performed 57 | on a queue that's managed by the plugin. In this case declaring a queue 58 | called `my_shard` doesn't make much sense when there's actually a 59 | sharded queue by that name. In this case the plugin will return a 60 | channel error to the user. 61 | 62 | These are the AMQP methods intercepted by the plugin, and the 63 | respective behaviour: 64 | 65 | - `'basic.consume', QueueName`: The plugin will pick the sharded queue 66 | with the least amount of consumers from the `QueueName` shard. 67 | - `'basic.get', QueueName`: The plugin will pick the sharded queue 68 | with the least amount of consumers from the `QueueName` shard. 69 | - `'queue.declare', QueueName`: The plugin rewrites `QueueName` to be 70 | the first queue in the shard, so `queue.declare_ok` returns the stats 71 | for that queue. 72 | - `'queue.bind', QueueName`: since there isn't an actual `QueueName` 73 | queue, this method returns a channel error. 74 | - `'queue.unbind', QueueName`: since there isn't an actual `QueueName` 75 | queue, this method returns a channel error. 76 | - `'queue.purge', QueueName`: since there isn't an actual `QueueName` 77 | queue, this method returns a channel error. 78 | - `'queue.delete', QueueName`: since there isn't an actual `QueueName` 79 | queue, this method returns a channel error. 80 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # RabbitMQ Sharding Plugin 2 | 3 | 4 | ## This was migrated to https://github.com/rabbitmq/rabbitmq-server 5 | 6 | This repository has been moved to the main unified RabbitMQ "monorepo", including all open issues. You can find the source under [/deps/rabbitmq_sharding](https://github.com/rabbitmq/rabbitmq-server/tree/master/deps/rabbitmq_sharding). 7 | All issues have been transferred. 8 | 9 | ## Overview 10 | 11 | This plugin introduces the concept of sharded queues for 12 | RabbitMQ. Sharding is performed by exchanges, that is, messages 13 | will be partitioned across "shard" queues by one exchange that we should 14 | define as sharded. The machinery used behind the scenes implies 15 | defining an exchange that will partition, or shard messages across 16 | queues. The partitioning will be done automatically for you, i.e: once 17 | you define an exchange as _sharded_, then the supporting queues will 18 | be automatically created on every cluster node and messages will be sharded across them. 19 | 20 | ## Project Maturity 21 | 22 | This plugin is reasonably mature and known to have production users. 23 | 24 | ## Overview 25 | 26 | The following graphic depicts how the plugin works from the standpoint 27 | of a publisher and a consumer: 28 | 29 | ![Sharding Overview](https://raw.githubusercontent.com/rabbitmq/rabbitmq-sharding/master/docs/sharded_queues.png) 30 | 31 | On the picture above the producers publishes a series of 32 | messages, those messages get partitioned to different queues, and then 33 | our consumer get messages from one of those queues. Therefore if there is 34 | a partition with 3 queues, it is assumed that there are at least 3 35 | consumers to get all the messages from those queues. 36 | 37 | Queues in RabbitMQ are [units of concurrency](https://www.rabbitmq.com/queues.html#runtime-characteristics) 38 | (and, if there are enough cores available, parallelism). This plugin makes 39 | it possible to have a single logical queue that is partitioned into 40 | multiple regular queues ("shards"). This trades off total ordering 41 | on the logical queue for gains in parallelism. 42 | 43 | Message distribution between shards (partitioning) is achieved 44 | with a custom exchange type that distributes messages by applying 45 | a hashing function to the routing key. 46 | 47 | 48 | ## Messages Distribution Between Shards (Partitioning) 49 | 50 | The exchanges that ship by default with RabbitMQ work in an "all or 51 | nothing" fashion, i.e: if a routing key matches a set of queues bound 52 | to the exchange, then RabbitMQ will route the message to all the 53 | queues in that set. For this plugin to work it is necessary to 54 | route messages to an exchange that would partition messages, so they 55 | are routed to _at most_ one queue (a subset). 56 | 57 | The plugin provides a new exchange type, `"x-modulus-hash"`, that will use 58 | a hashing function to partition messages routed to a logical queue 59 | across a number of regular queues (shards). 60 | 61 | The `"x-modulus-hash"` exchange will hash the routing key used to 62 | publish the message and then it will apply a `Hash mod N` to pick the 63 | queue where to route the message, where N is the number of queues 64 | bound to the exchange. **This exchange will completely ignore the 65 | binding key used to bind the queue to the exchange**. 66 | 67 | There are other exchanges with similar behaviour: 68 | the _Consistent Hash Exchange_ or the _Random Exchange_. 69 | Those were designed with regular queues in mind, not this plugin, so `"x-modulus-hash"` 70 | is highly recommended. 71 | 72 | If message partitioning is the only feature necessary and the automatic scaling 73 | of the number of shards (covered below) is not needed or desired, consider using 74 | [Consistent Hash Exchange](https://github.com/rabbitmq/rabbitmq-consistent-hash-exchange) 75 | instead of this plugin. 76 | 77 | 78 | ## Auto-scaling 79 | 80 | One of the main properties of this plugin is that when a new node 81 | is added to the RabbitMQ cluster, then the plugin will automatically create 82 | more shards on the new node. Say there is a shard with 4 queues on 83 | `node a` and `node b` just joined the cluster. The plugin will 84 | automatically create 4 queues on `node b` and "join" them to the shard 85 | partition. Already delivered messages _will not_ be rebalanced but 86 | newly arriving messages will be partitioned to the new queues. 87 | 88 | 89 | ## Consuming From a Sharded [Pseudo-]Queue ## 90 | 91 | While the plugin creates a bunch of "shard" queues behind the scenes, the idea 92 | is that those queues act like a big logical queue where you consume 93 | messages from it. Total ordering of messages between shards is not defined. 94 | 95 | An example should illustrate this better: let's say you declared the 96 | exchange _images_ to be a sharded exchange. Then RabbitMQ creates 97 | several "shard" queues behind the scenes: 98 | 99 | * _shard: - nodename images 1_ 100 | * _shard: - nodename images 2_ 101 | * _shard: - nodename images 3_ 102 | * _shard: - nodename images 4_. 103 | 104 | To consume from a sharded queue, register a consumer on the `"images"` pseudo-queue 105 | using the `basic.consume` method. RabbitMQ will attach the consumer to a shard 106 | behind the scenes. Note that **consumers must not declare a queue with the same 107 | name as the sharded pseudo-queue prior to consuming**. 108 | 109 | TL;DR: if you have a shard called _images_, then you can directly 110 | consume from a queue called _images_. 111 | 112 | How does it work? The plugin will chose the queue from the shard with 113 | the _least amount of consumers_, provided the queue contents are local 114 | to the broker you are connected to. 115 | 116 | **NOTE: there's a small race condition between RabbitMQ updating the 117 | queue's internal stats about consumers and when clients issue 118 | `basic.consume` commands.** The problem with this is that if your 119 | client issue many `basic.consume` commands without too much time in 120 | between, it might happen that the plugin assigns the consumers to 121 | queues in an uneven way. 122 | 123 | 124 | ## Load Distribution and Consumer Balancing 125 | 126 | As of RabbitMQ 3.8.1, the plugin is no longer affected by the queue master locator policy when using mirrored queues. Please read below if you use a previous version. 127 | 128 | This plugin can be affected by [queue master locator policy used](https://www.rabbitmq.com/ha.html) in 129 | the cluster as well as client connection load balancing strategy. 130 | 131 | "Minimum masters" is a queue master locator that is most in line with the goals of 132 | this plugin. 133 | 134 | For load balancers, the "least connections" strategy is more likely to produce an even distribution compared 135 | to round robin and other strategies. 136 | 137 | ### How Evenly Will Messages Be Distributed? 138 | 139 | As with many data distribution approaches based on a hashing function, 140 | even distribution between shards depends on the distribution (variability) of inputs, 141 | that is, routing keys. In other words the larger the set of routing keys is, 142 | the more even will message distribution between shareds be. If all messages had 143 | the same routing key, they would all end up on the same shard. 144 | 145 | 146 | 147 | ## Installing ## 148 | 149 | ### RabbitMQ 3.6.0 or later 150 | 151 | As of RabbitMQ `3.6.0` this plugin is included into the RabbitMQ distribution. 152 | 153 | Like any other [RabbitMQ plugin](https://www.rabbitmq.com/plugins.html) it has to be enabled before it can be used: 154 | 155 | ```bash 156 | rabbitmq-plugins enable rabbitmq_sharding 157 | ``` 158 | 159 | You'd probably want to also enable the Consistent Hash Exchange 160 | plugin, too. 161 | 162 | ### With Earlier Versions 163 | 164 | Install the corresponding .ez files from our 165 | [Community Plugins archive](https://www.rabbitmq.com/community-plugins/). 166 | 167 | Then run the following command: 168 | 169 | ```bash 170 | rabbitmq-plugins enable rabbitmq_sharding 171 | ``` 172 | 173 | You'd probably want to also enable the Consistent Hash Exchange 174 | plugin, too. 175 | 176 | ## Usage ## 177 | 178 | Once the plugin is installed you can define an exchange as sharded by 179 | setting up a policy that matches the exchange name. For example if we 180 | have the exchange called `shard.images`, we could define the following 181 | policy to shard it: 182 | 183 | ```bash 184 | $CTL set_policy images-shard "^shard.images$" '{"shards-per-node": 2, "routing-key": "1234"}' 185 | ``` 186 | 187 | This will create `2` sharded queues per node in the cluster, and will 188 | bind those queues using the `"1234"` routing key. 189 | 190 | ### About the routing-key policy definition ### 191 | 192 | In the example above we use the routing key `1234` when defining the 193 | policy. This means that the underlying exchanges used for sharding 194 | will bind the sharded queues to the exchange using the `1234` routing 195 | key specified above. This means that for a direct exchange, _only 196 | messages that are published with the routing key `1234` will be routed 197 | to the sharded queues. If you decide to use a fanout exchange for 198 | sharding, then the `1234` routing key, while used during binding, will 199 | be ignored by the exchange. If you use the `"x-modulus-hash"` 200 | exchange, then the routing key will be ignored as well. So depending 201 | on the exchange you use, will be the effect the `routing-key` policy 202 | definition has while routing messages. 203 | 204 | The `routing-key` policy definition is optional. 205 | 206 | 207 | ## Building from Source 208 | 209 | Get the RabbitMQ Public Umbrella ready as explained in the 210 | [RabbitMQ Plugin Development Guide](https://www.rabbitmq.com/plugin-development.html). 211 | 212 | Move to the umbrella folder an then run the following commands, to 213 | fetch dependencies: 214 | 215 | ```bash 216 | make up 217 | cd deps/rabbitmq-sharding 218 | make dist 219 | ``` 220 | 221 | ## LICENSE ## 222 | 223 | See the LICENSE file. 224 | 225 | ## Extra information ## 226 | 227 | Some information about how the plugin affects message ordering and 228 | some other details can be found in the file README.extra.md 229 | -------------------------------------------------------------------------------- /docs/sharded_queues.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rabbitmq/rabbitmq-sharding/722f8165f156b03ffa2cb7890999b8c37446d3a6/docs/sharded_queues.png -------------------------------------------------------------------------------- /etc/rabbit-hare.config: -------------------------------------------------------------------------------- 1 | %% -*- erlang -*- 2 | %% Note - we still need this for rabbit_sharding_test_util:plugin_dir/0 to work... 3 | []. 4 | -------------------------------------------------------------------------------- /etc/rabbit-test.config: -------------------------------------------------------------------------------- 1 | %% -*- erlang -*- 2 | %% Note - we still need this for rabbit_sharding_test_util:plugin_dir/0 to work... 3 | []. 4 | -------------------------------------------------------------------------------- /etc/rkey.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | CTL=$1 3 | 4 | curl -i -u guest:guest -H "content-type:application/json" \ 5 | -XPUT -d'{"type":"x-consistent-hash","durable":true}' \ 6 | http://localhost:15672/api/exchanges/%2f/rkey.ex 7 | 8 | $CTL set_policy rkey-shard "^rkey\." '{"shards-per-node": 2, "routing-key": "1234"}' 9 | -------------------------------------------------------------------------------- /rabbitmq-components.mk: -------------------------------------------------------------------------------- 1 | ifeq ($(.DEFAULT_GOAL),) 2 | # Define default goal to `all` because this file defines some targets 3 | # before the inclusion of erlang.mk leading to the wrong target becoming 4 | # the default. 5 | .DEFAULT_GOAL = all 6 | endif 7 | 8 | # PROJECT_VERSION defaults to: 9 | # 1. the version exported by rabbitmq-server-release; 10 | # 2. the version stored in `git-revisions.txt`, if it exists; 11 | # 3. a version based on git-describe(1), if it is a Git clone; 12 | # 4. 0.0.0 13 | 14 | PROJECT_VERSION := $(RABBITMQ_VERSION) 15 | 16 | ifeq ($(PROJECT_VERSION),) 17 | PROJECT_VERSION := $(shell \ 18 | if test -f git-revisions.txt; then \ 19 | head -n1 git-revisions.txt | \ 20 | awk '{print $$$(words $(PROJECT_DESCRIPTION) version);}'; \ 21 | else \ 22 | (git describe --dirty --abbrev=7 --tags --always --first-parent \ 23 | 2>/dev/null || echo rabbitmq_v0_0_0) | \ 24 | sed -e 's/^rabbitmq_v//' -e 's/^v//' -e 's/_/./g' -e 's/-/+/' \ 25 | -e 's/-/./g'; \ 26 | fi) 27 | endif 28 | 29 | # -------------------------------------------------------------------- 30 | # RabbitMQ components. 31 | # -------------------------------------------------------------------- 32 | 33 | # For RabbitMQ repositories, we want to checkout branches which match 34 | # the parent project. For instance, if the parent project is on a 35 | # release tag, dependencies must be on the same release tag. If the 36 | # parent project is on a topic branch, dependencies must be on the same 37 | # topic branch or fallback to `stable` or `master` whichever was the 38 | # base of the topic branch. 39 | 40 | dep_amqp_client = git_rmq rabbitmq-erlang-client $(current_rmq_ref) $(base_rmq_ref) master 41 | dep_amqp10_client = git_rmq rabbitmq-amqp1.0-client $(current_rmq_ref) $(base_rmq_ref) master 42 | dep_amqp10_common = git_rmq rabbitmq-amqp1.0-common $(current_rmq_ref) $(base_rmq_ref) master 43 | dep_rabbit = git_rmq rabbitmq-server $(current_rmq_ref) $(base_rmq_ref) master 44 | dep_rabbit_common = git_rmq rabbitmq-common $(current_rmq_ref) $(base_rmq_ref) master 45 | dep_rabbitmq_amqp1_0 = git_rmq rabbitmq-amqp1.0 $(current_rmq_ref) $(base_rmq_ref) master 46 | dep_rabbitmq_auth_backend_amqp = git_rmq rabbitmq-auth-backend-amqp $(current_rmq_ref) $(base_rmq_ref) master 47 | dep_rabbitmq_auth_backend_cache = git_rmq rabbitmq-auth-backend-cache $(current_rmq_ref) $(base_rmq_ref) master 48 | dep_rabbitmq_auth_backend_http = git_rmq rabbitmq-auth-backend-http $(current_rmq_ref) $(base_rmq_ref) master 49 | dep_rabbitmq_auth_backend_ldap = git_rmq rabbitmq-auth-backend-ldap $(current_rmq_ref) $(base_rmq_ref) master 50 | dep_rabbitmq_auth_backend_oauth2 = git_rmq rabbitmq-auth-backend-oauth2 $(current_rmq_ref) $(base_rmq_ref) master 51 | dep_rabbitmq_auth_mechanism_ssl = git_rmq rabbitmq-auth-mechanism-ssl $(current_rmq_ref) $(base_rmq_ref) master 52 | dep_rabbitmq_aws = git_rmq rabbitmq-aws $(current_rmq_ref) $(base_rmq_ref) master 53 | dep_rabbitmq_boot_steps_visualiser = git_rmq rabbitmq-boot-steps-visualiser $(current_rmq_ref) $(base_rmq_ref) master 54 | dep_rabbitmq_cli = git_rmq rabbitmq-cli $(current_rmq_ref) $(base_rmq_ref) master 55 | dep_rabbitmq_codegen = git_rmq rabbitmq-codegen $(current_rmq_ref) $(base_rmq_ref) master 56 | dep_rabbitmq_consistent_hash_exchange = git_rmq rabbitmq-consistent-hash-exchange $(current_rmq_ref) $(base_rmq_ref) master 57 | dep_rabbitmq_ct_client_helpers = git_rmq rabbitmq-ct-client-helpers $(current_rmq_ref) $(base_rmq_ref) master 58 | dep_rabbitmq_ct_helpers = git_rmq rabbitmq-ct-helpers $(current_rmq_ref) $(base_rmq_ref) master 59 | dep_rabbitmq_delayed_message_exchange = git_rmq rabbitmq-delayed-message-exchange $(current_rmq_ref) $(base_rmq_ref) master 60 | dep_rabbitmq_dotnet_client = git_rmq rabbitmq-dotnet-client $(current_rmq_ref) $(base_rmq_ref) master 61 | dep_rabbitmq_event_exchange = git_rmq rabbitmq-event-exchange $(current_rmq_ref) $(base_rmq_ref) master 62 | dep_rabbitmq_federation = git_rmq rabbitmq-federation $(current_rmq_ref) $(base_rmq_ref) master 63 | dep_rabbitmq_federation_management = git_rmq rabbitmq-federation-management $(current_rmq_ref) $(base_rmq_ref) master 64 | dep_rabbitmq_java_client = git_rmq rabbitmq-java-client $(current_rmq_ref) $(base_rmq_ref) master 65 | dep_rabbitmq_jms_client = git_rmq rabbitmq-jms-client $(current_rmq_ref) $(base_rmq_ref) master 66 | dep_rabbitmq_jms_cts = git_rmq rabbitmq-jms-cts $(current_rmq_ref) $(base_rmq_ref) master 67 | dep_rabbitmq_jms_topic_exchange = git_rmq rabbitmq-jms-topic-exchange $(current_rmq_ref) $(base_rmq_ref) master 68 | dep_rabbitmq_lvc_exchange = git_rmq rabbitmq-lvc-exchange $(current_rmq_ref) $(base_rmq_ref) master 69 | dep_rabbitmq_management = git_rmq rabbitmq-management $(current_rmq_ref) $(base_rmq_ref) master 70 | dep_rabbitmq_management_agent = git_rmq rabbitmq-management-agent $(current_rmq_ref) $(base_rmq_ref) master 71 | dep_rabbitmq_management_exchange = git_rmq rabbitmq-management-exchange $(current_rmq_ref) $(base_rmq_ref) master 72 | dep_rabbitmq_management_themes = git_rmq rabbitmq-management-themes $(current_rmq_ref) $(base_rmq_ref) master 73 | dep_rabbitmq_message_timestamp = git_rmq rabbitmq-message-timestamp $(current_rmq_ref) $(base_rmq_ref) master 74 | dep_rabbitmq_metronome = git_rmq rabbitmq-metronome $(current_rmq_ref) $(base_rmq_ref) master 75 | dep_rabbitmq_mqtt = git_rmq rabbitmq-mqtt $(current_rmq_ref) $(base_rmq_ref) master 76 | dep_rabbitmq_objc_client = git_rmq rabbitmq-objc-client $(current_rmq_ref) $(base_rmq_ref) master 77 | dep_rabbitmq_peer_discovery_aws = git_rmq rabbitmq-peer-discovery-aws $(current_rmq_ref) $(base_rmq_ref) master 78 | dep_rabbitmq_peer_discovery_common = git_rmq rabbitmq-peer-discovery-common $(current_rmq_ref) $(base_rmq_ref) master 79 | dep_rabbitmq_peer_discovery_consul = git_rmq rabbitmq-peer-discovery-consul $(current_rmq_ref) $(base_rmq_ref) master 80 | dep_rabbitmq_peer_discovery_etcd = git_rmq rabbitmq-peer-discovery-etcd $(current_rmq_ref) $(base_rmq_ref) master 81 | dep_rabbitmq_peer_discovery_k8s = git_rmq rabbitmq-peer-discovery-k8s $(current_rmq_ref) $(base_rmq_ref) master 82 | dep_rabbitmq_prometheus = git_rmq rabbitmq-prometheus $(current_rmq_ref) $(base_rmq_ref) master 83 | dep_rabbitmq_random_exchange = git_rmq rabbitmq-random-exchange $(current_rmq_ref) $(base_rmq_ref) master 84 | dep_rabbitmq_recent_history_exchange = git_rmq rabbitmq-recent-history-exchange $(current_rmq_ref) $(base_rmq_ref) master 85 | dep_rabbitmq_routing_node_stamp = git_rmq rabbitmq-routing-node-stamp $(current_rmq_ref) $(base_rmq_ref) master 86 | dep_rabbitmq_rtopic_exchange = git_rmq rabbitmq-rtopic-exchange $(current_rmq_ref) $(base_rmq_ref) master 87 | dep_rabbitmq_server_release = git_rmq rabbitmq-server-release $(current_rmq_ref) $(base_rmq_ref) master 88 | dep_rabbitmq_sharding = git_rmq rabbitmq-sharding $(current_rmq_ref) $(base_rmq_ref) master 89 | dep_rabbitmq_shovel = git_rmq rabbitmq-shovel $(current_rmq_ref) $(base_rmq_ref) master 90 | dep_rabbitmq_shovel_management = git_rmq rabbitmq-shovel-management $(current_rmq_ref) $(base_rmq_ref) master 91 | dep_rabbitmq_stomp = git_rmq rabbitmq-stomp $(current_rmq_ref) $(base_rmq_ref) master 92 | dep_rabbitmq_stream = git_rmq rabbitmq-stream $(current_rmq_ref) $(base_rmq_ref) master 93 | dep_rabbitmq_toke = git_rmq rabbitmq-toke $(current_rmq_ref) $(base_rmq_ref) master 94 | dep_rabbitmq_top = git_rmq rabbitmq-top $(current_rmq_ref) $(base_rmq_ref) master 95 | dep_rabbitmq_tracing = git_rmq rabbitmq-tracing $(current_rmq_ref) $(base_rmq_ref) master 96 | dep_rabbitmq_trust_store = git_rmq rabbitmq-trust-store $(current_rmq_ref) $(base_rmq_ref) master 97 | dep_rabbitmq_test = git_rmq rabbitmq-test $(current_rmq_ref) $(base_rmq_ref) master 98 | dep_rabbitmq_web_dispatch = git_rmq rabbitmq-web-dispatch $(current_rmq_ref) $(base_rmq_ref) master 99 | dep_rabbitmq_web_stomp = git_rmq rabbitmq-web-stomp $(current_rmq_ref) $(base_rmq_ref) master 100 | dep_rabbitmq_web_stomp_examples = git_rmq rabbitmq-web-stomp-examples $(current_rmq_ref) $(base_rmq_ref) master 101 | dep_rabbitmq_web_mqtt = git_rmq rabbitmq-web-mqtt $(current_rmq_ref) $(base_rmq_ref) master 102 | dep_rabbitmq_web_mqtt_examples = git_rmq rabbitmq-web-mqtt-examples $(current_rmq_ref) $(base_rmq_ref) master 103 | dep_rabbitmq_website = git_rmq rabbitmq-website $(current_rmq_ref) $(base_rmq_ref) live master 104 | dep_toke = git_rmq toke $(current_rmq_ref) $(base_rmq_ref) master 105 | 106 | dep_rabbitmq_public_umbrella = git_rmq rabbitmq-public-umbrella $(current_rmq_ref) $(base_rmq_ref) master 107 | 108 | # Third-party dependencies version pinning. 109 | # 110 | # We do that in this file, which is copied in all projects, to ensure 111 | # all projects use the same versions. It avoids conflicts and makes it 112 | # possible to work with rabbitmq-public-umbrella. 113 | 114 | dep_accept = hex 0.3.5 115 | dep_cowboy = hex 2.8.0 116 | dep_cowlib = hex 2.9.1 117 | dep_jsx = hex 2.11.0 118 | dep_lager = hex 3.8.0 119 | dep_prometheus = git https://github.com/deadtrickster/prometheus.erl.git master 120 | dep_ra = git https://github.com/rabbitmq/ra.git master 121 | dep_ranch = hex 1.7.1 122 | dep_recon = hex 2.5.1 123 | dep_observer_cli = hex 1.5.4 124 | dep_stdout_formatter = hex 0.2.4 125 | dep_sysmon_handler = hex 1.3.0 126 | 127 | RABBITMQ_COMPONENTS = amqp_client \ 128 | amqp10_common \ 129 | amqp10_client \ 130 | rabbit \ 131 | rabbit_common \ 132 | rabbitmq_amqp1_0 \ 133 | rabbitmq_auth_backend_amqp \ 134 | rabbitmq_auth_backend_cache \ 135 | rabbitmq_auth_backend_http \ 136 | rabbitmq_auth_backend_ldap \ 137 | rabbitmq_auth_backend_oauth2 \ 138 | rabbitmq_auth_mechanism_ssl \ 139 | rabbitmq_aws \ 140 | rabbitmq_boot_steps_visualiser \ 141 | rabbitmq_cli \ 142 | rabbitmq_codegen \ 143 | rabbitmq_consistent_hash_exchange \ 144 | rabbitmq_ct_client_helpers \ 145 | rabbitmq_ct_helpers \ 146 | rabbitmq_delayed_message_exchange \ 147 | rabbitmq_dotnet_client \ 148 | rabbitmq_event_exchange \ 149 | rabbitmq_federation \ 150 | rabbitmq_federation_management \ 151 | rabbitmq_java_client \ 152 | rabbitmq_jms_client \ 153 | rabbitmq_jms_cts \ 154 | rabbitmq_jms_topic_exchange \ 155 | rabbitmq_lvc_exchange \ 156 | rabbitmq_management \ 157 | rabbitmq_management_agent \ 158 | rabbitmq_management_exchange \ 159 | rabbitmq_management_themes \ 160 | rabbitmq_message_timestamp \ 161 | rabbitmq_metronome \ 162 | rabbitmq_mqtt \ 163 | rabbitmq_objc_client \ 164 | rabbitmq_peer_discovery_aws \ 165 | rabbitmq_peer_discovery_common \ 166 | rabbitmq_peer_discovery_consul \ 167 | rabbitmq_peer_discovery_etcd \ 168 | rabbitmq_peer_discovery_k8s \ 169 | rabbitmq_prometheus \ 170 | rabbitmq_random_exchange \ 171 | rabbitmq_recent_history_exchange \ 172 | rabbitmq_routing_node_stamp \ 173 | rabbitmq_rtopic_exchange \ 174 | rabbitmq_server_release \ 175 | rabbitmq_sharding \ 176 | rabbitmq_shovel \ 177 | rabbitmq_shovel_management \ 178 | rabbitmq_stomp \ 179 | rabbitmq_stream \ 180 | rabbitmq_toke \ 181 | rabbitmq_top \ 182 | rabbitmq_tracing \ 183 | rabbitmq_trust_store \ 184 | rabbitmq_web_dispatch \ 185 | rabbitmq_web_mqtt \ 186 | rabbitmq_web_mqtt_examples \ 187 | rabbitmq_web_stomp \ 188 | rabbitmq_web_stomp_examples \ 189 | rabbitmq_website 190 | 191 | # Erlang.mk does not rebuild dependencies by default, once they were 192 | # compiled once, except for those listed in the `$(FORCE_REBUILD)` 193 | # variable. 194 | # 195 | # We want all RabbitMQ components to always be rebuilt: this eases 196 | # the work on several components at the same time. 197 | 198 | FORCE_REBUILD = $(RABBITMQ_COMPONENTS) 199 | 200 | # Several components have a custom erlang.mk/build.config, mainly 201 | # to disable eunit. Therefore, we can't use the top-level project's 202 | # erlang.mk copy. 203 | NO_AUTOPATCH += $(RABBITMQ_COMPONENTS) 204 | 205 | ifeq ($(origin current_rmq_ref),undefined) 206 | ifneq ($(wildcard .git),) 207 | current_rmq_ref := $(shell (\ 208 | ref=$$(LANG=C git branch --list | awk '/^\* \(.*detached / {ref=$$0; sub(/.*detached [^ ]+ /, "", ref); sub(/\)$$/, "", ref); print ref; exit;} /^\* / {ref=$$0; sub(/^\* /, "", ref); print ref; exit}');\ 209 | if test "$$(git rev-parse --short HEAD)" != "$$ref"; then echo "$$ref"; fi)) 210 | else 211 | current_rmq_ref := master 212 | endif 213 | endif 214 | export current_rmq_ref 215 | 216 | ifeq ($(origin base_rmq_ref),undefined) 217 | ifneq ($(wildcard .git),) 218 | possible_base_rmq_ref := master 219 | ifeq ($(possible_base_rmq_ref),$(current_rmq_ref)) 220 | base_rmq_ref := $(current_rmq_ref) 221 | else 222 | base_rmq_ref := $(shell \ 223 | (git rev-parse --verify -q master >/dev/null && \ 224 | git rev-parse --verify -q $(possible_base_rmq_ref) >/dev/null && \ 225 | git merge-base --is-ancestor $$(git merge-base master HEAD) $(possible_base_rmq_ref) && \ 226 | echo $(possible_base_rmq_ref)) || \ 227 | echo master) 228 | endif 229 | else 230 | base_rmq_ref := master 231 | endif 232 | endif 233 | export base_rmq_ref 234 | 235 | # Repository URL selection. 236 | # 237 | # First, we infer other components' location from the current project 238 | # repository URL, if it's a Git repository: 239 | # - We take the "origin" remote URL as the base 240 | # - The current project name and repository name is replaced by the 241 | # target's properties: 242 | # eg. rabbitmq-common is replaced by rabbitmq-codegen 243 | # eg. rabbit_common is replaced by rabbitmq_codegen 244 | # 245 | # If cloning from this computed location fails, we fallback to RabbitMQ 246 | # upstream which is GitHub. 247 | 248 | # Macro to transform eg. "rabbit_common" to "rabbitmq-common". 249 | rmq_cmp_repo_name = $(word 2,$(dep_$(1))) 250 | 251 | # Upstream URL for the current project. 252 | RABBITMQ_COMPONENT_REPO_NAME := $(call rmq_cmp_repo_name,$(PROJECT)) 253 | RABBITMQ_UPSTREAM_FETCH_URL ?= https://github.com/rabbitmq/$(RABBITMQ_COMPONENT_REPO_NAME).git 254 | RABBITMQ_UPSTREAM_PUSH_URL ?= git@github.com:rabbitmq/$(RABBITMQ_COMPONENT_REPO_NAME).git 255 | 256 | # Current URL for the current project. If this is not a Git clone, 257 | # default to the upstream Git repository. 258 | ifneq ($(wildcard .git),) 259 | git_origin_fetch_url := $(shell git config remote.origin.url) 260 | git_origin_push_url := $(shell git config remote.origin.pushurl || git config remote.origin.url) 261 | RABBITMQ_CURRENT_FETCH_URL ?= $(git_origin_fetch_url) 262 | RABBITMQ_CURRENT_PUSH_URL ?= $(git_origin_push_url) 263 | else 264 | RABBITMQ_CURRENT_FETCH_URL ?= $(RABBITMQ_UPSTREAM_FETCH_URL) 265 | RABBITMQ_CURRENT_PUSH_URL ?= $(RABBITMQ_UPSTREAM_PUSH_URL) 266 | endif 267 | 268 | # Macro to replace the following pattern: 269 | # 1. /foo.git -> /bar.git 270 | # 2. /foo -> /bar 271 | # 3. /foo/ -> /bar/ 272 | subst_repo_name = $(patsubst %/$(1)/%,%/$(2)/%,$(patsubst %/$(1),%/$(2),$(patsubst %/$(1).git,%/$(2).git,$(3)))) 273 | 274 | # Macro to replace both the project's name (eg. "rabbit_common") and 275 | # repository name (eg. "rabbitmq-common") by the target's equivalent. 276 | # 277 | # This macro is kept on one line because we don't want whitespaces in 278 | # the returned value, as it's used in $(dep_fetch_git_rmq) in a shell 279 | # single-quoted string. 280 | dep_rmq_repo = $(if $(dep_$(2)),$(call subst_repo_name,$(PROJECT),$(2),$(call subst_repo_name,$(RABBITMQ_COMPONENT_REPO_NAME),$(call rmq_cmp_repo_name,$(2)),$(1))),$(pkg_$(1)_repo)) 281 | 282 | dep_rmq_commits = $(if $(dep_$(1)), \ 283 | $(wordlist 3,$(words $(dep_$(1))),$(dep_$(1))), \ 284 | $(pkg_$(1)_commit)) 285 | 286 | define dep_fetch_git_rmq 287 | fetch_url1='$(call dep_rmq_repo,$(RABBITMQ_CURRENT_FETCH_URL),$(1))'; \ 288 | fetch_url2='$(call dep_rmq_repo,$(RABBITMQ_UPSTREAM_FETCH_URL),$(1))'; \ 289 | if test "$$$$fetch_url1" != '$(RABBITMQ_CURRENT_FETCH_URL)' && \ 290 | git clone -q -n -- "$$$$fetch_url1" $(DEPS_DIR)/$(call dep_name,$(1)); then \ 291 | fetch_url="$$$$fetch_url1"; \ 292 | push_url='$(call dep_rmq_repo,$(RABBITMQ_CURRENT_PUSH_URL),$(1))'; \ 293 | elif git clone -q -n -- "$$$$fetch_url2" $(DEPS_DIR)/$(call dep_name,$(1)); then \ 294 | fetch_url="$$$$fetch_url2"; \ 295 | push_url='$(call dep_rmq_repo,$(RABBITMQ_UPSTREAM_PUSH_URL),$(1))'; \ 296 | fi; \ 297 | cd $(DEPS_DIR)/$(call dep_name,$(1)) && ( \ 298 | $(foreach ref,$(call dep_rmq_commits,$(1)), \ 299 | git checkout -q $(ref) >/dev/null 2>&1 || \ 300 | ) \ 301 | (echo "error: no valid pathspec among: $(call dep_rmq_commits,$(1))" \ 302 | 1>&2 && false) ) && \ 303 | (test "$$$$fetch_url" = "$$$$push_url" || \ 304 | git remote set-url --push origin "$$$$push_url") 305 | endef 306 | 307 | # -------------------------------------------------------------------- 308 | # Component distribution. 309 | # -------------------------------------------------------------------- 310 | 311 | list-dist-deps:: 312 | @: 313 | 314 | prepare-dist:: 315 | @: 316 | 317 | # -------------------------------------------------------------------- 318 | # Umbrella-specific settings. 319 | # -------------------------------------------------------------------- 320 | 321 | # If the top-level project is a RabbitMQ component, we override 322 | # $(DEPS_DIR) for this project to point to the top-level's one. 323 | # 324 | # We also verify that the guessed DEPS_DIR is actually named `deps`, 325 | # to rule out any situation where it is a coincidence that we found a 326 | # `rabbitmq-components.mk` up upper directories. 327 | 328 | possible_deps_dir_1 = $(abspath ..) 329 | possible_deps_dir_2 = $(abspath ../../..) 330 | 331 | ifeq ($(notdir $(possible_deps_dir_1)),deps) 332 | ifneq ($(wildcard $(possible_deps_dir_1)/../rabbitmq-components.mk),) 333 | deps_dir_overriden = 1 334 | DEPS_DIR ?= $(possible_deps_dir_1) 335 | DISABLE_DISTCLEAN = 1 336 | endif 337 | endif 338 | 339 | ifeq ($(deps_dir_overriden),) 340 | ifeq ($(notdir $(possible_deps_dir_2)),deps) 341 | ifneq ($(wildcard $(possible_deps_dir_2)/../rabbitmq-components.mk),) 342 | deps_dir_overriden = 1 343 | DEPS_DIR ?= $(possible_deps_dir_2) 344 | DISABLE_DISTCLEAN = 1 345 | endif 346 | endif 347 | endif 348 | 349 | ifneq ($(wildcard UMBRELLA.md),) 350 | DISABLE_DISTCLEAN = 1 351 | endif 352 | 353 | # We disable `make distclean` so $(DEPS_DIR) is not accidentally removed. 354 | 355 | ifeq ($(DISABLE_DISTCLEAN),1) 356 | ifneq ($(filter distclean distclean-deps,$(MAKECMDGOALS)),) 357 | SKIP_DEPS = 1 358 | endif 359 | endif 360 | -------------------------------------------------------------------------------- /src/rabbit_sharding_exchange_decorator.erl: -------------------------------------------------------------------------------- 1 | %% This Source Code Form is subject to the terms of the Mozilla Public 2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this 3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/. 4 | %% 5 | %% Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved. 6 | %% 7 | 8 | -module(rabbit_sharding_exchange_decorator). 9 | 10 | -rabbit_boot_step({?MODULE, 11 | [{description, "sharding exchange decorator"}, 12 | {mfa, {rabbit_registry, register, 13 | [exchange_decorator, <<"sharding">>, ?MODULE]}}, 14 | {cleanup, {rabbit_registry, unregister, 15 | [exchange_decorator, <<"sharding">>]}}, 16 | {requires, rabbit_registry}, 17 | {enables, recovery}]}). 18 | 19 | -include_lib("rabbit_common/include/rabbit.hrl"). 20 | 21 | -behaviour(rabbit_exchange_decorator). 22 | 23 | -export([description/0, serialise_events/1]). 24 | -export([create/2, delete/3, policy_changed/2, 25 | add_binding/3, remove_bindings/3, route/2, active_for/1]). 26 | 27 | -import(rabbit_sharding_util, [shard/1]). 28 | 29 | %%---------------------------------------------------------------------------- 30 | 31 | description() -> 32 | [{description, <<"Shard exchange decorator">>}]. 33 | 34 | serialise_events(_X) -> false. 35 | 36 | create(transaction, _X) -> 37 | ok; 38 | create(none, X) -> 39 | maybe_start_sharding(X), 40 | ok. 41 | 42 | add_binding(_Tx, _X, _B) -> ok. 43 | remove_bindings(_Tx, _X, _Bs) -> ok. 44 | 45 | route(_, _) -> []. 46 | 47 | active_for(X) -> 48 | case shard(X) of 49 | true -> noroute; 50 | false -> none 51 | end. 52 | 53 | %% we have to remove the policy from ?SHARDING_TABLE 54 | delete(transaction, _X, _Bs) -> ok; 55 | delete(none, X, _Bs) -> 56 | maybe_stop_sharding(X), 57 | ok. 58 | 59 | %% we have to remove the old policy from ?SHARDING_TABLE 60 | %% and then add the new one. 61 | policy_changed(OldX, NewX) -> 62 | maybe_update_sharding(OldX, NewX), 63 | ok. 64 | 65 | %%---------------------------------------------------------------------------- 66 | 67 | maybe_update_sharding(OldX, NewX) -> 68 | case shard(NewX) of 69 | true -> 70 | rabbit_sharding_shard:maybe_update_shards(OldX, NewX); 71 | false -> 72 | rabbit_sharding_shard:stop_sharding(OldX) 73 | end. 74 | 75 | maybe_start_sharding(X)-> 76 | case shard(X) of 77 | true -> 78 | rabbit_sharding_shard:ensure_sharded_queues(X); 79 | false -> 80 | ok 81 | end. 82 | 83 | maybe_stop_sharding(X) -> 84 | case shard(X) of 85 | true -> 86 | rabbit_sharding_shard:stop_sharding(X); 87 | false -> 88 | ok 89 | end. 90 | -------------------------------------------------------------------------------- /src/rabbit_sharding_exchange_type_modulus_hash.erl: -------------------------------------------------------------------------------- 1 | %% This Source Code Form is subject to the terms of the Mozilla Public 2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this 3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/. 4 | %% 5 | %% Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved. 6 | %% 7 | 8 | -module(rabbit_sharding_exchange_type_modulus_hash). 9 | 10 | -include_lib("rabbit_common/include/rabbit.hrl"). 11 | 12 | -behaviour(rabbit_exchange_type). 13 | 14 | -export([description/0, serialise_events/0, route/2, info/1, info/2]). 15 | -export([validate/1, validate_binding/2, 16 | create/2, delete/3, policy_changed/2, 17 | add_binding/3, remove_bindings/3, assert_args_equivalence/2]). 18 | 19 | -rabbit_boot_step( 20 | {rabbit_sharding_exchange_type_modulus_hash_registry, 21 | [{description, "exchange type x-modulus-hash: registry"}, 22 | {mfa, {rabbit_registry, register, 23 | [exchange, <<"x-modulus-hash">>, ?MODULE]}}, 24 | {cleanup, {rabbit_registry, unregister, 25 | [exchange, <<"x-modulus-hash">>]}}, 26 | {requires, rabbit_registry}, 27 | {enables, kernel_ready}]}). 28 | 29 | -define(PHASH2_RANGE, 134217728). %% 2^27 30 | 31 | description() -> 32 | [{description, <<"Modulus Hashing Exchange">>}]. 33 | 34 | serialise_events() -> false. 35 | 36 | route(#exchange{name = Name}, 37 | #delivery{message = #basic_message{routing_keys = Routes}}) -> 38 | Qs = rabbit_router:match_routing_key(Name, ['_']), 39 | case length(Qs) of 40 | 0 -> []; 41 | N -> [lists:nth(hash_mod(Routes, N), Qs)] 42 | end. 43 | 44 | info(_) -> []. 45 | 46 | info(_, _) -> []. 47 | 48 | validate(_X) -> ok. 49 | validate_binding(_X, _B) -> ok. 50 | create(_Tx, _X) -> ok. 51 | delete(_Tx, _X, _Bs) -> ok. 52 | policy_changed(_X1, _X2) -> ok. 53 | add_binding(_Tx, _X, _B) -> ok. 54 | remove_bindings(_Tx, _X, _Bs) -> ok. 55 | assert_args_equivalence(X, Args) -> 56 | rabbit_exchange:assert_args_equivalence(X, Args). 57 | 58 | hash_mod(Routes, N) -> 59 | M = erlang:phash2(Routes, ?PHASH2_RANGE) rem N, 60 | M + 1. %% erlang lists are 1..N indexed. 61 | -------------------------------------------------------------------------------- /src/rabbit_sharding_interceptor.erl: -------------------------------------------------------------------------------- 1 | %% This Source Code Form is subject to the terms of the Mozilla Public 2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this 3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/. 4 | %% 5 | %% Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved. 6 | %% 7 | 8 | -module(rabbit_sharding_interceptor). 9 | 10 | -include_lib("rabbit_common/include/rabbit_framing.hrl"). 11 | 12 | -behaviour(rabbit_channel_interceptor). 13 | 14 | -export([description/0, intercept/3, applies_to/0, init/1]). 15 | 16 | %% exported for tests 17 | -export([consumer_count/1]). 18 | 19 | -import(rabbit_sharding_util, [a2b/1, shards_per_node/1]). 20 | -import(rabbit_misc, [r/3, format/2, protocol_error/3]). 21 | 22 | -rabbit_boot_step({?MODULE, 23 | [{description, "sharding interceptor"}, 24 | {mfa, {rabbit_registry, register, 25 | [channel_interceptor, 26 | <<"sharding interceptor">>, ?MODULE]}}, 27 | {cleanup, {rabbit_registry, unregister, 28 | [channel_interceptor, 29 | <<"sharding interceptor">>]}}, 30 | {requires, rabbit_registry}, 31 | {enables, recovery}]}). 32 | 33 | init(Ch) -> 34 | rabbit_channel:get_vhost(Ch). 35 | 36 | description() -> 37 | [{description, <<"Sharding interceptor for channel methods">>}]. 38 | 39 | intercept(#'basic.consume'{queue = QName} = Method, Content, VHost) -> 40 | case queue_name(VHost, QName) of 41 | {ok, QName2} -> 42 | {Method#'basic.consume'{queue = QName2}, Content}; 43 | {error, QName} -> 44 | precondition_failed("Error finding sharded queue for: ~p", [QName]) 45 | end; 46 | 47 | intercept(#'basic.get'{queue = QName} = Method, Content, VHost) -> 48 | case queue_name(VHost, QName) of 49 | {ok, QName2} -> 50 | {Method#'basic.get'{queue = QName2}, Content}; 51 | {error, QName} -> 52 | precondition_failed("Error finding sharded queue for: ~p", [QName]) 53 | end; 54 | 55 | intercept(#'queue.delete'{queue = QName} = Method, Content, VHost) -> 56 | case is_sharded(VHost, QName) of 57 | true -> 58 | precondition_failed("Can't delete sharded queue: ~p", [QName]); 59 | _ -> 60 | {Method, Content} 61 | end; 62 | 63 | intercept(#'queue.declare'{queue = QName} = Method, Content, VHost) -> 64 | case is_sharded(VHost, QName) of 65 | true -> 66 | %% Since as an interceptor we can't modify what the channel 67 | %% will return, we then modify the queue name so the channel 68 | %% can at least return a queue.declare_ok for that particular 69 | %% queue. Picking the first queue over the others is totally 70 | %% arbitrary. 71 | QName2 = rabbit_sharding_util:make_queue_name( 72 | QName, a2b(node()), 0), 73 | {Method#'queue.declare'{queue = QName2}, Content}; 74 | _ -> 75 | {Method, Content} 76 | end; 77 | 78 | intercept(#'queue.bind'{queue = QName} = Method, Content, VHost) -> 79 | case is_sharded(VHost, QName) of 80 | true -> 81 | precondition_failed("Can't bind sharded queue: ~p", [QName]); 82 | _ -> 83 | {Method, Content} 84 | end; 85 | 86 | intercept(#'queue.unbind'{queue = QName} = Method, Content, VHost) -> 87 | case is_sharded(VHost, QName) of 88 | true -> 89 | precondition_failed("Can't unbind sharded queue: ~p", [QName]); 90 | _ -> 91 | {Method, Content} 92 | end; 93 | 94 | intercept(#'queue.purge'{queue = QName} = Method, Content, VHost) -> 95 | case is_sharded(VHost, QName) of 96 | true -> 97 | precondition_failed("Can't purge sharded queue: ~p", [QName]); 98 | _ -> 99 | {Method, Content} 100 | end; 101 | 102 | intercept(Method, Content, _VHost) -> 103 | {Method, Content}. 104 | 105 | applies_to() -> 106 | ['basic.consume', 'basic.get', 'queue.delete', 'queue.declare', 107 | 'queue.bind', 'queue.unbind', 'queue.purge']. 108 | 109 | %%---------------------------------------------------------------------------- 110 | 111 | %% If the queue is not part of a shard, return unmodified name 112 | queue_name(VHost, QBin) -> 113 | case lookup_exchange(VHost, QBin) of 114 | {ok, X} -> 115 | case rabbit_sharding_util:shard(X) of 116 | true -> 117 | least_consumers(VHost, QBin, shards_per_node(X)); 118 | _ -> 119 | {ok, QBin} 120 | end; 121 | _Error -> 122 | {ok, QBin} 123 | end. 124 | 125 | is_sharded(VHost, QBin) -> 126 | case lookup_exchange(VHost, QBin) of 127 | {ok, X} -> 128 | rabbit_sharding_util:shard(X); 129 | _Error -> 130 | false 131 | end. 132 | 133 | lookup_exchange(VHost, QBin) -> 134 | rabbit_exchange:lookup(r(VHost, exchange, QBin)). 135 | 136 | least_consumers(VHost, QBin, N) -> 137 | F = fun(QNum) -> 138 | QBin2 = rabbit_sharding_util:make_queue_name( 139 | QBin, a2b(node()), QNum), 140 | case consumer_count(r(VHost, queue, QBin2)) of 141 | {error, E} -> {error, E}; 142 | [{consumers, C}] -> {C, QBin2} 143 | end 144 | 145 | end, 146 | case queues_with_count(F, N) of 147 | [] -> 148 | {error, QBin}; 149 | Queues -> 150 | [{_, QBin3} | _ ] = lists:sort(Queues), 151 | {ok, QBin3} 152 | end. 153 | 154 | queues_with_count(F, N) -> 155 | lists:foldl(fun (C, Acc) -> 156 | case F(C) of 157 | {error, _} -> Acc; 158 | Ret -> [Ret|Acc] 159 | end 160 | end, [], lists:seq(0, N-1)). 161 | 162 | consumer_count(QName) -> 163 | rabbit_amqqueue:with( 164 | QName, 165 | fun(Q) -> 166 | rabbit_amqqueue:info(Q, [consumers]) 167 | end). 168 | 169 | precondition_failed(Format, QName) -> 170 | protocol_error(precondition_failed, Format, QName). 171 | -------------------------------------------------------------------------------- /src/rabbit_sharding_policy_validator.erl: -------------------------------------------------------------------------------- 1 | %% This Source Code Form is subject to the terms of the Mozilla Public 2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this 3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/. 4 | %% 5 | %% Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved. 6 | %% 7 | 8 | -module(rabbit_sharding_policy_validator). 9 | 10 | -behaviour(rabbit_policy_validator). 11 | 12 | -include_lib("rabbit_common/include/rabbit.hrl"). 13 | 14 | -export([register/0, validate_policy/1]). 15 | 16 | -rabbit_boot_step({?MODULE, 17 | [{description, "sharding parameters"}, 18 | {mfa, {?MODULE, register, []}}, 19 | {requires, rabbit_registry}, 20 | {enables, recovery}]}). 21 | 22 | register() -> 23 | [rabbit_registry:register(Class, Name, ?MODULE) || 24 | {Class, Name} <- [{policy_validator, <<"shards-per-node">>}, 25 | {policy_validator, <<"routing-key">>}]], 26 | ok. 27 | 28 | validate_policy(KeyList) -> 29 | SPN = proplists:get_value(<<"shards-per-node">>, KeyList, none), 30 | RKey = proplists:get_value(<<"routing-key">>, KeyList, none), 31 | case {SPN, RKey} of 32 | {none, none} -> 33 | ok; 34 | {none, _} -> 35 | {error, "shards-per-node must be specified", []}; 36 | {SPN, none} -> 37 | validate_shards_per_node(SPN); 38 | {SPN, RKey} -> 39 | case validate_shards_per_node(SPN) of 40 | ok -> validate_routing_key(RKey); 41 | Else -> Else 42 | end 43 | end. 44 | 45 | %%---------------------------------------------------------------------------- 46 | 47 | validate_shards_per_node(Term) when is_number(Term) -> 48 | case Term >= 0 of 49 | true -> 50 | ok; 51 | false -> 52 | {error, "shards-per-node should be greater than 0, actually was ~p", 53 | [Term]} 54 | end; 55 | validate_shards_per_node(Term) -> 56 | {error, "shards-per-node should be a number, actually was ~p", [Term]}. 57 | 58 | validate_routing_key(Term) when is_binary(Term) -> 59 | ok; 60 | validate_routing_key(Term) -> 61 | {error, "routing-key should be binary, actually was ~p", [Term]}. 62 | -------------------------------------------------------------------------------- /src/rabbit_sharding_shard.erl: -------------------------------------------------------------------------------- 1 | %% This Source Code Form is subject to the terms of the Mozilla Public 2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this 3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/. 4 | %% 5 | %% Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved. 6 | %% 7 | 8 | -module(rabbit_sharding_shard). 9 | 10 | -include_lib("rabbit_common/include/rabbit.hrl"). 11 | 12 | -export([maybe_shard_exchanges/0, 13 | ensure_sharded_queues/1, 14 | maybe_update_shards/2, 15 | stop_sharding/1]). 16 | 17 | -import(rabbit_misc, [r/3]). 18 | -import(rabbit_sharding_util, [a2b/1, exchange_bin/1, make_queue_name/3, 19 | routing_key/1, shards_per_node/1]). 20 | 21 | -rabbit_boot_step({rabbit_sharding_maybe_shard, 22 | [{description, "rabbit sharding maybe shard"}, 23 | {mfa, {?MODULE, maybe_shard_exchanges, []}}, 24 | {requires, recovery}]}). 25 | 26 | -define(MAX_CONNECTION_CLOSE_TIMEOUT, 10000). 27 | -define(SHARDING_USER, <<"rmq-sharding">>). 28 | 29 | %% We make sure the sharded queues are created when 30 | %% RabbitMQ starts. 31 | maybe_shard_exchanges() -> 32 | [maybe_shard_exchanges(V) || V <- rabbit_vhost:list_names()], 33 | ok. 34 | 35 | maybe_shard_exchanges(VHost) -> 36 | [ensure_sharded_queues(X) || 37 | X <- rabbit_sharding_util:sharded_exchanges(VHost)]. 38 | 39 | %% queue needs to be declared on the respective node. 40 | ensure_sharded_queues(X) -> 41 | add_queues(X), 42 | bind_queues(X). 43 | 44 | maybe_update_shards(OldX, NewX) -> 45 | maybe_unbind_queues(routing_key(OldX), routing_key(NewX), OldX), 46 | add_queues(NewX), 47 | bind_queues(NewX). 48 | 49 | stop_sharding(OldX) -> 50 | unbind_queues(shards_per_node(OldX), OldX). 51 | 52 | %% routing key didn't change. Do nothing. 53 | maybe_unbind_queues(RK, RK, _OldX) -> 54 | ok; 55 | maybe_unbind_queues(_RK, _NewRK, OldX) -> 56 | unbind_queues(shards_per_node(OldX), OldX). 57 | 58 | unbind_queues(undefined, _X) -> 59 | ok; 60 | unbind_queues(OldSPN, #exchange{name = XName} = X) -> 61 | OldRKey = routing_key(X), 62 | foreach_node(fun(Node) -> 63 | [unbind_queue(XName, OldRKey, N, Node) 64 | || N <- lists:seq(0, OldSPN-1)] 65 | end). 66 | 67 | add_queues(#exchange{name = XName, durable = Durable} = X) -> 68 | SPN = shards_per_node(X), 69 | foreach_node(fun(Node) -> 70 | [declare_queue(XName, Durable, N, Node) 71 | || N <- lists:seq(0, SPN-1)] 72 | end). 73 | 74 | bind_queues(#exchange{name = XName} = X) -> 75 | RKey = routing_key(X), 76 | SPN = shards_per_node(X), 77 | foreach_node(fun(Node) -> 78 | [bind_queue(XName, RKey, N, Node) || 79 | N <- lists:seq(0, SPN-1)] 80 | end). 81 | 82 | %%---------------------------------------------------------------------------- 83 | 84 | declare_queue(XName, Durable, N, Node) -> 85 | QBin = make_queue_name(exchange_bin(XName), a2b(Node), N), 86 | QueueName = rabbit_misc:r(v(XName), queue, QBin), 87 | try rabbit_amqqueue:declare(QueueName, Durable, false, [], none, 88 | ?SHARDING_USER, {ignore_location, Node}) of 89 | {_Reply, _Q} -> 90 | ok 91 | catch 92 | _Error:Reason -> 93 | rabbit_log:error("sharding failed to declare queue for exchange ~p" 94 | " - soft error:~n~p~n", 95 | [exchange_bin(XName), Reason]), 96 | error 97 | end. 98 | 99 | bind_queue(XName, RoutingKey, N, Node) -> 100 | binding_action(fun rabbit_binding:add/3, 101 | XName, RoutingKey, N, Node, 102 | "sharding failed to bind queue ~p to exchange ~p" 103 | " - soft error:~n~p~n"). 104 | 105 | unbind_queue(XName, RoutingKey, N, Node) -> 106 | binding_action(fun rabbit_binding:remove/3, 107 | XName, RoutingKey, N, Node, 108 | "sharding failed to unbind queue ~p to exchange ~p" 109 | " - soft error:~n~p~n"). 110 | 111 | binding_action(F, XName, RoutingKey, N, Node, ErrMsg) -> 112 | QBin = make_queue_name(exchange_bin(XName), a2b(Node), N), 113 | QueueName = rabbit_misc:r(v(XName), queue, QBin), 114 | case F(#binding{source = XName, 115 | destination = QueueName, 116 | key = RoutingKey, 117 | args = []}, 118 | fun (_X, _Q) -> ok end, 119 | ?SHARDING_USER) of 120 | ok -> ok; 121 | {error, Reason} -> 122 | rabbit_log:error(ErrMsg, [QBin, exchange_bin(XName), Reason]), 123 | error 124 | end. 125 | 126 | v(#resource{virtual_host = VHost}) -> 127 | VHost. 128 | 129 | foreach_node(F) -> 130 | [F(Node) || Node <- running_nodes()]. 131 | 132 | running_nodes() -> 133 | proplists:get_value(running_nodes, rabbit_mnesia:status(), []). 134 | -------------------------------------------------------------------------------- /src/rabbit_sharding_util.erl: -------------------------------------------------------------------------------- 1 | %% This Source Code Form is subject to the terms of the Mozilla Public 2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this 3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/. 4 | %% 5 | %% Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved. 6 | %% 7 | 8 | -module(rabbit_sharding_util). 9 | 10 | -export([shard/1, sharded_exchanges/1]). 11 | -export([get_policy/2, shards_per_node/1, routing_key/1]). 12 | -export([exchange_bin/1, make_queue_name/3, a2b/1]). 13 | 14 | -include_lib("rabbit_common/include/rabbit.hrl"). 15 | 16 | -import(rabbit_misc, [pget/3]). 17 | 18 | shard(X) -> 19 | case get_policy(<<"shards-per-node">>, X) of 20 | undefined -> false; 21 | _SPN -> true 22 | end. 23 | 24 | sharded_exchanges(VHost) -> 25 | [X || X <- rabbit_exchange:list(VHost), shard(X)]. 26 | 27 | shards_per_node(X) -> 28 | get_policy(<<"shards-per-node">>, X). 29 | 30 | routing_key(X) -> 31 | case get_policy(<<"routing-key">>, X) of 32 | undefined -> 33 | <<>>; 34 | Value -> 35 | Value 36 | end. 37 | 38 | get_policy(Key, X) -> 39 | rabbit_policy:get(Key, X). 40 | 41 | exchange_bin(#resource{name = XBin}) -> XBin. 42 | 43 | make_queue_name(QBin, NodeBin, QNum) -> 44 | %% we do this to prevent unprintable characters in queue names 45 | QNumBin = list_to_binary(lists:flatten(io_lib:format("~p", [QNum]))), 46 | <<"sharding: ", QBin/binary, " - ", NodeBin/binary, " - ", QNumBin/binary>>. 47 | 48 | a2b(A) -> list_to_binary(atom_to_list(A)). 49 | -------------------------------------------------------------------------------- /test/src/rabbit_hash_exchange_SUITE.erl: -------------------------------------------------------------------------------- 1 | %% This Source Code Form is subject to the terms of the Mozilla Public 2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this 3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/. 4 | %% 5 | %% Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved. 6 | %% 7 | -module(rabbit_hash_exchange_SUITE). 8 | 9 | -compile(export_all). 10 | 11 | -include_lib("common_test/include/ct.hrl"). 12 | -include_lib("amqp_client/include/amqp_client.hrl"). 13 | -include_lib("eunit/include/eunit.hrl"). 14 | 15 | all() -> 16 | [ 17 | {group, non_parallel_tests} 18 | ]. 19 | 20 | groups() -> 21 | [ 22 | {non_parallel_tests, [], [ 23 | routed_to_zero_queue_test, 24 | routed_to_one_queue_test, 25 | routed_to_many_queue_test 26 | ]} 27 | ]. 28 | 29 | %% ------------------------------------------------------------------- 30 | %% Test suite setup/teardown 31 | %% ------------------------------------------------------------------- 32 | 33 | init_per_suite(Config) -> 34 | rabbit_ct_helpers:log_environment(), 35 | Config1 = rabbit_ct_helpers:set_config(Config, [ 36 | {rmq_nodename_suffix, ?MODULE} 37 | ]), 38 | rabbit_ct_helpers:run_setup_steps(Config1, 39 | rabbit_ct_broker_helpers:setup_steps() ++ 40 | rabbit_ct_client_helpers:setup_steps()). 41 | 42 | end_per_suite(Config) -> 43 | rabbit_ct_helpers:run_teardown_steps(Config, 44 | rabbit_ct_client_helpers:teardown_steps() ++ 45 | rabbit_ct_broker_helpers:teardown_steps()). 46 | 47 | init_per_group(_, Config) -> 48 | Config. 49 | 50 | end_per_group(_, Config) -> 51 | Config. 52 | 53 | init_per_testcase(Testcase, Config) -> 54 | TestCaseName = rabbit_ct_helpers:config_to_testcase_name(Config, Testcase), 55 | Config1 = rabbit_ct_helpers:set_config(Config, {test_resource_name, 56 | re:replace(TestCaseName, "/", "-", [global, {return, list}])}), 57 | rabbit_ct_helpers:testcase_started(Config1, Testcase). 58 | 59 | end_per_testcase(Testcase, Config) -> 60 | rabbit_ct_helpers:testcase_finished(Config, Testcase). 61 | 62 | %% ------------------------------------------------------------------- 63 | %% Test cases 64 | %% ------------------------------------------------------------------- 65 | 66 | routed_to_zero_queue_test(Config) -> 67 | test0(Config, fun () -> 68 | #'basic.publish'{exchange = make_exchange_name(Config, "0"), routing_key = rnd()} 69 | end, 70 | fun() -> 71 | #amqp_msg{props = #'P_basic'{}, payload = <<>>} 72 | end, [], 5, 0), 73 | 74 | passed. 75 | 76 | routed_to_one_queue_test(Config) -> 77 | test0(Config, fun () -> 78 | #'basic.publish'{exchange = make_exchange_name(Config, "0"), routing_key = rnd()} 79 | end, 80 | fun() -> 81 | #amqp_msg{props = #'P_basic'{}, payload = <<>>} 82 | end, [<<"q1">>, <<"q2">>, <<"q3">>], 1, 1), 83 | 84 | passed. 85 | 86 | routed_to_many_queue_test(Config) -> 87 | test0(Config, fun () -> 88 | #'basic.publish'{exchange = make_exchange_name(Config, "0"), routing_key = rnd()} 89 | end, 90 | fun() -> 91 | #amqp_msg{props = #'P_basic'{}, payload = <<>>} 92 | end, [<<"q1">>, <<"q2">>, <<"q3">>], 5, 5), 93 | 94 | passed. 95 | 96 | test0(Config, MakeMethod, MakeMsg, Queues, MsgCount, Count) -> 97 | {Conn, Chan} = rabbit_ct_client_helpers:open_connection_and_channel(Config, 0), 98 | E = make_exchange_name(Config, "0"), 99 | 100 | #'exchange.declare_ok'{} = 101 | amqp_channel:call(Chan, 102 | #'exchange.declare' { 103 | exchange = E, 104 | type = <<"x-modulus-hash">>, 105 | auto_delete = true 106 | }), 107 | [#'queue.declare_ok'{} = 108 | amqp_channel:call(Chan, #'queue.declare' { 109 | queue = Q, exclusive = true }) || Q <- Queues], 110 | [#'queue.bind_ok'{} = 111 | amqp_channel:call(Chan, #'queue.bind'{queue = Q, 112 | exchange = E, 113 | routing_key = <<"">>}) 114 | || Q <- Queues], 115 | 116 | amqp_channel:call(Chan, #'confirm.select'{}), 117 | 118 | [amqp_channel:call(Chan, 119 | MakeMethod(), 120 | MakeMsg()) || _ <- lists:duplicate(MsgCount, const)], 121 | 122 | % ensure that the messages have been delivered to the queues before asking 123 | % for the message count 124 | amqp_channel:wait_for_confirms_or_die(Chan), 125 | 126 | Counts = 127 | [begin 128 | #'queue.declare_ok'{message_count = M} = 129 | amqp_channel:call(Chan, #'queue.declare' {queue = Q, 130 | exclusive = true }), 131 | M 132 | end || Q <- Queues], 133 | 134 | ?assertEqual(Count, lists:sum(Counts)), 135 | 136 | amqp_channel:call(Chan, #'exchange.delete' { exchange = E }), 137 | [amqp_channel:call(Chan, #'queue.delete' { queue = Q }) || Q <- Queues], 138 | 139 | rabbit_ct_client_helpers:close_connection_and_channel(Conn, Chan), 140 | ok. 141 | 142 | rnd() -> 143 | list_to_binary(integer_to_list(rand:uniform(1000000))). 144 | 145 | make_exchange_name(Config, Suffix) -> 146 | B = rabbit_ct_helpers:get_config(Config, test_resource_name), 147 | erlang:list_to_binary("x-" ++ B ++ "-" ++ Suffix). 148 | -------------------------------------------------------------------------------- /test/src/rabbit_sharding_SUITE.erl: -------------------------------------------------------------------------------- 1 | %% This Source Code Form is subject to the terms of the Mozilla Public 2 | %% License, v. 2.0. If a copy of the MPL was not distributed with this 3 | %% file, You can obtain one at https://mozilla.org/MPL/2.0/. 4 | %% 5 | %% Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved. 6 | %% 7 | 8 | -module(rabbit_sharding_SUITE). 9 | 10 | -compile(export_all). 11 | 12 | -include_lib("common_test/include/ct.hrl"). 13 | -include_lib("eunit/include/eunit.hrl"). 14 | -include_lib("rabbit/include/amqqueue.hrl"). 15 | -include_lib("amqp_client/include/amqp_client.hrl"). 16 | 17 | -define(TEST_X, <<"sharding.test">>). 18 | 19 | -import(rabbit_sharding_util, [a2b/1, exchange_bin/1]). 20 | -import(rabbit_ct_broker_helpers, [set_parameter/5, clear_parameter/4, 21 | set_policy/6, clear_policy/3]). 22 | 23 | all() -> 24 | [ 25 | {group, non_parallel_tests} 26 | ]. 27 | 28 | groups() -> 29 | [ 30 | {non_parallel_tests, [], [ 31 | shard_empty_routing_key_test, 32 | shard_queue_creation_test, 33 | shard_queue_creation2_test, 34 | shard_update_spn_test, 35 | shard_decrease_spn_keep_queues_test, 36 | shard_update_routing_key_test, 37 | shard_basic_consume_interceptor_test, 38 | shard_auto_scale_cluster_test, 39 | queue_declare_test, 40 | shard_queue_master_locator_test 41 | ]} 42 | ]. 43 | 44 | %% ------------------------------------------------------------------- 45 | %% Test suite setup/teardown. 46 | %% ------------------------------------------------------------------- 47 | 48 | init_per_suite(Config) -> 49 | inets:start(), 50 | rabbit_ct_helpers:log_environment(), 51 | Config1 = rabbit_ct_helpers:set_config(Config, [ 52 | {rmq_nodename_suffix, ?MODULE}, 53 | {rmq_nodes_count, 2} 54 | ]), 55 | rabbit_ct_helpers:run_setup_steps(Config1, 56 | rabbit_ct_broker_helpers:setup_steps() ++ 57 | rabbit_ct_client_helpers:setup_steps()). 58 | 59 | end_per_suite(Config) -> 60 | rabbit_ct_helpers:run_teardown_steps(Config, 61 | rabbit_ct_client_helpers:teardown_steps() ++ 62 | rabbit_ct_broker_helpers:teardown_steps()). 63 | 64 | init_per_group(_, Config) -> 65 | Config. 66 | 67 | end_per_group(_, Config) -> 68 | Config. 69 | 70 | init_per_testcase(Testcase, Config) -> 71 | TestCaseName = rabbit_ct_helpers:config_to_testcase_name(Config, Testcase), 72 | rabbit_ct_helpers:set_config(Config, {test_resource_name, 73 | re:replace(TestCaseName, "/", "-", [global, {return, list}])}). 74 | 75 | end_per_testcase(_Testcase, Config) -> 76 | Config. 77 | 78 | %% ------------------------------------------------------------------- 79 | %% Test cases. 80 | %% ------------------------------------------------------------------- 81 | 82 | shard_empty_routing_key_test(Config) -> 83 | with_ch(Config, 84 | fun (Ch) -> 85 | amqp_channel:call(Ch, x_declare(?TEST_X)), 86 | set_policy(Config, 0, <<"3_shard">>, <<"^sharding">>, <<"exchanges">>, policy_definition(3)), 87 | timer:sleep(1000), 88 | ?assertEqual(6, length(queues(Config, 0))), 89 | 90 | teardown(Config, Ch, 91 | [{?TEST_X, 6}], 92 | [<<"3_shard">>]) 93 | end). 94 | 95 | shard_queue_creation_test(Config) -> 96 | with_ch(Config, 97 | fun (Ch) -> 98 | amqp_channel:call(Ch, x_declare(?TEST_X)), 99 | set_policy(Config, 0, <<"3_shard">>, <<"^sharding">>, <<"exchanges">>, policy_definition(3, <<"1234">>)), 100 | ?assertEqual(6, length(queues(Config, 0))), 101 | 102 | teardown(Config, Ch, 103 | [{?TEST_X, 6}], 104 | [<<"3_shard">>]) 105 | end). 106 | 107 | shard_queue_creation2_test(Config) -> 108 | with_ch(Config, 109 | fun (Ch) -> 110 | set_policy(Config, 0, <<"3_shard">>, <<"^sharding">>, <<"exchanges">>, policy_definition(3, <<"1234">>)), 111 | ?assertEqual(0, length(queues(Config, 0))), 112 | 113 | amqp_channel:call(Ch, x_declare(?TEST_X)), 114 | 115 | ?assertEqual(6, length(queues(Config, 0))), 116 | 117 | teardown(Config, Ch, 118 | [{?TEST_X, 6}], 119 | [<<"3_shard">>]) 120 | end). 121 | 122 | %% SPN = Shards Per Node 123 | shard_update_spn_test(Config) -> 124 | with_ch(Config, 125 | fun (Ch) -> 126 | amqp_channel:call(Ch, x_declare(?TEST_X)), 127 | set_policy(Config, 0, <<"3_shard">>, <<"^sharding">>, <<"exchanges">>, policy_definition(3, <<"1234">>)), 128 | ?assertEqual(6, length(queues(Config, 0))), 129 | 130 | set_policy(Config, 0, <<"3_shard">>, <<"^sharding">>, <<"exchanges">>, policy_definition(5, <<"1234">>)), 131 | ?assertEqual(10, length(queues(Config, 0))), 132 | 133 | teardown(Config, Ch, 134 | [{?TEST_X, 5}], 135 | [<<"3_shard">>]) 136 | end). 137 | 138 | shard_decrease_spn_keep_queues_test(Config) -> 139 | with_ch(Config, 140 | fun (Ch) -> 141 | amqp_channel:call(Ch, x_declare(?TEST_X)), 142 | set_policy(Config, 0, <<"3_shard">>, <<"^sharding">>, <<"exchanges">>, policy_definition(5, <<"1234">>)), 143 | ?assertEqual(10, length(queues(Config, 0))), 144 | 145 | set_policy(Config, 0, <<"3_shard">>, <<"^sharding">>, <<"exchanges">>, policy_definition(3, <<"1234">>)), 146 | ?assertEqual(10, length(queues(Config, 0))), 147 | 148 | teardown(Config, Ch, 149 | [{?TEST_X, 5}], 150 | [<<"3_shard">>]) 151 | end). 152 | 153 | 154 | %% changes the routing key policy, therefore the queues should be 155 | %% unbound first and then bound with the new routing key. 156 | shard_update_routing_key_test(Config) -> 157 | with_ch(Config, 158 | fun (Ch) -> 159 | amqp_channel:call(Ch, x_declare(?TEST_X)), 160 | set_policy(Config, 0, <<"rkey">>, <<"^sharding">>, <<"exchanges">>, policy_definition(3, <<"1234">>)), 161 | timer:sleep(1000), 162 | Bs = bindings(Config, 0, ?TEST_X), 163 | 164 | set_policy(Config, 0, <<"rkey">>, <<"^sharding">>, <<"exchanges">>, policy_definition(3, <<"4321">>)), 165 | timer:sleep(1000), 166 | Bs2 = bindings(Config, 0, ?TEST_X), 167 | 168 | ?assert(Bs =/= Bs2), 169 | 170 | teardown(Config, Ch, 171 | [{?TEST_X, 1}], 172 | [<<"rkey">>]) 173 | end). 174 | 175 | %% tests that the interceptor returns queue names 176 | %% sorted by consumer count and then by queue index. 177 | shard_basic_consume_interceptor_test(Config) -> 178 | with_ch(Config, 179 | fun (Ch) -> 180 | Sh = ?TEST_X, 181 | amqp_channel:call(Ch, x_declare(Sh)), 182 | set_policy(Config, 0, <<"three">>, <<"^sharding">>, <<"exchanges">>, policy_definition(3, <<"1234">>)), 183 | 184 | start_consumer(Ch, Sh), 185 | assert_consumers(Config, Sh, 0, 1), 186 | assert_consumers(Config, Sh, 1, 0), 187 | assert_consumers(Config, Sh, 2, 0), 188 | 189 | start_consumer(Ch, Sh), 190 | assert_consumers(Config, Sh, 0, 1), 191 | assert_consumers(Config, Sh, 1, 1), 192 | assert_consumers(Config, Sh, 2, 0), 193 | 194 | start_consumer(Ch, Sh), 195 | assert_consumers(Config, Sh, 0, 1), 196 | assert_consumers(Config, Sh, 1, 1), 197 | assert_consumers(Config, Sh, 2, 1), 198 | 199 | start_consumer(Ch, Sh), 200 | assert_consumers(Config, Sh, 0, 2), 201 | assert_consumers(Config, Sh, 1, 1), 202 | assert_consumers(Config, Sh, 2, 1), 203 | 204 | teardown(Config, Ch, 205 | [{?TEST_X, 6}], 206 | [<<"three">>]) 207 | end). 208 | 209 | shard_auto_scale_cluster_test(Config) -> 210 | with_ch(Config, 211 | fun (Ch) -> 212 | Sh = ?TEST_X, 213 | amqp_channel:call(Ch, x_declare(Sh)), 214 | set_policy(Config, 0, <<"three">>, <<"^sharding">>, <<"exchanges">>, policy_definition(3, <<"1234">>)), 215 | 216 | ?assertEqual(6, length(queues(Config, 0))), 217 | Qs = queues(Config, 0), 218 | 219 | ?assertEqual(6, length(Qs)), 220 | Nodes = rabbit_ct_broker_helpers:get_node_configs(Config, nodename), 221 | ?assertEqual(Nodes, lists:usort(queue_nodes(Qs))), 222 | 223 | teardown(Config, Ch, 224 | [{?TEST_X, 6}], 225 | [<<"three">>]) 226 | end). 227 | 228 | queue_declare_test(Config) -> 229 | with_ch(Config, 230 | fun (Ch) -> 231 | amqp_channel:call(Ch, x_declare(?TEST_X)), 232 | set_policy(Config, 0, <<"declare">>, <<"^sharding">>, <<"exchanges">>, policy_definition(3, <<"1234">>)), 233 | 234 | Declare = #'queue.declare'{queue = <<"sharding.test">>, 235 | auto_delete = false, 236 | durable = true}, 237 | 238 | #'queue.declare_ok'{queue = Q} = 239 | amqp_channel:call(Ch, Declare), 240 | 241 | ?assertEqual(Q, shard_q(Config, 0, xr(?TEST_X), 0)), 242 | 243 | teardown(Config, Ch, 244 | [{?TEST_X, 6}], 245 | [<<"declare">>]) 246 | end). 247 | 248 | shard_queue_master_locator_test(Config) -> 249 | with_ch(Config, 250 | fun (Ch) -> 251 | set_policy(Config, 0, <<"qml">>, <<"^sharding">>, <<"queues">>, [{<<"queue-master-locator">>, <<"client-local">>}]), 252 | amqp_channel:call(Ch, x_declare(?TEST_X)), 253 | set_policy(Config, 0, <<"3_shard">>, <<"^sharding">>, <<"exchanges">>, policy_definition(3, <<"1234">>)), 254 | 255 | [A, B] = rabbit_ct_broker_helpers:get_node_configs(Config, nodename), 256 | 257 | NodesOfQueues = [node(amqqueue:get_pid(Q)) || Q <- queues(Config, 0)], 258 | ?assertEqual(3, length(lists:filter(fun(N) -> N == A end, NodesOfQueues))), 259 | ?assertEqual(3, length(lists:filter(fun(N) -> N == B end, NodesOfQueues))), 260 | 261 | teardown(Config, Ch, 262 | [{?TEST_X, 6}], 263 | [<<"3_shard">>, <<"qml">>]) 264 | end). 265 | 266 | start_consumer(Ch, Shard) -> 267 | amqp_channel:call(Ch, #'basic.consume'{queue = Shard}). 268 | 269 | assert_consumers(Config, Shard, QInd, Count) -> 270 | Q0 = qr(shard_q(Config, 0, xr(Shard), QInd)), 271 | [{consumers, C0}] = rabbit_ct_broker_helpers:rpc(Config, 0, rabbit_sharding_interceptor, consumer_count, [Q0]), 272 | ?assertEqual(C0, Count). 273 | 274 | queues(Config, NodeIndex) -> 275 | case rabbit_ct_broker_helpers:rpc(Config, NodeIndex, rabbit_amqqueue, list, [<<"/">>]) of 276 | {badrpc, _} -> []; 277 | Qs -> Qs 278 | end. 279 | 280 | bindings(Config, NodeIndex, XName) -> 281 | case rabbit_ct_broker_helpers:rpc(Config, NodeIndex, rabbit_binding, list_for_source, [xr(XName)]) of 282 | {badrpc, _} -> []; 283 | Bs -> Bs 284 | end. 285 | 286 | with_ch(Config, Fun) -> 287 | {Conn, Ch} = rabbit_ct_client_helpers:open_connection_and_channel(Config, 0), 288 | Fun(Ch), 289 | rabbit_ct_client_helpers:close_connection_and_channel(Conn, Ch), 290 | cleanup(Config, 0), 291 | ok. 292 | 293 | cleanup(Config) -> 294 | cleanup(Config, 0). 295 | cleanup(Config, NodeIndex) -> 296 | [rabbit_ct_broker_helpers:rpc(Config, NodeIndex, rabbit_amqqueue, delete, [Q, false, false, <<"test-user">>]) 297 | || Q <- queues(Config, 0)]. 298 | 299 | teardown(Config, Ch, Xs, Policies) -> 300 | [begin 301 | amqp_channel:call(Ch, x_delete(XName)), 302 | delete_queues(Config, Ch, XName, N) 303 | end || {XName, N} <- Xs], 304 | [clear_policy(Config, 0, Policy) || Policy <- Policies]. 305 | 306 | delete_queues(Config, Ch, Name, N) -> 307 | [amqp_channel:call(Ch, q_delete(Config, Name, QInd)) || QInd <- lists:seq(0, N-1)]. 308 | 309 | x_declare(Name) -> x_declare(Name, <<"x-modulus-hash">>). 310 | 311 | x_declare(Name, Type) -> 312 | #'exchange.declare'{exchange = Name, 313 | type = Type, 314 | durable = true}. 315 | 316 | x_delete(Name) -> 317 | #'exchange.delete'{exchange = Name}. 318 | 319 | q_delete(Config, Name, QInd) -> 320 | #'queue.delete'{queue = shard_q(Config, 0, xr(Name), QInd)}. 321 | 322 | shard_q(Config, NodeIndex, X, N) -> 323 | rabbit_sharding_util:make_queue_name( 324 | exchange_bin(X), a2b(rabbit_ct_broker_helpers:get_node_config(Config, NodeIndex, nodename)), N). 325 | 326 | policy_definition(SPN) -> 327 | [{<<"shards-per-node">>, SPN}]. 328 | 329 | policy_definition(SPN, RK) -> 330 | [{<<"shards-per-node">>, SPN}, {<<"routing-key">>, RK}]. 331 | 332 | queue_nodes(Qs) -> 333 | [queue_node(Q) || Q <- Qs]. 334 | 335 | queue_node(Q) when ?is_amqqueue(Q) -> 336 | amqqueue:qnode(Q). 337 | 338 | xr(Name) -> rabbit_misc:r(<<"/">>, exchange, Name). 339 | qr(Name) -> rabbit_misc:r(<<"/">>, queue, Name). 340 | --------------------------------------------------------------------------------