1 /* 2 * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved. 3 * 4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 5 * 6 * The contents of this file are subject to the terms of either the Universal Permissive License 7 * v 1.0 as shown at http://oss.oracle.com/licenses/upl 8 * 9 * or the following license: 10 * 11 * Redistribution and use in source and binary forms, with or without modification, are permitted 12 * provided that the following conditions are met: 13 * 14 * 1. Redistributions of source code must retain the above copyright notice, this list of conditions 15 * and the following disclaimer. 16 * 17 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of 18 * conditions and the following disclaimer in the documentation and/or other materials provided with 19 * the distribution. 20 * 21 * 3. Neither the name of the copyright holder nor the names of its contributors may be used to 22 * endorse or promote products derived from this software without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR 25 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 26 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 27 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 30 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY 31 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 package org.openjdk.jmc.flightrecorder.rules.jdk.memory; 34 35 import java.text.MessageFormat; 36 import java.util.Collection; 37 import java.util.Collections; 38 import java.util.concurrent.Callable; 39 import java.util.concurrent.FutureTask; 40 import java.util.concurrent.RunnableFuture; 41 42 import org.openjdk.jmc.common.IDisplayable; 43 import org.openjdk.jmc.common.item.IItemCollection; 44 import org.openjdk.jmc.common.unit.IQuantity; 45 import org.openjdk.jmc.common.unit.UnitLookup; 46 import org.openjdk.jmc.common.util.IPreferenceValueProvider; 47 import org.openjdk.jmc.common.util.TypedPreference; 48 import org.openjdk.jmc.flightrecorder.jdk.JdkAggregators; 49 import org.openjdk.jmc.flightrecorder.jdk.JdkTypeIDs; 50 import org.openjdk.jmc.flightrecorder.rules.IRule; 51 import org.openjdk.jmc.flightrecorder.rules.Result; 52 import org.openjdk.jmc.flightrecorder.rules.jdk.messages.internal.Messages; 53 import org.openjdk.jmc.flightrecorder.rules.util.JfrRuleTopics; 54 import org.openjdk.jmc.flightrecorder.rules.util.RulesToolkit; 55 import org.openjdk.jmc.flightrecorder.rules.util.RulesToolkit.EventAvailability; 56 57 public class MetaspaceOomRule implements IRule { 58 59 private static final String RESULT_ID = "MetaspaceOom"; //$NON-NLS-1$ 60 61 private Result getResult(IItemCollection items, IPreferenceValueProvider valueProvider) { 62 EventAvailability eventAvailability = RulesToolkit.getEventAvailability(items, JdkTypeIDs.METASPACE_OOM); 63 if (eventAvailability == EventAvailability.UNKNOWN || eventAvailability == EventAvailability.DISABLED) { 64 return RulesToolkit.getEventAvailabilityResult(this, items, eventAvailability, JdkTypeIDs.METASPACE_OOM); 65 } 66 67 IQuantity oomCount = items.getAggregate(JdkAggregators.METASPACE_OOM_COUNT); 68 if (oomCount != null && oomCount.doubleValue() > 0) { 69 // FIXME: Configuration attribute instead of hard coded 1 as warning limit 70 double score = RulesToolkit.mapExp100(oomCount.clampedLongValueIn(UnitLookup.NUMBER_UNITY), 1); 71 String message = MessageFormat.format(Messages.getString(Messages.MetaspaceOomRuleFactory_TEXT_WARN), 72 oomCount.displayUsing(IDisplayable.AUTO)); 73 String longMessage = message + " " + Messages.getString(Messages.MetaspaceOomRuleFactory_TEXT_WARN_LONG); //$NON-NLS-1$ 74 return new Result(this, score, message, longMessage); 75 } 76 return new Result(this, 0, Messages.getString(Messages.MetaspaceOomRuleFactory_TEXT_OK)); 77 } 78 79 @Override 80 public RunnableFuture<Result> evaluate(final IItemCollection items, final IPreferenceValueProvider valueProvider) { 81 FutureTask<Result> evaluationTask = new FutureTask<>(new Callable<Result>() { 82 @Override 83 public Result call() throws Exception { 84 return getResult(items, valueProvider); 85 } 86 }); 87 return evaluationTask; 88 } 89 90 @Override 91 public Collection<TypedPreference<?>> getConfigurationAttributes() { 92 return Collections.emptyList(); 93 } 94 95 @Override 96 public String getId() { 97 return RESULT_ID; 98 } 99 100 @Override 101 public String getName() { 102 return Messages.getString(Messages.MetaspaceOomRuleFactory_RULE_NAME); 103 } 104 105 @Override 106 public String getTopic() { 107 return JfrRuleTopics.GARBAGE_COLLECTION_TOPIC; 108 } 109 }