RabbitMQ配置文件及环境变量

Description

defines server and plugin settings for

• TCP listeners and other networking-related settings
• TLS
• resource constraints (alarms)
• authentication and authorization backends
• message store settings

define node name, file and directory locations, runtime flags (taken from the shell, or set in the environment configuration file, rabbitmq-env.conf/rabbitmq-env-conf.bat)

When internal authentication/authorization backend is used, rabbitmqctl is the tool that manages virtual hosts, users and permissions.

rabbitmq-plugins is the tool that manages enabled plugins.

Description

Change this if you only want to bind to one network interface. To bind to two or more interfaces, use the tcp_listeners key in rabbitmq.config.

Port used for inter-node and CLI tool communition. Ignored if your config file sets kernel.inet_dist_listen_min or kernel.inet_dist_listen_max keys. See Networking for details.

The node name should be unique per erlang-node-and-machine combination. To run multiple nodes, see the clustering guide.

Location of the file that contains environment variable definitions (without the RABBITMQ_ prefix). Note that the file name on Windows is different from other operating systems.

When set to true this will cause RabbitMQ to use fully qualified names to identify nodes. This may prove useful on EC2. Note that it is not possible to switch between using short and long names without resetting the node.

The name of the installed service. This will appear in services.msc.

Set this variable to new or reuse to redirect console output from the server to a file named %RABBITMQ_SERVICENAME%.debug in the default RABBITMQ_BASE directory.

• If not set, console output from the server will be discarded (default).
• new A new file will be created each time the service starts.
• reuse The file will be overwritten each time the service starts.

Parameters for the erl command used when invoking rabbitmqctl. This should be overridden for debugging purposes only.调用rabbitmqctl时使用的erl命令的参数。只有在调试时才应该覆盖它。

Standard parameters for the erl command used when invoking the RabbitMQ Server. This should be overridden for debugging purposes only. Overriding this variable replaces the default value.调用RabbitMQ服务器时使用的erl命令的标准参数。只有在调试时才应该覆盖它。覆盖此变量将替换默认值。

Additional parameters for the erl command used when invoking the RabbitMQ Server. The value of this variable is appended the default list of arguments (RABBITMQ_SERVER_ERL_ARGS). This is the environment variable to use if +K true needs to be overwritten.

调用RabbitMQ服务器时使用的erl命令的其他参数。这个变量的值附加了默认参数列表(RABBITMQ_SERVER_ERL_ARGS)。如果+K true需要重写，则使用此环境变量。

Description

The name of the current machine

The name of the current machine

Documentation

Ports or hostname/pair on which to listen for AMQP connections (without TLS). See the Networking guide for more details and examples.

Default: [5672]

Number of Erlang processes that will accept connections for the TCP listeners.

Default: 10

Maximum time for AMQP 0-8/0-9/0-9-1 handshake (after socket connection and SSL handshake), in milliseconds.

Default: 10000

As above, for SSL connections.

Default: []

Number of Erlang processes that will accept connections for the SSL listeners.

Default: 1

SSL configuration. See the SSL documentation.

Default: []

SSL handshake timeout, in milliseconds.

Default: 5000

Memory threshold at which the flow control is triggered. See the memory-based flow control documentation.

Default: 0.4

Strategy for memory usage reporting. Can be one of the following:

• allocated: uses Erlang memory allocator statistics
• rss: uses operating system RSS memory reporting. This uses OS-specific means and may start short lived child processes.
• legacy: uses legacy memory reporting (how much memory is considered to be used by the runtime). This strategy is fairly inaccurate.
• erlang: same as legacy, preserved for backwards compatibility

Default: allocated

Fraction of the high watermark limit at which queues start to page messages out to disc to free up memory. See the memory-based flow control documentation.

Default: 0.5

Makes it possible to override the total amount of memory available, as opposed to inferring it from the environment using OS-specific means. This should only be used when actual maximum amount of RAM available to the node doesn't match the value that will be inferred by the node, e.g. due to containerization or similar constraints the node cannot be aware of. The value may be set to an integer number of bytes or, alternatively, in information units (e.g "8GB"). For example, when the value is set to 4 GB, the node will believe it is running on a machine with 4 GB of RAM.

