http://git-wip-us.apache.org/repos/asf/qpid-site/blob/42d76007/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Appendix-Queue-Alerts.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Appendix-Queue-Alerts.html b/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Appendix-Queue-Alerts.html new file mode 100644 index 0000000..44dfbbb --- /dev/null +++ b/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Appendix-Queue-Alerts.html @@ -0,0 +1,171 @@ + + + + + Appendix E. Queue Alerts - Apache Qpid™ + + + + + + + + + + + + + +

+ + +

+ + + + + +

+ + +

Appendix E. Queue Alerts
Prev		Next

Appendix E. Queue Alerts

The Broker supports a variety of queue alerting thresholds. Once configured on a queue, + these limits will be periodically written to the log if these limits are breached, until the + condition is rectified.

For example, if queue myqueue is configured with a message count alert of + 1000, and then owing to a failure of a downstream system messages begin to accumulate on the + queue, the following alerts will be written periodically to the log.

+INFO [default:VirtualHostHouseKeepingTask] (queue.NotificationCheck) - MESSAGE_COUNT_ALERT
+           On Queue myqueue - 1272: Maximum count on queue threshold (1000) breached.
+

Note that queue alerts are soft in nature; breaching the limit will + merely cause the alerts to be generated but messages will still be accepted to the queue.

Table E.1. Queue Alerts

Alert Name	Alert Format and Purpose
MESSAGE_COUNT_ALERT	MESSAGE_COUNT_ALERT On Queue `queuename` - + `number of messages`: Maximum count on queue threshold + (`limit`) breached.
MESSAGE_COUNT_ALERT	+ The number of messages on the given queue has breached its configured + limit. +
MESSAGE_SIZE_ALERT	MESSAGE_SIZE_ALERT On Queue `queuename` + -`message size` : Maximum message size threshold + (`limit`) breached. [Message ID=`message + id`]
MESSAGE_SIZE_ALERT	+ The size of an individual messages has breached its configured limit. +
QUEUE_DEPTH_ALERT	QUEUE_DEPTH_ALERT On Queue `queuename` - + `total size of all messages on queue` : Maximum queue depth + threshold (`limit`) breached.
QUEUE_DEPTH_ALERT	+ The total size of all messages on the queue has breached its configured + limit. +
MESSAGE_AGE_ALERT	MESSAGE_AGE_ALERT On Queue `queuename` - `age + of message` : Maximum age on queue threshold + (`limit`) breached.
MESSAGE_AGE_ALERT	+ The age of a message on the given queue has breached its configured limit. +

Prev		Next
D.3. Examples	Home	Appendix F. Miscellaneous

+ +

+ + + +

+ Apache Qpid, Messaging built on AMQP; Copyright © 2015 + The Apache Software Foundation; Licensed under + the Apache + License, Version 2.0; Apache Qpid, Qpid, Qpid Proton, + Proton, Apache, the Apache feather logo, and the Apache Qpid + project logo are trademarks of The Apache Software + Foundation; All other marks mentioned may be trademarks or + registered trademarks of their respective owners +

+ + http://git-wip-us.apache.org/repos/asf/qpid-site/blob/42d76007/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Appendix-Queue-Declare-Arguments.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Appendix-Queue-Declare-Arguments.html b/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Appendix-Queue-Declare-Arguments.html new file mode 100644 index 0000000..21f7ea0 --- /dev/null +++ b/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Appendix-Queue-Declare-Arguments.html @@ -0,0 +1,224 @@ + + + + + Appendix G. Queue Declaration Arguments supported by the Broker - Apache Qpid™ + + + + + + + + + + + + + +

+ + +

+ + + + + +

+ + +

Appendix G. Queue Declaration Arguments supported by the Broker
Prev

Appendix G. Queue Declaration Arguments supported by the Broker

+ Qpid Broker-J + supports a number of custom arguments which can be specified as part of queue.declare + commands for AMQP 0-x protocols. This section provides an overview of the supported arguments. +

Table G.1. Queue declare arguments

