org.apache.activemq.plugin.StatisticsBrokerPlugin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of activemq-broker Show documentation

The ActiveMQ Message Broker implementation

There is a newer version: 6.1.4

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.activemq.plugin;

import org.apache.activemq.broker.Broker;
import org.apache.activemq.broker.BrokerPlugin;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * A StatisticsBrokerPlugin
 * You can retrieve a Map Message for a Destination - or
 * Broker containing statistics as key-value pairs The message must contain a
 * replyTo Destination - else its ignored
 * To retrieve stats on the broker send a empty message to ActiveMQ.Statistics.Broker (Queue or Topic)
 * With a replyTo set to the destination you want the stats returned to.
 * To retrieve stats for a destination - e.g. foo - send an empty message to ActiveMQ.Statistics.Destination.foo
 * - this works with wildcards to - you get a message for each wildcard match on the replyTo destination.
 * The stats message is a MapMessage populated with statistics for the target
 * @org.apache.xbean.XBean element="statisticsBrokerPlugin"
 *
 */
public class StatisticsBrokerPlugin implements BrokerPlugin {
    private static Logger LOG = LoggerFactory.getLogger(StatisticsBrokerPlugin.class);
    /** 
     * @param broker
     * @return the plug-in
     * @throws Exception
     * @see org.apache.activemq.broker.BrokerPlugin#installPlugin(org.apache.activemq.broker.Broker)
     */
    public Broker installPlugin(Broker broker) throws Exception {
        LOG.info("Installing StaticsBroker");
        StatisticsBroker answer = new StatisticsBroker(broker);
        return answer;
    }
}