/*
|
* CDDL HEADER START
|
*
|
* The contents of this file are subject to the terms of the
|
* Common Development and Distribution License, Version 1.0 only
|
* (the "License"). You may not use this file except in compliance
|
* with the License.
|
*
|
* You can obtain a copy of the license at
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
|
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
|
* See the License for the specific language governing permissions
|
* and limitations under the License.
|
*
|
* When distributing Covered Code, include this CDDL HEADER in each
|
* file and include the License file at
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
|
* add the following below this CDDL HEADER, with the fields enclosed
|
* by brackets "[]" replaced with your own identifying * information:
|
* Portions Copyright [yyyy] [name of copyright owner]
|
*
|
* CDDL HEADER END
|
*
|
*
|
* Portions Copyright 2006 Sun Microsystems, Inc.
|
*/
|
package org.opends.server.monitors;
|
|
|
|
import java.util.ArrayList;
|
import java.util.LinkedHashSet;
|
|
import org.opends.server.api.AttributeSyntax;
|
import org.opends.server.api.MonitorProvider;
|
import org.opends.server.config.ConfigEntry;
|
import org.opends.server.config.ConfigException;
|
import org.opends.server.core.DirectoryServer;
|
import org.opends.server.core.InitializationException;
|
import org.opends.server.extensions.TraditionalWorkQueue;
|
import org.opends.server.protocols.asn1.ASN1OctetString;
|
import org.opends.server.types.Attribute;
|
import org.opends.server.types.AttributeType;
|
import org.opends.server.types.AttributeValue;
|
|
import static org.opends.server.loggers.Debug.*;
|
|
|
|
/**
|
* This class defines a Directory Server monitor that can be used to provide
|
* information about the state of the work queue.
|
*/
|
public class TraditionalWorkQueueMonitor
|
extends MonitorProvider
|
{
|
/**
|
* The fully-qualified name of this class for debugging purposes.
|
*/
|
private static final String CLASS_NAME =
|
"org.opends.server.monitors.WorkQueueMonitor";
|
|
|
|
/**
|
* The name to use for the monitor attribute that provides the current request
|
* backlog.
|
*/
|
public static final String ATTR_CURRENT_BACKLOG = "currentRequestBacklog";
|
|
|
|
/**
|
* The name to use for the monitor attribute that provides the average request
|
* backlog.
|
*/
|
public static final String ATTR_AVERAGE_BACKLOG = "averageRequestBacklog";
|
|
|
|
/**
|
* The name to use for the monitor attribute that provides the maximum
|
* observed request backlog.
|
*/
|
public static final String ATTR_MAX_BACKLOG = "maxRequestBacklog";
|
|
|
|
/**
|
* The name to use for the monitor attribute that provides the total number of
|
* operations submitted.
|
*/
|
public static final String ATTR_OPS_SUBMITTED = "requestsSubmitted";
|
|
|
|
/**
|
* The name to use for the monitor attribute that provides the total number of
|
* requests that have been rejected because the work queue was full.
|
*/
|
public static final String ATTR_OPS_REJECTED_QUEUE_FULL =
|
"requestsRejectedDueToQueueFull";
|
|
|
|
// The maximum backlog observed by polling the queue.
|
private int maxBacklog;
|
|
// The total number of times the backlog has been polled.
|
private long numPolls;
|
|
// The total backlog observed from periodic polling.
|
private long totalBacklog;
|
|
// The traditional work queue instance with which this monitor is associated.
|
private TraditionalWorkQueue workQueue;
|
|
|
|
/**
|
* Initializes this monitor provider. Note that no initialization should be
|
* done here, since it should be performed in the
|
* <CODE>initializeMonitorProvider</CODE> class.
|
*
|
* @param workQueue The work queue with which this monitor is associated.
|
*/
|
public TraditionalWorkQueueMonitor(TraditionalWorkQueue workQueue)
|
{
|
super("Work Queue Monitor Provider");
|
|
assert debugConstructor(CLASS_NAME);
|
|
this.workQueue = workQueue;
|
}
|
|
|
|
/**
|
* Initializes this monitor provider based on the information in the provided
|
* configuration entry.
|
*
|
* @param configEntry The configuration entry that contains the information
|
* to use to initialize this monitor provider.
|
*
|
* @throws ConfigException If an unrecoverable problem arises in the
|
* process of performing the initialization.
|
*
|
* @throws InitializationException If a problem occurs during initialization
|
* that is not related to the server
|
* configuration.
|
*/
|
public void initializeMonitorProvider(ConfigEntry configEntry)
|
throws ConfigException, InitializationException
|
{
|
assert debugEnter(CLASS_NAME, "initializeMonitorProvider",
|
String.valueOf(configEntry));
|
|
maxBacklog = 0;
|
totalBacklog = 0;
|
numPolls = 0;
|
}
|
|
|
|
/**
|
* Retrieves the name of this monitor provider. It should be unique among all
|
* monitor providers, including all instances of the same monitor provider.
|
*
|
* @return The name of this monitor provider.
|
*/
|
public String getMonitorInstanceName()
|
{
|
assert debugEnter(CLASS_NAME, "getMonitorInstanceName");
|
|
return "Work Queue";
|
}
|
|
|
|
/**
|
* Retrieves the length of time in milliseconds that should elapse between
|
* calls to the <CODE>updateMonitorData()</CODE> method. A negative or zero
|
* return value indicates that the <CODE>updateMonitorData()</CODE> method
|
* should not be periodically invoked.
|
*
|
* @return The length of time in milliseconds that should elapse between
|
* calls to the <CODE>updateMonitorData()</CODE> method.
|
*/
|
public long getUpdateInterval()
|
{
|
assert debugEnter(CLASS_NAME, "getUpdateInterval");
|
|
|
// We will poll the work queue every 10 seconds.
|
return 10000;
|
}
|
|
|
|
/**
|
* Performs any processing periodic processing that may be desired to update
|
* the information associated with this monitor. Note that best-effort
|
* attempts will be made to ensure that calls to this method come
|
* <CODE>getUpdateInterval()</CODE> milliseconds apart, but no guarantees will
|
* be made.
|
*/
|
public void updateMonitorData()
|
{
|
assert debugEnter(CLASS_NAME, "updateMonitorData");
|
|
int backlog = workQueue.size();
|
totalBacklog += backlog;
|
numPolls++;
|
|
if (backlog > maxBacklog)
|
{
|
maxBacklog = backlog;
|
}
|
}
|
|
|
|
/**
|
* Retrieves a set of attributes containing monitor data that should be
|
* returned to the client if the corresponding monitor entry is requested.
|
*
|
* @return A set of attributes containing monitor data that should be
|
* returned to the client if the corresponding monitor entry is
|
* requested.
|
*/
|
public ArrayList<Attribute> getMonitorData()
|
{
|
assert debugEnter(CLASS_NAME, "getMonitorData");
|
|
int backlog = workQueue.size();
|
totalBacklog += backlog;
|
numPolls++;
|
if (backlog > maxBacklog)
|
{
|
maxBacklog = backlog;
|
}
|
|
long averageBacklog = (long) (1.0 * totalBacklog / numPolls);
|
|
long opsSubmitted = workQueue.getOpsSubmitted();
|
long rejectedQueueFull = workQueue.getOpsRejectedDueToQueueFull();
|
|
ArrayList<Attribute> monitorAttrs = new ArrayList<Attribute>();
|
AttributeSyntax integerSyntax = DirectoryServer.getDefaultIntegerSyntax();
|
|
|
// The current backlog.
|
AttributeType attrType =
|
DirectoryServer.getDefaultAttributeType(ATTR_CURRENT_BACKLOG,
|
integerSyntax);
|
ASN1OctetString valueString = new ASN1OctetString(String.valueOf(backlog));
|
LinkedHashSet<AttributeValue> values = new LinkedHashSet<AttributeValue>();
|
values.add(new AttributeValue(valueString, valueString));
|
monitorAttrs.add(new Attribute(attrType, ATTR_CURRENT_BACKLOG, values));
|
|
|
// The average backlog.
|
attrType = DirectoryServer.getDefaultAttributeType(ATTR_AVERAGE_BACKLOG,
|
integerSyntax);
|
valueString = new ASN1OctetString(String.valueOf(averageBacklog));
|
values = new LinkedHashSet<AttributeValue>();
|
values.add(new AttributeValue(valueString, valueString));
|
monitorAttrs.add(new Attribute(attrType, ATTR_AVERAGE_BACKLOG, values));
|
|
|
// The maximum backlog.
|
attrType = DirectoryServer.getDefaultAttributeType(ATTR_MAX_BACKLOG,
|
integerSyntax);
|
valueString = new ASN1OctetString(String.valueOf(maxBacklog));
|
values = new LinkedHashSet<AttributeValue>();
|
values.add(new AttributeValue(valueString, valueString));
|
monitorAttrs.add(new Attribute(attrType, ATTR_MAX_BACKLOG, values));
|
|
|
// The total number of operations submitted.
|
attrType = DirectoryServer.getDefaultAttributeType(ATTR_OPS_SUBMITTED,
|
integerSyntax);
|
valueString = new ASN1OctetString(String.valueOf(opsSubmitted));
|
values = new LinkedHashSet<AttributeValue>();
|
values.add(new AttributeValue(valueString, valueString));
|
monitorAttrs.add(new Attribute(attrType, ATTR_OPS_SUBMITTED, values));
|
|
|
// The total number of operations rejected due to a full work queue.
|
attrType =
|
DirectoryServer.getDefaultAttributeType(ATTR_OPS_REJECTED_QUEUE_FULL,
|
integerSyntax);
|
valueString = new ASN1OctetString(String.valueOf(rejectedQueueFull));
|
values = new LinkedHashSet<AttributeValue>();
|
values.add(new AttributeValue(valueString, valueString));
|
monitorAttrs.add(new Attribute(attrType, ATTR_OPS_REJECTED_QUEUE_FULL,
|
values));
|
|
|
return monitorAttrs;
|
}
|
}
|