Default: undefined (not used)

使重写可用内存总量成为可能，而不是使用特定于os的方法从环境中推断可用内存总量。只有当节点可用RAM的实际最大数量与节点推断出的值不匹配时，才应该使用这种方法，例如，由于容器化或节点不知道的类似约束。该值可以设置为整数字节数，也可以设置为信息单元(e.g "8GB")。例如，当该值设置为4GB时，节点将认为它运行在一台具有4GB RAM的机器上。

Disk free space limit of the partition on which RabbitMQ is storing data. When available disk space falls below this limit, flow control is triggered. The value may be set relative to the total amount of RAM (e.g. {mem_relative, 1.0}). The value may also be set to an integer number of bytes. Or, alternatively, in information units (e.g "50MB"). By default free disk space must exceed 50MB. See the Disk Alarms documentation.

Default: 50000000

Controls the granularity(粒度) of logging. The value is a list of log event category and log level pairs.

The level can be one of 'none' (no events are logged), 'error' (only errors are logged), 'warning' (only errors and warning are logged), 'info' (errors, warnings and informational messages are logged), or 'debug' (errors, warnings, informational messages and debugging messages are logged).

At present there are four categories defined. Other, currently uncategorised, events are always logged.

The categories are:

• channel - for all events relating to AMQP channels
• connection - for all events relating to network connections
• federation - for all events relating to federation
• mirroring - for all events relating to mirrored queues

Default: [{connection, info}]

Maximum permissible size of a frame (in bytes) to negotiate with clients. Setting to 0 means "unlimited" but will trigger a bug in some QPid clients. Setting a larger value may improve throughput; setting a smaller value may improve latency.

Default: 131072

Maximum permissible number of channels to negotiate with clients. Setting to 0 means "unlimited". Using more channels increases memory footprint of the broker.

Default: 0

Channel operation timeout in milliseconds (used internally, not directly exposed to clients due to messaging protocol differences and limitations).

Default: 15000

Value representing the heartbeat delay, in seconds, that the server sends in the connection.tune frame. If set to 0, heartbeats are disabled. Clients might not follow the server suggestion, see the AMQP reference for more details. Disabling heartbeats might improve performance in situations with a great number of connections, but might lead to connections dropping in the presence of network devices that close inactive connections.

Default: 60 (580 prior to release 3.5.5)

Virtual host to create when RabbitMQ creates a new database from scratch. The exchange amq.rabbitmq.log will exist in this virtual host.

Default: <<"/">>

User name to create when RabbitMQ creates a new database from scratch.

Default: <<"guest">>

Password for the default user.

Default: <<"guest">>

Tags for the default user.

Default: [administrator]

Permissions to assign to the default user when creating it.

Default: [<<".*">>, <<".*">>, <<".*">>]

List of users which are only permitted to connect to the broker via a loopback interface (i.e. localhost).

If you wish to allow the default guest user to connect remotely, you need to change this to [].

Default: [<<"guest">>]

Set this to cause clustering to happen automatically when a node starts for the very first time. The first element of the tuple is the nodes that the node will try to cluster to. The second element is either disc or ram and determines the node type.

Default: {[], disc}

List of key-value pairs to announce to clients on connection.

Default: []

Statistics collection mode. Primarily relevant for the management plugin. Options are:

• none (do not emit statistics events)
• coarse (emit per-queue / per-channel / per-connection statistics)
• fine (also emit per-message statistics)

You probably don't want to change this yourself.

Default: none

Statistics collection interval in milliseconds. Primarily relevant for the management plugin.

Default: 5000

Affects the amount of time the management plugin will cache expensive management queries such as queue listings. The cache will multiply the elapsed time of the last query by this value and cache the result for this amount of time.

Default: 5

SASL authentication mechanisms to offer to clients.向客户端提供的SASL身份验证机制。

Default: ['PLAIN', 'AMQPLAIN']

List of authentication and authorisation backends to use.要使用的身份验证和授权后端列表。

Other databases than rabbit_auth_backend_internal are available through plugins. rabbit_auth_backend_internal之外的其他数据库可以通过插件获得。

Default: [rabbit_auth_backend_internal]

Set to true to have RabbitMQ perform a reverse DNS lookup on client connections, and present that information through rabbitmqctl and the management plugin.

