2015-08-10 17:50:41 +08:00
|
|
|
PROJECT = rabbit
|
2016-12-06 19:18:02 +08:00
|
|
|
PROJECT_DESCRIPTION = RabbitMQ
|
|
|
|
|
PROJECT_MOD = rabbit
|
|
|
|
|
PROJECT_REGISTERED = rabbit_amqqueue_sup \
|
|
|
|
|
rabbit_direct_client_sup \
|
|
|
|
|
rabbit_log \
|
|
|
|
|
rabbit_node_monitor \
|
|
|
|
|
rabbit_router
|
2009-09-22 21:59:30 +08:00
|
|
|
|
2016-12-06 19:18:02 +08:00
|
|
|
define PROJECT_ENV
|
|
|
|
|
[
|
|
|
|
|
{tcp_listeners, [5672]},
|
|
|
|
|
{num_tcp_acceptors, 10},
|
|
|
|
|
{ssl_listeners, []},
|
2017-10-29 21:19:30 +08:00
|
|
|
{num_ssl_acceptors, 10},
|
2016-12-06 19:18:02 +08:00
|
|
|
{ssl_options, []},
|
|
|
|
|
{vm_memory_high_watermark, 0.4},
|
|
|
|
|
{vm_memory_high_watermark_paging_ratio, 0.5},
|
2017-10-19 05:33:39 +08:00
|
|
|
{vm_memory_calculation_strategy, rss},
|
2016-12-06 19:18:02 +08:00
|
|
|
{memory_monitor_interval, 2500},
|
|
|
|
|
{disk_free_limit, 50000000}, %% 50MB
|
|
|
|
|
{msg_store_index_module, rabbit_msg_store_ets_index},
|
|
|
|
|
{backing_queue_module, rabbit_variable_queue},
|
|
|
|
|
%% 0 ("no limit") would make a better default, but that
|
|
|
|
|
%% breaks the QPid Java client
|
|
|
|
|
{frame_max, 131072},
|
2018-05-09 23:06:20 +08:00
|
|
|
%% see rabbitmq-server#1593
|
2018-05-10 01:39:19 +08:00
|
|
|
{channel_max, 2047},
|
2017-10-21 00:30:56 +08:00
|
|
|
{connection_max, infinity},
|
2016-12-06 19:18:02 +08:00
|
|
|
{heartbeat, 60},
|
|
|
|
|
{msg_store_file_size_limit, 16777216},
|
2020-06-04 01:36:17 +08:00
|
|
|
{msg_store_shutdown_timeout, 600000},
|
2016-12-06 19:18:02 +08:00
|
|
|
{fhc_write_buffering, true},
|
|
|
|
|
{fhc_read_buffering, false},
|
|
|
|
|
{queue_index_max_journal_entries, 32768},
|
|
|
|
|
{queue_index_embed_msgs_below, 4096},
|
|
|
|
|
{default_user, <<"guest">>},
|
|
|
|
|
{default_pass, <<"guest">>},
|
|
|
|
|
{default_user_tags, [administrator]},
|
|
|
|
|
{default_vhost, <<"/">>},
|
|
|
|
|
{default_permissions, [<<".*">>, <<".*">>, <<".*">>]},
|
|
|
|
|
{loopback_users, [<<"guest">>]},
|
|
|
|
|
{password_hashing_module, rabbit_password_hashing_sha256},
|
|
|
|
|
{server_properties, []},
|
|
|
|
|
{collect_statistics, none},
|
|
|
|
|
{collect_statistics_interval, 5000},
|
|
|
|
|
{mnesia_table_loading_retry_timeout, 30000},
|
|
|
|
|
{mnesia_table_loading_retry_limit, 10},
|
|
|
|
|
{auth_mechanisms, ['PLAIN', 'AMQPLAIN']},
|
|
|
|
|
{auth_backends, [rabbit_auth_backend_internal]},
|
|
|
|
|
{delegate_count, 16},
|
|
|
|
|
{trace_vhosts, []},
|
|
|
|
|
{ssl_cert_login_from, distinguished_name},
|
|
|
|
|
{ssl_handshake_timeout, 5000},
|
|
|
|
|
{ssl_allow_poodle_attack, false},
|
|
|
|
|
{handshake_timeout, 10000},
|
|
|
|
|
{reverse_dns_lookups, false},
|
|
|
|
|
{cluster_partition_handling, ignore},
|
|
|
|
|
{cluster_keepalive_interval, 10000},
|
2020-01-12 00:23:30 +08:00
|
|
|
{autoheal_state_transition_timeout, 60000},
|
2016-12-06 19:18:02 +08:00
|
|
|
{tcp_listen_options, [{backlog, 128},
|
|
|
|
|
{nodelay, true},
|
|
|
|
|
{linger, {true, 0}},
|
|
|
|
|
{exit_on_close, false}
|
|
|
|
|
]},
|
|
|
|
|
{halt_on_upgrade_failure, true},
|
|
|
|
|
{ssl_apps, [asn1, crypto, public_key, ssl]},
|
|
|
|
|
%% see rabbitmq-server#114
|
|
|
|
|
{mirroring_flow_control, true},
|
|
|
|
|
{mirroring_sync_batch_size, 4096},
|
|
|
|
|
%% see rabbitmq-server#227 and related tickets.
|
|
|
|
|
%% msg_store_credit_disc_bound only takes effect when
|
|
|
|
|
%% messages are persisted to the message store. If messages
|
|
|
|
|
%% are embedded on the queue index, then modifying this
|
|
|
|
|
%% setting has no effect because credit_flow is not used when
|
|
|
|
|
%% writing to the queue index. See the setting
|
|
|
|
|
%% queue_index_embed_msgs_below above.
|
2017-02-18 03:31:29 +08:00
|
|
|
{msg_store_credit_disc_bound, {4000, 800}},
|
|
|
|
|
{msg_store_io_batch_size, 4096},
|
2017-02-08 16:56:05 +08:00
|
|
|
%% see rabbitmq-server#143,
|
|
|
|
|
%% rabbitmq-server#949, rabbitmq-server#1098
|
2017-02-05 19:41:40 +08:00
|
|
|
{credit_flow_default_credit, {400, 200}},
|
2020-05-01 18:43:42 +08:00
|
|
|
{quorum_commands_soft_limit, 32},
|
2021-01-28 17:46:28 +08:00
|
|
|
{quorum_cluster_size, 3},
|
2016-12-06 19:18:02 +08:00
|
|
|
%% see rabbitmq-server#248
|
|
|
|
|
%% and rabbitmq-server#667
|
|
|
|
|
{channel_operation_timeout, 15000},
|
2016-12-07 22:21:58 +08:00
|
|
|
|
|
|
|
|
%% see rabbitmq-server#486
|
2017-05-24 18:03:05 +08:00
|
|
|
{autocluster,
|
|
|
|
|
[{peer_discovery_backend, rabbit_peer_discovery_classic_config}]
|
|
|
|
|
},
|
2016-12-07 22:21:58 +08:00
|
|
|
%% used by rabbit_peer_discovery_classic_config
|
|
|
|
|
{cluster_nodes, {[], disc}},
|
|
|
|
|
|
2019-04-19 22:06:07 +08:00
|
|
|
{config_entry_decoder, [{passphrase, undefined}]},
|
2016-12-07 22:21:58 +08:00
|
|
|
|
2017-07-01 11:39:03 +08:00
|
|
|
%% rabbitmq-server#973
|
2016-12-22 23:43:19 +08:00
|
|
|
{queue_explicit_gc_run_operation_threshold, 1000},
|
|
|
|
|
{lazy_queue_explicit_gc_run_operation_threshold, 1000},
|
2017-02-05 19:41:40 +08:00
|
|
|
{background_gc_enabled, false},
|
2017-02-07 18:25:20 +08:00
|
|
|
{background_gc_target_interval, 60000},
|
2017-07-01 11:39:03 +08:00
|
|
|
%% rabbitmq-server#589
|
2017-05-08 19:58:01 +08:00
|
|
|
{proxy_protocol, false},
|
2017-04-12 18:28:25 +08:00
|
|
|
{disk_monitor_failure_retries, 10},
|
2017-05-08 23:01:10 +08:00
|
|
|
{disk_monitor_failure_retry_interval, 120000},
|
2017-07-01 11:39:03 +08:00
|
|
|
%% either "stop_node" or "continue".
|
2017-07-06 20:20:18 +08:00
|
|
|
%% by default we choose to not terminate the entire node if one
|
|
|
|
|
%% vhost had to shut down, see server#1158 and server#1280
|
2017-10-27 17:30:29 +08:00
|
|
|
{vhost_restart_strategy, continue},
|
2017-10-28 06:41:30 +08:00
|
|
|
%% {global, prefetch count}
|
Quorum queues (#1706)
* Test queue.declare method with quorum type
[#154472130]
* Cosmetics
[#154472130]
* Start quorum queue
Includes ra as a rabbit dependency
[#154472152]
* Update info and list operations to use quorum queues
Basic implementation. Might need an update when more functionality
is added to the quorum queues.
[#154472152]
* Stop quorum queue
[#154472158]
* Restart quorum queue
[#154472164]
* Introduce UId in ra config to support newer version of ra
Improved ra stop
[#154472158]
* Put data inside VHost specific subdirs
[#154472164]
* Include ra in rabbit deps to support stop_app/start_app command
[#154472164]
* Stop quorum queues in `rabbit_amqqueue:stop/1`
[#154472158]
* Revert creation of fifo ets table inside rabbit
Now supported by ra
[#154472158]
* Filter quorum queues
[#154472158]
* Test restart node with quorum queues
[#154472164]
* Publish to quorum queues
[#154472174]
* Use `ra:restart_node/1`
[#154472164]
* Wait for stats to be published when querying quorum queues
[#154472174]
* Test publish and queue length after restart
[#154472174]
* Consume messages from quorum queues with basic.get
[#154472211]
* Autoack messages from quorum queues on basic.get
[#154472211]
* Fix no_ack meaning
no_ack = true is equivalent to autoack
[#154472211]
* Use data_dir as provided in the config
If we modify the data_dir, ra is not able to delete the data
when a queue is deleted
[#154472158]
* Remove unused code/variables
[#154472158]
* Subscribe to a quorum queue
Supports auto-ack
[#154472215]
* Ack messages consumed from quorum queues
[#154472221]
* Nack messages consumed from quorum queues
[#154804608]
* Use delivery tag as consumer tag for basic.get in quorum queues
[#154472221]
* Support for publisher confirms in quorum queues
[#154472198]
* Integrate with ra_fifo_client
* Clear queue state on queue.delete
[#154472158]
* Fix quorum nack
[#154804608]
* Test redelivery after nack
[#154804608]
* Nack without requeueing
[#154472225]
* Test multiple acks
[#154804208]
* Test multiple nacks
[#154804314]
* Configure dead letter exchange with queue declare
[#155076661]
* Use a per-vhost process to handle dead-lettering
Needs to hold state for quorum queues
[#155401802]
* Implement dead-lettering on nack'ed messages
[#154804620]
* Use queue name as a resource on message delivery
Fixes a previously introduced bug
[#154804608]
* Handle ra events on dead letter process
[#155401802]
* Pass empty queue states to queue delete
Queue deletion on vhost deletion calls directly to rabbit_amqqueue.
Queue states are not available, but we can provide an empty map as
in deletion the states are only needed for cleanup.
* Generate quorum queue stats and events
Consumer delete events are still pending, as depend on basic.cancel
(not implemented yet), ra terminating or ra detecting channel down
[#154472241]
* Ensure quorum mapping entries are available before metric emission
[#154472241]
* Configure data_dir, uses new RABBITMQ_QUORUM_BASE env var
[#154472152]
* Use untracked enqueues when sending wihtout channel
Updated several other calls missed during the quorum implementation
* Revert "Configure data_dir, uses new RABBITMQ_QUORUM_BASE env var"
This reverts commit f2261212410affecb238fcbd1fb451381aee4036.
* Configure data_dir, uses new RABBITMQ_QUORUM_DIR based on mnesia dir
[#154472152]
* Fix get_quorum_state
* Fix calculation of quorum pids
* Move all quorum queues code to its own module
[#154472241]
* Return an error when declaring a quorum queue with an incompatible argument
[#154521696]
* Cleanup of quorum queue state after queue delete
Also fixes some existing problems where the state wasn't properly
stored
[#155458625]
* Revert Revert "Declare a quorum queue using the queue.declare method"
* Remove duplicated state info
[#154472241]
* Start/stop multi-node quorum queue
[#154472231]
[#154472236]
* Restart nodes in a multi-node quorum cluster
[#154472238]
* Test restart and leadership takeover on multiple nodes
[#154472238]
* Wait for leader down after deleting a quorum cluster
It ensures an smooth delete-declare sequence without race
conditions. The test included here detected the situation before
the fix.
[#154472236]
* Populate quorum_mapping from mnesia when not available
Ensures that leader nodes that don't have direct requests can get
the mapping ra name -> queue name
* Cosmetics
* Do not emit core metrics if queue has just been deleted
* Use rabbit_mnesia:is_process_alive
Fixes bug introduced by cac9583e1bb2705be7f06c2ab7f416a75d11c875
[#154472231]
* Only try to report stats if quorum process is alive
* Implement cancel consumer callback
Deletes metrics and sends consumer deleted event
* Remove unnecessary trigger election call
ra:restart_node has already been called during the recovery
* Apply cancellation callback on node hosting the channel
* Cosmetics
* Read new fifo metrics which store directly total, ready and unack
* Implement basic.cancel for quorum queues
* Store leader in amqqueue record, report all in stats
[#154472407]
* Declare quorum queue in mnesia before starting the ra cluster
Record needs to be stored first to update the leader on ra effects
* Revert
* Purge quorum queues
[#154472182]
* Improve use of untracked_enqueue
Choose the persisted leader id instead of just using the id of the
leader at point of creation.
* Store quorum leader in the pid field of amqqueue record
Same as mirrored queues, no real need for an additional field
* Improve recovery
When a ra node has never been started on a rabbit node ensure it doesn't
fail but instead rebuilds the config and starts the node as a new node.
Also fix issue when a quorum queue is declared when one of it's rabbit
nodes are unavailable.
[#157054606]
* Cleanup core metrics after leader change
[#157054473]
* Return an error on sync_queue on quorum queues
[#154472334]
* Return an error on cancel_sync_queue on quorum queues
[#154472337]
* Fix basic_cancel and basic_consume return values
Ensure the quorum queue state is always returned by these functions.
* Restore arity of amqqeueu delete and purge functions.
This avoids some breaking changes in the cli.
* Fix bug returning consumers.
* remove rogue debug log
* Integrate ingress flow control with quorum queues
[#157000583]
* Configure commands soft limit
[#157000583]
* Support quorum pids on rabbit_mnesia:is_process_alive
* Publish consumers metric for quorum queues
* Whitelist quorum directory in is_virgin_node
Allow the quorum directoy to exist without affecting the status of the
Rabbit node.
* Delete queue_metrics on leader change.
Also run the become_leader handler in a separate process to avoid
blocking.
[#157424225]
* Report cluster status in quorum queue infos. New per node status command.
Related to
[#157146500]
* Remove quorum_mapping table
As we can store the full queue name resource as the cluster id of the
ra_fifo_client state we can avoid needed the quorum_mapping table.
* Fix xref issue
* Provide quorum members information in stats
[#157146500]
* fix unused variable
* quorum queue multiple declare handling
Extend rabbit_amqqueue:internal_declare/2 to indicate if the queue
record was created or exisiting. From this we can then provide a code
path that should handle concurrent queue declares of the same quorum
queue.
* Return an error when declaring exclusive/auto-delete quorum queue
[#157472160]
* Restore lost changes
from 79c9bd201e1eac006a42bd162e7c86df96496629
* recover another part of commit
* fixup cherry pick
* Ra io/file metrics handler and stats publishing
[#157193081]
* Revert "Ra io/file metrics handler and stats publishing"
This reverts commit 05d15c786540322583fc655709825db215b70952.
* Do not issue confirms on node down for quorum queues.
Only a ra_event should be used to issue positive confirms for a quorum
queue.
* Ra stats publishing
[#157193081]
* Pick consumer utilisation from ra data
[#155402726]
* Handle error when deleting a quorum queue and all nodes are already down
This is in fact a successful deletion as all raft nodes are already 'stopped'
[#158656366]
* Return an error when declaring non-durable quorum queues
[#158656454]
* Rename dirty_query to committed_query
* Delete stats on leader node
[#158661152]
* Give full list of nodes to fifo client
* Handle timeout in quorum basic_get
* Fix unused variable error
* Handle timeout in basic get
[#158656366]
* Force GC after purge
[#158789389]
* Increase `ra:delete_cluster` timeout to 120s
* Revert "Force GC after purge"
This reverts commit 5c98bf22994eb39004760799d3a2c5041d16e9d4.
* Add quorum member command
[#157481599]
* Delete quorum member command
[#157481599]
* Implement basic.recover for quorum queues
[#157597411]
* Change concumer utilisation
to use the new ra_fifo table and api.
* Set max quorum queue size limit
Defaults to 7, can be configured per queue on queue.declare
Nodes are selected randomly from the list of nodes, but the one
that is executing the queue.declare command
[#159338081]
* remove potentially unrelated changes to rabbit_networking
* Move ra_fifo to rabbit
Copied ra_fifo to rabbit and renamed it rabbit_fifo.
[#159338031]
* rabbit_fifo tidy up
* rabbit_fifo tidy up
* rabbit_fifo: customer -> consumer rename
* Move ra_fifo tests
[#159338031]
* Tweak quorum_queue defaults
* quorum_queue test reliability
* Optimise quorum_queue test suite.
By only starting a rabbit cluster per group rather than test.
[#160612638]
* Renamings in line with ra API changes
* rabbit_fifo fixes
* Update with ra API changes
Ra has consolidated and simplified it's api. These changes update to
confirm to that.
* Update rabbit_fifo with latest ra changes
* Clean up out of date comment
* Return map of states
* Add test case for basic.get on an empty queue
Before the previous patch, any subsequent basic.get would crash as
the map of states had been replaced by a single state.
* Clarify use of deliver tags on record_sent
* Clean up queues after testcase
* Remove erlang monitor of quorum queues in rabbit_channel
The eol event can be used instead
* Use macros to make clearer distinctions between quorum/classic queues
Cosmetic only
* Erase queue stats on 'eol' event
* Update to follow Ra's cluster_id -> cluster_name rename.
* Rename qourum-cluster-size
To quorum-initial-group-size
* Issue confirms on quorum queue eol
Also avoid creating quorum queue session state on queue operation
methods.
* Only classic queues should be notified on channel down
* Quorum queues do not support global qos
Exit with protocol error of a basic.consume for a quorum queue is issued
on a channel with global qos enabled.
* unused variable name
* Refactoring
Strictly enfornce that channels do not monitor quorum queues.
* Refactor foreach_per_queue in the channel.
To make it call classic and quorum queues the same way.
[#161314899]
* rename function
* Query classic and quorum queues separately
during recovery as they should not be marked as stopped during failed
vhost recovery.
* Remove force_event_refresh function
As the only user of this function, the management API no longer requires
it.
* fix errors
* Remove created_at from amqqueue record
[#161343680]
* rabbit_fifo: support AMQP 1.0 consumer credit
This change implements an alternative consumer credit mechanism similar
to AMQP 1.0 link credit where the credit (prefetch) isn't automatically
topped up as deliveries are settled and instead needs to be manually
increased using a credit command. This is to be integrated with the AMQP
1.0 plugin.
[#161256187]
* Add basic.credit support for quorum queues.
Added support for AMQP 1.0 transfer flow control.
[#161256187]
* Make quorum queue recover idempotent
So that if a vhost crashes and runs the recover steps it doesn't fail
because ra servers are still running.
[#161343651]
* Add tests for vhost deletion
To ensure quorum queues are cleaned up on vhost removal.
Also fix xref issue.
[#161343673]
* remove unused clause
* always return latest value of queue
* Add rabbitmq-queues scripts. Remove ra config from .bat scripts.
* Return error if trying to get quorum status of a classic queue.
2018-10-29 17:47:29 +08:00
|
|
|
{default_consumer_prefetch, {false, 0}},
|
2019-04-08 23:12:26 +08:00
|
|
|
%% interval at which the channel can perform periodic actions
|
|
|
|
|
{channel_tick_interval, 60000},
|
2018-12-27 23:26:37 +08:00
|
|
|
%% Default max message size is 128 MB
|
2019-12-12 06:11:15 +08:00
|
|
|
{max_message_size, 134217728},
|
2019-12-20 13:02:51 +08:00
|
|
|
%% Socket writer will run GC every 1 GB of outgoing data
|
2020-06-10 17:10:48 +08:00
|
|
|
{writer_gc_threshold, 1000000000},
|
|
|
|
|
%% interval at which connection/channel tracking executes post operations
|
2020-09-29 18:43:24 +08:00
|
|
|
{tracking_execution_timeout, 15000},
|
2020-08-26 22:42:40 +08:00
|
|
|
{stream_messages_soft_limit, 256},
|
2020-09-18 23:11:13 +08:00
|
|
|
{track_auth_attempt_source, false}
|
2016-12-06 19:18:02 +08:00
|
|
|
]
|
|
|
|
|
endef
|
|
|
|
|
|
Move most of shell scripts to Erlang code
A large part of the rabbitmq-server(8) and CLI scripts, both
Bourne-shell and Windows Batch versions, was moved to Erlang code and
the RabbitMQ startup procedure was reorganized to be closer to a regular
Erlang application.
A new application called `rabbitmq_prelaunch` is responsible for:
1. Querying the environment variables to initialize important
variables (using the new `rabbit_env` module in rabbitmq-common).
2. Checking the compatibility with the Erlang/OTP runtime.
3. Configuring Erlang distribution.
5. Writing the PID file.
The application is started early (i.e. it is started before `rabbit`).
The `rabbit` application runs the second half of the prelaunch sequence
at the beginning of the application `start()` function. This second
phase is responsible for the following steps:
1. Preparing the feature flags registry.
2. Reading and validating the configuration.
3. Configuring logging.
4. Running the various cluster checks.
In addition to this prelaunch sequence, the `rabbit` application start
procedure ends with a "postlaunch" sequence which takes care of
starting enabled plugins.
Thanks to this, RabbitMQ can be started with `application:start(rabbit)`
as any other Erlang application. The only caveats are:
* Mnesia must be stopped at the time `rabbit_prelaunch` is started,
and must remain stopped when `rabbit` is started, to allow the
Erlang distribution setup and cluster checks. `rabbit` takes care of
starting Mnesia.
* Likewise for Ra, because it relies on the `ra` application
environment to be configured.
Transitioning from scripts to Erlang code has the following benefits:
* RabbitMQ start behavior should be identical between Unix and
Windows. Also, features should be on par now. For instance, RabbitMQ
now writes a PID file on Windows, like it always did on Unix-based
systems.
* The difference between published packages and a development
environment are greatly reduced. In fact, we removed all the "if
this is a dev working copy, then ..." blocks.
As part of that, the `rabbit` application is now treated like its
plugins: it is packaged as an `.ez` archive and written to the
`plugins` directory (even though it is not technically a plugin).
Also in a development copy, the CLI is copied to the top-level
project. So when testing a plugin for instance, the CLI to use is
`sbin/rabbitmqctl` in the current directory, not the master copy in
`rabbit/scripts`.
* As a consequence of the previous two points, maintaining and testing
on Windows is now made easy. It should even be possible to setup CI
on Windows.
* There are less issues with paths containing non-US-ASCII characters,
which can happen on Windows because RabbitMQ stores its data in user
directories by default.
This process brings at least one more benefit: we now have early logging
during this prelaunch phase, which eases diagnostics and debugging.
There are also behavior changes:
* The new format configuration files used to be converted to an
Erlang-term-based file by the Cuttlefish CLI. To do that,
configuration schemas were copied to a temporary directory and the
generated configuration file was written to RabbitMQ data directory.
Now, Cuttlefish is used as a library: everything happens in memory.
No schemas are copied, no generated configuration is written to
disk.
* The PID file is removed when the Erlang VM exits.
* The `rabbit_config` module was trimmed significantly because most of
the configuration handling is done in `rabbit_prelaunch_conf` now.
* The RabbitMQ nodename does not appear on the command line, therefore
it is missing from ps(1) and top(1) output.
* The `rabbit:start()` function will probably behave differently in
some ways because it defers everything to the Erlang application
controller (instead of reimplementing it).
2019-05-15 22:27:51 +08:00
|
|
|
# With Erlang.mk default behavior, the value of `$(APPS_DIR)` is always
|
|
|
|
|
# relative to the top-level executed Makefile. In our case, it could be
|
|
|
|
|
# a plugin for instance. However, the rabbitmq_prelaunch application is
|
|
|
|
|
# in this repository, not the plugin's. That's why we need to override
|
|
|
|
|
# this value here.
|
|
|
|
|
APPS_DIR := $(CURDIR)/apps
|
|
|
|
|
|
|
|
|
|
LOCAL_DEPS = sasl rabbitmq_prelaunch os_mon inets compiler public_key crypto ssl syntax_tools xmerl
|
2018-10-10 07:17:35 +08:00
|
|
|
BUILD_DEPS = rabbitmq_cli syslog
|
2020-09-29 18:43:24 +08:00
|
|
|
DEPS = cuttlefish ranch lager rabbit_common ra sysmon_handler stdout_formatter recon observer_cli osiris amqp10_common
|
2016-11-24 17:12:30 +08:00
|
|
|
TEST_DEPS = rabbitmq_ct_helpers rabbitmq_ct_client_helpers amqp_client meck proper
|
Use Lager to log RabbitMQ messages
By default, RabbitMQ now logs messages to a single file
($RABBITMQ_LOGS). The $RABBITMQ_SASL_LOGS variable is unused. To
configure how and which messages are logged, it's recommended to do it
from rabbitmq.config, not from the environment variable.
The old `log_levels` parameter is unsupported and categories are
replaced by Lager extra sinks. If you had in your rabbitmq.config:
{rabbit, [
{log_levels, [{connection, info}]}
]}
You can now configure Lager like this:
{lager, [
{extra_sinks, [
{rabbit_connection_lager_event, [
{handlers, [{lager_forwarder_backend, [lager_event, info]}]}
]}
]}
]}
rabbitmq-build.mk from rabbitmq-common is included in the top-level
Makefile. It sets the appropriate compiler options to enable Lager's
lager_transform parse_transform module.
rabbit_log calls are now converted by this parse_transform to direct
calls to lager:log(). To keep backward compatibility with other plugins,
the rabbit_log module still implements all the <level>() functions.
Compared to the parse_transformed calls, the main difference is the
logged message does not carry the file:line metadata.
Fixes #94.
2015-12-05 01:07:00 +08:00
|
|
|
|
2020-11-02 18:40:24 +08:00
|
|
|
PLT_APPS += mnesia
|
|
|
|
|
|
2021-03-07 21:11:19 +08:00
|
|
|
dep_cuttlefish = hex 2.7.0
|
2018-10-10 07:17:35 +08:00
|
|
|
dep_syslog = git https://github.com/schlagert/syslog 3.4.5
|
2020-09-29 18:43:24 +08:00
|
|
|
dep_osiris = git https://github.com/rabbitmq/osiris master
|
2018-05-17 01:17:49 +08:00
|
|
|
|
2015-08-25 22:53:21 +08:00
|
|
|
define usage_xml_to_erl
|
|
|
|
|
$(subst __,_,$(patsubst $(DOCS_DIR)/rabbitmq%.1.xml, src/rabbit_%_usage.erl, $(subst -,_,$(1))))
|
|
|
|
|
endef
|
|
|
|
|
|
|
|
|
|
DOCS_DIR = docs
|
2017-04-25 16:50:00 +08:00
|
|
|
MANPAGES = $(wildcard $(DOCS_DIR)/*.[0-9])
|
|
|
|
|
WEB_MANPAGES = $(patsubst %,%.html,$(MANPAGES))
|
2016-11-07 20:03:18 +08:00
|
|
|
|
2017-05-16 22:58:03 +08:00
|
|
|
DEP_EARLY_PLUGINS = rabbit_common/mk/rabbitmq-early-test.mk
|
Use Lager to log RabbitMQ messages
By default, RabbitMQ now logs messages to a single file
($RABBITMQ_LOGS). The $RABBITMQ_SASL_LOGS variable is unused. To
configure how and which messages are logged, it's recommended to do it
from rabbitmq.config, not from the environment variable.
The old `log_levels` parameter is unsupported and categories are
replaced by Lager extra sinks. If you had in your rabbitmq.config:
{rabbit, [
{log_levels, [{connection, info}]}
]}
You can now configure Lager like this:
{lager, [
{extra_sinks, [
{rabbit_connection_lager_event, [
{handlers, [{lager_forwarder_backend, [lager_event, info]}]}
]}
]}
]}
rabbitmq-build.mk from rabbitmq-common is included in the top-level
Makefile. It sets the appropriate compiler options to enable Lager's
lager_transform parse_transform module.
rabbit_log calls are now converted by this parse_transform to direct
calls to lager:log(). To keep backward compatibility with other plugins,
the rabbit_log module still implements all the <level>() functions.
Compared to the parse_transformed calls, the main difference is the
logged message does not carry the file:line metadata.
Fixes #94.
2015-12-05 01:07:00 +08:00
|
|
|
DEP_PLUGINS = rabbit_common/mk/rabbitmq-build.mk \
|
2015-12-01 23:17:49 +08:00
|
|
|
rabbit_common/mk/rabbitmq-dist.mk \
|
2017-01-31 18:24:05 +08:00
|
|
|
rabbit_common/mk/rabbitmq-run.mk \
|
2017-03-07 19:41:32 +08:00
|
|
|
rabbit_common/mk/rabbitmq-test.mk \
|
2020-11-17 22:29:05 +08:00
|
|
|
rabbit_common/mk/rabbitmq-tools.mk
|
2015-08-26 00:34:52 +08:00
|
|
|
|
2015-09-08 20:46:46 +08:00
|
|
|
# FIXME: Use erlang.mk patched for RabbitMQ, while waiting for PRs to be
|
|
|
|
|
# reviewed and merged.
|
|
|
|
|
|
2015-09-15 00:04:59 +08:00
|
|
|
ERLANG_MK_REPO = https://github.com/rabbitmq/erlang.mk.git
|
|
|
|
|
ERLANG_MK_COMMIT = rabbitmq-tmp
|
2015-09-08 20:46:46 +08:00
|
|
|
|
2015-09-24 17:47:26 +08:00
|
|
|
include rabbitmq-components.mk
|
2015-08-10 17:50:41 +08:00
|
|
|
include erlang.mk
|
2010-06-09 19:41:46 +08:00
|
|
|
|
Move most of shell scripts to Erlang code
A large part of the rabbitmq-server(8) and CLI scripts, both
Bourne-shell and Windows Batch versions, was moved to Erlang code and
the RabbitMQ startup procedure was reorganized to be closer to a regular
Erlang application.
A new application called `rabbitmq_prelaunch` is responsible for:
1. Querying the environment variables to initialize important
variables (using the new `rabbit_env` module in rabbitmq-common).
2. Checking the compatibility with the Erlang/OTP runtime.
3. Configuring Erlang distribution.
5. Writing the PID file.
The application is started early (i.e. it is started before `rabbit`).
The `rabbit` application runs the second half of the prelaunch sequence
at the beginning of the application `start()` function. This second
phase is responsible for the following steps:
1. Preparing the feature flags registry.
2. Reading and validating the configuration.
3. Configuring logging.
4. Running the various cluster checks.
In addition to this prelaunch sequence, the `rabbit` application start
procedure ends with a "postlaunch" sequence which takes care of
starting enabled plugins.
Thanks to this, RabbitMQ can be started with `application:start(rabbit)`
as any other Erlang application. The only caveats are:
* Mnesia must be stopped at the time `rabbit_prelaunch` is started,
and must remain stopped when `rabbit` is started, to allow the
Erlang distribution setup and cluster checks. `rabbit` takes care of
starting Mnesia.
* Likewise for Ra, because it relies on the `ra` application
environment to be configured.
Transitioning from scripts to Erlang code has the following benefits:
* RabbitMQ start behavior should be identical between Unix and
Windows. Also, features should be on par now. For instance, RabbitMQ
now writes a PID file on Windows, like it always did on Unix-based
systems.
* The difference between published packages and a development
environment are greatly reduced. In fact, we removed all the "if
this is a dev working copy, then ..." blocks.
As part of that, the `rabbit` application is now treated like its
plugins: it is packaged as an `.ez` archive and written to the
`plugins` directory (even though it is not technically a plugin).
Also in a development copy, the CLI is copied to the top-level
project. So when testing a plugin for instance, the CLI to use is
`sbin/rabbitmqctl` in the current directory, not the master copy in
`rabbit/scripts`.
* As a consequence of the previous two points, maintaining and testing
on Windows is now made easy. It should even be possible to setup CI
on Windows.
* There are less issues with paths containing non-US-ASCII characters,
which can happen on Windows because RabbitMQ stores its data in user
directories by default.
This process brings at least one more benefit: we now have early logging
during this prelaunch phase, which eases diagnostics and debugging.
There are also behavior changes:
* The new format configuration files used to be converted to an
Erlang-term-based file by the Cuttlefish CLI. To do that,
configuration schemas were copied to a temporary directory and the
generated configuration file was written to RabbitMQ data directory.
Now, Cuttlefish is used as a library: everything happens in memory.
No schemas are copied, no generated configuration is written to
disk.
* The PID file is removed when the Erlang VM exits.
* The `rabbit_config` module was trimmed significantly because most of
the configuration handling is done in `rabbit_prelaunch_conf` now.
* The RabbitMQ nodename does not appear on the command line, therefore
it is missing from ps(1) and top(1) output.
* The `rabbit:start()` function will probably behave differently in
some ways because it defers everything to the Erlang application
controller (instead of reimplementing it).
2019-05-15 22:27:51 +08:00
|
|
|
# See above why we mess with `$(APPS_DIR)`.
|
|
|
|
|
unexport APPS_DIR
|
|
|
|
|
|
2017-08-23 01:18:05 +08:00
|
|
|
ifeq ($(strip $(BATS)),)
|
|
|
|
|
BATS := $(ERLANG_MK_TMP)/bats/bin/bats
|
|
|
|
|
endif
|
|
|
|
|
|
|
|
|
|
BATS_GIT ?= https://github.com/sstephenson/bats
|
|
|
|
|
BATS_COMMIT ?= v0.4.0
|
|
|
|
|
|
|
|
|
|
$(BATS):
|
|
|
|
|
$(verbose) mkdir -p $(ERLANG_MK_TMP)
|
|
|
|
|
$(gen_verbose) git clone --depth 1 --branch=$(BATS_COMMIT) $(BATS_GIT) $(ERLANG_MK_TMP)/bats
|
|
|
|
|
|
|
|
|
|
.PHONY: bats
|
|
|
|
|
|
|
|
|
|
bats: $(BATS)
|
|
|
|
|
$(verbose) $(BATS) $(TEST_DIR)
|
|
|
|
|
|
|
|
|
|
tests:: bats
|
|
|
|
|
|
2017-03-09 16:55:15 +08:00
|
|
|
SLOW_CT_SUITES := backing_queue \
|
2020-01-22 22:50:24 +08:00
|
|
|
channel_interceptor \
|
|
|
|
|
cluster \
|
2017-03-09 16:55:15 +08:00
|
|
|
cluster_rename \
|
|
|
|
|
clustering_management \
|
2019-01-08 21:19:18 +08:00
|
|
|
config_schema \
|
2020-01-22 22:50:24 +08:00
|
|
|
confirms_rejects \
|
|
|
|
|
consumer_timeout \
|
|
|
|
|
crashing_queues \
|
2017-03-09 16:55:15 +08:00
|
|
|
dynamic_ha \
|
2020-01-22 22:50:24 +08:00
|
|
|
dynamic_qq \
|
2017-03-09 16:55:15 +08:00
|
|
|
eager_sync \
|
2019-03-01 22:59:02 +08:00
|
|
|
feature_flags \
|
2017-03-09 16:55:15 +08:00
|
|
|
health_check \
|
2019-01-08 21:19:18 +08:00
|
|
|
lazy_queue \
|
2020-01-22 22:50:24 +08:00
|
|
|
many_node_ha \
|
2019-01-08 21:19:18 +08:00
|
|
|
metrics \
|
|
|
|
|
msg_store \
|
2017-03-09 16:55:15 +08:00
|
|
|
partitions \
|
2019-01-08 21:19:18 +08:00
|
|
|
per_user_connection_tracking \
|
|
|
|
|
per_vhost_connection_limit \
|
2020-01-22 22:50:24 +08:00
|
|
|
per_vhost_connection_limit_partitions \
|
2019-01-08 22:01:18 +08:00
|
|
|
per_vhost_msg_store \
|
2019-01-08 21:19:18 +08:00
|
|
|
per_vhost_queue_limit \
|
|
|
|
|
policy \
|
2017-03-09 16:55:15 +08:00
|
|
|
priority_queue \
|
2020-01-22 22:50:24 +08:00
|
|
|
priority_queue_recovery \
|
|
|
|
|
publisher_confirms_parallel \
|
2017-03-09 16:55:15 +08:00
|
|
|
queue_master_location \
|
2020-01-22 22:50:24 +08:00
|
|
|
queue_parallel \
|
2019-01-08 21:19:18 +08:00
|
|
|
quorum_queue \
|
|
|
|
|
rabbit_core_metrics_gc \
|
2019-01-08 22:01:18 +08:00
|
|
|
rabbit_fifo_prop \
|
2020-01-22 22:50:24 +08:00
|
|
|
rabbitmq_queues_cli_integration \
|
|
|
|
|
rabbitmqctl_integration \
|
2019-01-08 21:19:18 +08:00
|
|
|
simple_ha \
|
|
|
|
|
sync_detection \
|
2020-01-22 22:50:24 +08:00
|
|
|
unit_inbroker_non_parallel \
|
2019-01-08 21:19:18 +08:00
|
|
|
unit_inbroker_parallel \
|
|
|
|
|
vhost
|
2017-03-09 16:55:15 +08:00
|
|
|
FAST_CT_SUITES := $(filter-out $(sort $(SLOW_CT_SUITES)),$(CT_SUITES))
|
2017-03-07 19:41:32 +08:00
|
|
|
|
|
|
|
|
ct-fast: CT_SUITES = $(FAST_CT_SUITES)
|
|
|
|
|
ct-slow: CT_SUITES = $(SLOW_CT_SUITES)
|
|
|
|
|
|
2015-08-27 23:12:32 +08:00
|
|
|
# --------------------------------------------------------------------
|
|
|
|
|
# Compilation.
|
|
|
|
|
# --------------------------------------------------------------------
|
|
|
|
|
|
2015-08-25 23:46:35 +08:00
|
|
|
RMQ_ERLC_OPTS += -I $(DEPS_DIR)/rabbit_common/include
|
2010-03-23 19:23:55 +08:00
|
|
|
|
2015-08-10 17:50:41 +08:00
|
|
|
ifdef INSTRUMENT_FOR_QC
|
2015-08-14 18:21:42 +08:00
|
|
|
RMQ_ERLC_OPTS += -DINSTR_MOD=gm_qc
|
2010-03-23 19:23:55 +08:00
|
|
|
else
|
2015-08-14 18:21:42 +08:00
|
|
|
RMQ_ERLC_OPTS += -DINSTR_MOD=gm
|
2010-03-23 19:23:55 +08:00
|
|
|
endif
|
|
|
|
|
|
2015-08-10 17:50:41 +08:00
|
|
|
ifdef CREDIT_FLOW_TRACING
|
2015-08-14 18:21:42 +08:00
|
|
|
RMQ_ERLC_OPTS += -DCREDIT_FLOW_TRACING=true
|
2015-08-10 17:50:41 +08:00
|
|
|
endif
|
|
|
|
|
|
2018-10-25 00:19:01 +08:00
|
|
|
ifdef DEBUG_FF
|
|
|
|
|
RMQ_ERLC_OPTS += -DDEBUG_QUORUM_QUEUE_FF=true
|
|
|
|
|
endif
|
|
|
|
|
|
2015-08-10 17:50:41 +08:00
|
|
|
ifndef USE_PROPER_QC
|
|
|
|
|
# PropEr needs to be installed for property checking
|
|
|
|
|
# http://proper.softlab.ntua.gr/
|
2015-10-27 21:29:08 +08:00
|
|
|
USE_PROPER_QC := $(shell $(ERL) -eval 'io:format({module, proper} =:= code:ensure_loaded(proper)), halt().')
|
2015-08-14 18:21:42 +08:00
|
|
|
RMQ_ERLC_OPTS += $(if $(filter true,$(USE_PROPER_QC)),-Duse_proper_qc)
|
2015-08-10 17:50:41 +08:00
|
|
|
endif
|
2015-08-14 00:48:53 +08:00
|
|
|
|
|
|
|
|
# --------------------------------------------------------------------
|
2015-08-14 01:01:27 +08:00
|
|
|
# Documentation.
|
2015-08-14 00:48:53 +08:00
|
|
|
# --------------------------------------------------------------------
|
|
|
|
|
|
2015-10-07 00:48:45 +08:00
|
|
|
.PHONY: manpages web-manpages distclean-manpages
|
|
|
|
|
|
|
|
|
|
docs:: manpages web-manpages
|
|
|
|
|
|
|
|
|
|
manpages: $(MANPAGES)
|
|
|
|
|
@:
|
|
|
|
|
|
|
|
|
|
web-manpages: $(WEB_MANPAGES)
|
|
|
|
|
@:
|
2015-08-14 00:48:53 +08:00
|
|
|
|
2017-04-25 16:50:00 +08:00
|
|
|
# We use mandoc(1) to convert manpages to HTML plus an awk script which
|
|
|
|
|
# does:
|
|
|
|
|
# 1. remove tables at the top and the bottom (they recall the
|
|
|
|
|
# manpage name, section and date)
|
|
|
|
|
# 2. "downgrade" headers by one level (eg. h1 -> h2)
|
|
|
|
|
# 3. annotate .Dl lines with more CSS classes
|
|
|
|
|
%.html: %
|
|
|
|
|
$(gen_verbose) mandoc -T html -O 'fragment,man=%N.%S.html' "$<" | \
|
|
|
|
|
awk '\
|
|
|
|
|
/^<table class="head">$$/ { remove_table=1; next; } \
|
|
|
|
|
/^<table class="foot">$$/ { remove_table=1; next; } \
|
|
|
|
|
/^<\/table>$$/ { if (remove_table) { remove_table=0; next; } } \
|
|
|
|
|
{ if (!remove_table) { \
|
|
|
|
|
line=$$0; \
|
|
|
|
|
gsub(/<h2/, "<h3", line); \
|
|
|
|
|
gsub(/<\/h2>/, "</h3>", line); \
|
|
|
|
|
gsub(/<h1/, "<h2", line); \
|
|
|
|
|
gsub(/<\/h1>/, "</h2>", line); \
|
2019-01-31 10:08:57 +08:00
|
|
|
gsub(/class="D1"/, "class=\"D1 lang-bash\"", line); \
|
|
|
|
|
gsub(/class="Bd Bd-indent"/, "class=\"Bd Bd-indent lang-bash\"", line); \
|
2019-09-05 06:53:01 +08:00
|
|
|
gsub(/&#[xX]201[cCdD];/, "\\"", line); \
|
2017-04-25 16:50:00 +08:00
|
|
|
print line; \
|
|
|
|
|
} } \
|
|
|
|
|
' > "$@"
|
|
|
|
|
|
2015-08-14 00:48:53 +08:00
|
|
|
distclean:: distclean-manpages
|
|
|
|
|
|
|
|
|
|
distclean-manpages::
|
2017-04-25 16:50:00 +08:00
|
|
|
$(gen_verbose) rm -f $(WEB_MANPAGES)
|