Argument Name	Description
+ Declaration of overflow policy. + See + Section 4.7.5, “Controlling Queue Size” + for more details. + +
+ qpid.policy_type +	+ Defines queue overflow policy. +
+ qpid.max_count +	+ Defines maximum number of messages. + +
+ qpid.max_size +	+ Defines maximum number of bytes. + +
+ The Overflow Policy and the limits can be specified using + Address + based syntax as in the example below: + +my-queue; {create: always, node: {x-declare: {arguments:{'qpid.max_count': 10000, 'qpid.max_size': 102400, 'qpid.policy_type: 'ring'}}}} + + +
+ Alternative declaration of Producer Flow Control overflow policy. + See + Section 4.7.5, “Controlling Queue Size” + for more details. + +
+ x-qpid-capacity +	+ Defines maximum number of bytes. + +
+ x-qpid-flow-resume-capacity +	+ Defines flow resume threshold in bytes +
+ The Producer Flow Control can be specified using + Address based syntax as in the example below: + +my-queue; {create: always, node: {x-declare: {arguments:{'x-qpid-capacity': 102400, 'x-qpid-flow-resume-capacity': 8192000}}}} + + +
+ x-qpid-priorities +	+ Specifies a priority queue with given number priorities +
+ qpid.queue_sort_key +	+ Specifies sorted queue with given message property used to sort the entries +
+ qpid.last_value_queue_key +	+ Specifies lvq queue with given message property used to conflate the entries +
+ qpid.ensure_nondestructive_consumers +	+ Set to true if the queue should make all consumers attached to it behave + non-destructively. (Default is false). +
+ x-qpid-maximum-delivery-count +	+ Specifies this queue's maximum delivery count. +
+ x-qpid-dlq-enabled +	+ If set `true`, a dead letter queue will be automatically created + and assigned as this queue's `alternateBinding`. +

Prev
F.2. Installing External JDBC Driver	Home

+ +

+ + + +

+ + http://git-wip-us.apache.org/repos/asf/qpid-site/blob/42d76007/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Appendix-Statistics-Reporting.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Appendix-Statistics-Reporting.html b/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Appendix-Statistics-Reporting.html new file mode 100644 index 0000000..e33ca23 --- /dev/null +++ b/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Appendix-Statistics-Reporting.html @@ -0,0 +1,151 @@ + + + + + Appendix D. Statistics Reporting - Apache Qpid™ + + + + + + + + + + + + + +

+ + +

+ + + + + +

+ + +

Appendix D. Statistics Reporting
Prev		Next

Appendix D. Statistics Reporting

Table of Contents

D.1. Statistics Report Period
D.2. Statistic Report Patterns
D.3. Examples

The Broker has the ability to periodically write statistics of any entity within the system to + the log. Statistics reporting can be configured for a single entity (e.g. a queue) or for all entities of a + particular category (e.g. for all queues). The system can be configured dynamically at runtime without the need + for the system to be restarted.

This feature helps allow the behaviour of the overall system to be understood and can aid real-time problem + diagnosis.

It can be configured Broker-wide or separately for each virtual host.

The format of the statistics report is configurable.

D.1. Statistics Report Period

This governs the period with which statistics reports will be written to the log. The period is defined + in seconds. By default the statistics report period is zero, meaning the system is disabled. To enable the + statistics report set the statistics reporting period on either the Broker or virtualhost to + a non-zero value.

Once the period is defined, the system will respond to the statistic report patterns defined described next.

Prev		Next
Appendix C. Operational Logging	Home	D.2. Statistic Report Patterns

+ +

+ + + +

+ + http://git-wip-us.apache.org/repos/asf/qpid-site/blob/42d76007/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Appendix-System-Properties.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Appendix-System-Properties.html b/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Appendix-System-Properties.html new file mode 100644 index 0000000..13b5f97 --- /dev/null +++ b/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Appendix-System-Properties.html @@ -0,0 +1,154 @@ + + + + + Appendix B. System Properties - Apache Qpid™ + + + + + + + + + + + + + +

+ + +

+ + + + + +

+ + +

Appendix B. System Properties
Prev		Next

Appendix B. System Properties

The following table describes the Java system properties used by the Broker to control + various optional behaviours.

The preferred method of enabling these system properties is using the QPID_OPTS environment variable described in the previous + section.

Table B.1. System properties

System property	Default	Purpose
qpid.broker_heartbeat_timeout_factor	2	Factor to determine the maximum length of that may elapse between heartbeats being + received from the peer before a connection is deemed to have been broken.
qpid.broker_dead_letter_queue_suffix	_DLQ	Used with the Section 9.4.3, “Alternate Binding” + feature. Governs the suffix used when generating a name for a Dead Letter Queue.
qpid.broker_status_updates	true	+ If set true, the Broker will produce operational logging messages. +
qpid.broker_disabled_features	none	+ Allows optional Broker features to be disabled. Currently understood feature + names are: `qpid.jms-selector` + Feature names should be comma separated. +

Prev		Next
Appendix A. Environment Variables	Home	Appendix C. Operational Logging

+ +

+ + + +

+ + http://git-wip-us.apache.org/repos/asf/qpid-site/blob/42d76007/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Backup-And-Recovery-Virtualhost-Node.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Backup-And-Recovery-Virtualhost-Node.html b/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Backup-And-Recovery-Virtualhost-Node.html new file mode 100644 index 0000000..645f943 --- /dev/null +++ b/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Backup-And-Recovery-Virtualhost-Node.html @@ -0,0 +1,156 @@ + + + + + 11.2. Virtualhost Node - Apache Qpid™ + + + + + + + + + + + + + +

+ + +

+ + + + + +

+ + +

11.2. Virtualhost Node
Prev	Chapter 11. Backup And Recovery	Next

11.2. Virtualhost Node

To perform a complete backup of a Virtualhost node whilst it is stopped (or Broker down), + simply copy all the files the exist beneath + ${QPID_WORK}/<nodename>/config, assuming the virtualhost node is in + the standard location. This will copy all configuration that belongs to that virtualhost + node.

The technique for backing up a virtualhost node whilst it is running depends on its + type.

11.2.1. BDB

BDB module includes the "hot" backup utility org.apache.qpid.server.store.berkeleydb.BDBBackup. + This utility can perform the backup when the broker is running.

You can run this class from command line like in an example below:

Example 11.1. Performing store backup by using BDBBackup class + directly

java -cp "${QPID_HOME}/lib/*" org.apache.qpid.server.store.berkeleydb.BDBBackup \
-fromdir ${QPID_WORK}/<nodename>/config -todir path/to/backup/folder

In the example above BDBBackup utility is called to backup the store at + ${QPID_WORK}/<nodename>/config and copy store logs into + path/to/backup/folder.

11.2.2. BDB-HA

See Section 11.2.1, “BDB”

Note

BDB-HA VirtualHost node backups are node specific. You cannot use the backup of one node to recover a different node. To backup a group a backup of each node needs to be taken separately.

11.2.3. Derby

Not yet supported

11.2.4. JDBC

The responsibility for backup is delegated to the database server itself. See the + documentation accompanying it. Any technique that takes a consistent snapshot of the + database is acceptable.

11.2.5. JSON

JSON stores its config in a single text file. It can be safely backed up using standard + command line tools.

Prev	Up	Next
Chapter 11. Backup And Recovery	Home	11.3. Virtualhost

+ +

+ + + +

+ + http://git-wip-us.apache.org/repos/asf/qpid-site/blob/42d76007/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Backup-And-Recovery-Virtualhost.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Backup-And-Recovery-Virtualhost.html b/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Backup-And-Recovery-Virtualhost.html new file mode 100644 index 0000000..823673a --- /dev/null +++ b/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Backup-And-Recovery-Virtualhost.html @@ -0,0 +1,153 @@ + + + + + 11.3. Virtualhost - Apache Qpid™ + + + + + + + + + + + + + +

+ + +

+ + + + + +

+ + +

11.3. Virtualhost
Prev	Chapter 11. Backup And Recovery	Next

11.3. Virtualhost

To perform a complete backup of a Virtualhost whilst it is stopped (or Broker down), + simply copy all the files the exist beneath + ${QPID_WORK}/<name>/messages, assuming the virtualhost is in the + standard location. This will copy all messages that belongs to that virtualhost.

The technique for backing up a virtualhost whilst it is running depends on its + type.

11.3.1. BDB

Use the same backup utility described above, but use the path + ${QPID_WORK}/<name>/messages instead.

11.3.2. Derby

Not yet supported

11.3.3. JDBC

The responsibility for backup is delegated to the database server itself. See the + documentation accompanying it. Any technique that takes a consistent snapshot of the + database is acceptable.

11.3.4. Provided

The contents of the virtualhost will be backed up as part of virtualhost node that + contains it.

11.3.5. BDB-HA

The contents of the virtualhost will be backed up as part of virtualhost node that + contains it.

Prev	Up	Next
11.2. Virtualhost Node	Home	Appendix A. Environment Variables

+ +

+ + + +

+ + http://git-wip-us.apache.org/repos/asf/qpid-site/blob/42d76007/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Backup-And-Recovery.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Backup-And-Recovery.html b/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Backup-And-Recovery.html new file mode 100644 index 0000000..9cb4663 --- /dev/null +++ b/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Backup-And-Recovery.html @@ -0,0 +1,147 @@ + + + + + Chapter 11. Backup And Recovery - Apache Qpid™ + + + + + + + + + + + + + +

+ + +

+ + + + + +

+ + +

Chapter 11. Backup And Recovery
Prev		Next

Chapter 11. Backup And Recovery

Table of Contents

11.1. Broker

11.2. Virtualhost Node

11.2.1. BDB
11.2.2. BDB-HA
11.2.3. Derby
11.2.4. JDBC
11.2.5. JSON

11.3. Virtualhost

11.3.1. BDB
11.3.2. Derby
11.3.3. JDBC
11.3.4. Provided
11.3.5. BDB-HA

11.1. Broker

To perform a complete backup whilst the Broker is shutdown, simply copy all the files the + exist beneath ${QPID_WORK}, assuming all virtualhost nodes and virtualhost + are in their standard location, this will copy all configuration and persistent message data.

There is currently no safe mechanism to take a complete copy of the entire Broker whilst + it is running.

Prev		Next
10.11. Reset Group Information	Home	11.2. Virtualhost Node

+ +

+ + + +

+ + http://git-wip-us.apache.org/repos/asf/qpid-site/blob/42d76007/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Concepts-Authentication-Providers.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Concepts-Authentication-Providers.html b/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Concepts-Authentication-Providers.html new file mode 100644 index 0000000..3ddc007 --- /dev/null +++ b/content/releases/qpid-broker-j-7.0.1/book/Java-Broker-Concepts-Authentication-Providers.html @@ -0,0 +1,148 @@ + + + + + 4.9. Authentication Providers - Apache Qpid™ + + + + + + + + + + + + + +

+ + +

+ + + + + +

+ + +

4.9. Authentication Providers
Prev	Chapter 4. Concepts	Next

4.9. Authentication Providers

+ Authentication Providers are used by Ports to authenticate connections. + Many Authentication Providers can be configured on the Broker at the same time, from which + each Port can be assigned one. +

Some Authentication Providers offer facilities for creation and deletion of users.

Prev	Up	Next
4.8. Ports	Home	4.10. Other Services

+ +

+ + + +

+ + --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org For additional commands, e-mail: commits-help@qpid.apache.org

Project

Messaging APIs

Servers and tools

Resources

Appendix E. Queue Alerts

Project

Messaging APIs

Servers and tools

Resources

Appendix G. Queue Declaration Arguments supported by the Broker

Project

Messaging APIs

Servers and tools

Resources

Appendix D. Statistics Reporting

D.1. Statistics Report Period

Project

Messaging APIs

Servers and tools

Resources

Appendix B. System Properties

Project

Messaging APIs

Servers and tools

Resources

11.2. Virtualhost Node

11.2.1. BDB

11.2.2. BDB-HA

Note

11.2.3. Derby

11.2.4. JDBC

11.2.5. JSON

Project

Messaging APIs

Servers and tools

Resources

11.3. Virtualhost

11.3.1. BDB

11.3.2. Derby

11.3.3. JDBC

11.3.4. Provided

11.3.5. BDB-HA

Project

Messaging APIs

Servers and tools

Resources

Chapter 11. Backup And Recovery

11.1. Broker

Project

Messaging APIs

Servers and tools

Resources

4.9. Authentication Providers