设置为true，使RabbitMQ对客户端连接执行反向DNS查询，并通过rabbitmqctl和管理插件显示该信息。

Default: false

Number of delegate processes to use for intra-cluster communication. On a machine which has a very large number of cores and is also part of a cluster, you may wish to increase this value.

Default: 16

Used internally by the tracer. You shouldn't change this.

Default: []

Default socket options. You probably don't want to change this.

Default:

1. [{backlog, 128},
2. {nodelay, true},
3. {linger, {true,0}},
4. {exit_on_close, false}]

Set to true to precompile parts of RabbitMQ with HiPE, a just-in-time compiler for Erlang. This will increase server throughput at the cost of increased startup time.

You might see 20-50% better performance at the cost of a few minutes delay at startup. These figures are highly workload- and hardware-dependent.

HiPE support may not be compiled into your Erlang installation. If it is not, enabling this option will just cause a warning message to be displayed and startup will proceed as normal. For example, Debian / Ubuntu users will need to install the erlang-base-hipe package.

HiPE is not available at all on some platforms, notably including Windows.

HiPE has known issues in Erlang/OTP versions prior to 17.5. Using a recent Erlang/OTP version is highly recommended for HiPE.

Default: false

How to handle network partitions. Available modes are:

• ignore
• pause_minority
• {pause_if_all_down, [nodes], ignore | autoheal} where [nodes] is a list of node names
  (ex: ['rabbit@node1', 'rabbit@node2'])
• autoheal

See the documentation on partitions for more information.

Default: ignore

How frequently nodes should send keepalive messages to other nodes (in milliseconds). Note that this is not the same thing as net_ticktime; missed keepalive messages will not cause nodes to be considered down.

Default: 10000

Size in bytes of message below which messages will be embedded directly in the queue index. You are advised to read the persisteSet to true to precompile parts of RabbitMQ with HiPE, a just-in-time compiler for Erlang. This will increase server throughput at the cost of increased startup time.

You might see 20-50% better performance at the cost of a few minutes delay at startup. These figures are highly workload- and hardware-dependent.

HiPE support may not be compiled into your Erlang installation. If it is not, enabling this option will just cause a warning message to be displayed and startup will proceed as normal. For example, Debian / Ubuntu users will need to install the erlang-base-hipe package.

HiPE is not available at all on some platforms, notably including Windows.

HiPE has known issues in Erlang/OTP versions prior to 17.5. Using a recent Erlang/OTP version is highly recommended for HiPE.

r tuning documentation before changing this.

Default: 4096

Implementation module for queue indexing. You are advised to read the persister tuning documentation before changing this.

Default: rabbit_msg_store_ets_index

Implementation module for queue contents. You probably don't want to change this.

Default: rabbit_variable_queue

Tunable value for the persister. You almost certainly should not change this.

Default: 16777216

The credits that a queue process is given by the message store.

By default, a queue process is given 4000 message store credits, and then 800 for every 800 messages that it processes.

Messages which need to be paged out due to memory pressure will also use this credit.

The Message Store is the last component in the credit flow chain. message store是credit flow链中最后一部分。 Learn about credit flow.

This value 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.此值仅在将消息持久化到message store时生效。如果消息嵌入到队列索引中，则修改此设置没有效果，因为写入队列索引时不使用credit_flow。

Default: {4000, 800}

Number of times to retry while waiting for Mnesia tables in a cluster to become available.

Default: 10

Time to wait per retry for Mnesia tables in a cluster to become available.

Default: 30000

Tunable value for the persister. You almost certainly should not change this.

Default: 65536

Queue master location strategy. Available strategies are:

• <<"min-masters">>
• <<"client-local">>
• <<"random">>

See the documentation on queue master location for more information.

Default: <<"client-local">>

Batch size of messages to synchronise between queue mirrors See Batch Synchronization

要在队列镜像之间同步的消息的批处理大小，请参见批处理同步

Default: 4096

Tunable value only for lazy queues when under memory pressure. This is the threshold at which the garbage collector and other memory reduction activities are triggered. A low value could reduce performance, and a high one can improve performance, but cause higher memory consumption. You almost certainly should not change this.

Default: 1000