hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/webapp/ErrorsAndWarningsBlock.java

/**
 * 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.hadoop.yarn.server.webapp;

import com.google.inject.Inject;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.security.UserGroupInformation;
import org.apache.hadoop.util.GenericsUtil;
import org.apache.hadoop.util.Time;
import org.apache.hadoop.yarn.security.AdminACLsManager;
import org.apache.hadoop.yarn.util.Log4jWarningErrorMetricsAppender;
import org.apache.hadoop.yarn.util.Times;
import org.apache.hadoop.yarn.webapp.hamlet2.Hamlet;
import org.apache.hadoop.yarn.webapp.view.HtmlBlock;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class ErrorsAndWarningsBlock extends HtmlBlock {

  long cutoffPeriodSeconds;
  final private AdminACLsManager adminAclsManager;

  @Inject
  ErrorsAndWarningsBlock(ViewContext ctx, Configuration conf) {
    super(ctx);
    // default is to show all errors and warnings
    cutoffPeriodSeconds = Time.now() / 1000;
    String value = ctx.requestContext().get("cutoff", "");
    try {
      cutoffPeriodSeconds = Integer.parseInt(value);
      if (cutoffPeriodSeconds <= 0) {
        cutoffPeriodSeconds = Time.now() / 1000;
      }
    } catch (NumberFormatException ne) {
      cutoffPeriodSeconds = Time.now() / 1000;
    }
    adminAclsManager = new AdminACLsManager(conf);
  }

  @Override
  protected void render(Block html) {
    boolean isAdmin = false;
    UserGroupInformation callerUGI = this.getCallerUGI();

    if (adminAclsManager.areACLsEnabled()) {
      if (callerUGI != null && adminAclsManager.isAdmin(callerUGI)) {
        isAdmin = true;
      }
    } else {
      isAdmin = true;
    }

    if (!isAdmin) {
      html.div().p().__("This page is for admins only.").__().__();
      return;
    }

    if (GenericsUtil.isLog4jLogger(ErrorsAndWarningsBlock.class)) {
      html.__(ErrorMetrics.class);
      html.__(WarningMetrics.class);
      html.div().button().$onclick("reloadPage()").b("View data for the last ")
        .__().select().$id("cutoff").option().$value("60").__("1 min").__()
        .option().$value("300").__("5 min").__().option().$value("900")
        .__("15 min").__().option().$value("3600").__("1 hour").__().option()
        .$value("21600").__("6 hours").__().option().$value("43200")
        .__("12 hours").__().option().$value("86400").__("24 hours").__().__().__();

      String script = "function reloadPage() {"
          + " var timePeriod = $(\"#cutoff\").val();"
          + " document.location.href = '/cluster/errors-and-warnings?cutoff=' + timePeriod"
          + "}";
      script =  script
          + "; function toggleContent(element) {"
          + "  $(element).parent().siblings('.toggle-content').fadeToggle();"
          + "}";

      html.script().$type("text/javascript").__(script).__();

      html.style(".toggle-content { display: none; }");

      Log4jWarningErrorMetricsAppender appender =
          Log4jWarningErrorMetricsAppender.findAppender();
      if (appender == null) {
        return;
      }
      List<Long> cutoff = new ArrayList<>();
      Hamlet.TBODY<Hamlet.TABLE<Hamlet>> errorsTable =
          html.table("#messages").thead().tr().th(".message", "Message")
            .th(".type", "Type").th(".count", "Count")
            .th(".lasttime", "Latest Message Time").__().__().tbody();

      // cutoff has to be in seconds
      cutoff.add((Time.now() - cutoffPeriodSeconds * 1000) / 1000);
      List<Map<String, Log4jWarningErrorMetricsAppender.Element>> errorsData =
          appender.getErrorMessagesAndCounts(cutoff);
      List<Map<String, Log4jWarningErrorMetricsAppender.Element>> warningsData =
          appender.getWarningMessagesAndCounts(cutoff);
      Map<String, List<Map<String, Log4jWarningErrorMetricsAppender.Element>>> sources =
          new HashMap<>();
      sources.put("Error", errorsData);
      sources.put("Warning", warningsData);

      int maxDisplayLength = 80;
      for (Map.Entry<String, List<Map<String, Log4jWarningErrorMetricsAppender.Element>>> source : sources
        .entrySet()) {
        String type = source.getKey();
        List<Map<String, Log4jWarningErrorMetricsAppender.Element>> data =
            source.getValue();
        if (data.size() > 0) {
          Map<String, Log4jWarningErrorMetricsAppender.Element> map = data.get(0);
          for (Map.Entry<String, Log4jWarningErrorMetricsAppender.Element> entry : map
            .entrySet()) {
            String message = entry.getKey();
            Hamlet.TR<Hamlet.TBODY<Hamlet.TABLE<Hamlet>>> row =
                errorsTable.tr();
            Hamlet.TD<Hamlet.TR<Hamlet.TBODY<Hamlet.TABLE<Hamlet>>>> cell =
                row.td();
            if (message.length() > maxDisplayLength || message.contains("\n")) {
              String displayMessage = entry.getKey().split("\n")[0];
              if (displayMessage.length() > maxDisplayLength) {
                displayMessage = displayMessage.substring(0, maxDisplayLength);
              }

              cell.pre().a().$href("#").$onclick("toggleContent(this);")
                .$style("white-space: pre").__(displayMessage).__().__().div()
                .$class("toggle-content").pre().__(message).__().__().__();
            } else {
              cell.pre().__(message).__().__();
            }
            Log4jWarningErrorMetricsAppender.Element ele = entry.getValue();
            row.td(type).td(String.valueOf(ele.count))
              .td(Times.format(ele.timestampSeconds * 1000)).__();
          }
        }
      }
      errorsTable.__().__();
    }
  }

  public static class MetricsBase extends HtmlBlock {
    List<Long> cutoffs;
    List<Integer> values;
    String tableHeading;
    Log4jWarningErrorMetricsAppender appender;

    MetricsBase(ViewContext ctx) {
      super(ctx);
      cutoffs = new ArrayList<>();

      // cutoff has to be in seconds
      long now = Time.now();
      cutoffs.add((now - 60 * 1000) / 1000);
      cutoffs.add((now - 300 * 1000) / 1000);
      cutoffs.add((now - 900 * 1000) / 1000);
      cutoffs.add((now - 3600 * 1000) / 1000);
      cutoffs.add((now - 21600 * 1000) / 1000);
      cutoffs.add((now - 43200 * 1000) / 1000);
      cutoffs.add((now - 84600 * 1000) / 1000);

      if (GenericsUtil.isLog4jLogger(ErrorsAndWarningsBlock.class)) {
        appender =
            Log4jWarningErrorMetricsAppender.findAppender();
      }
    }

    List<Long> getCutoffs() {
      return this.cutoffs;
    }

    @Override
    protected void render(Block html) {
      if (GenericsUtil.isLog4jLogger(ErrorsAndWarningsBlock.class)) {
        Hamlet.DIV<Hamlet> div =
            html.div().$class("metrics").$style("padding-bottom: 20px");
        div.h3(tableHeading).table("#metricsoverview").thead()
          .$class("ui-widget-header").tr().th().$class("ui-state-default")
          .__("Last 1 minute").__().th().$class("ui-state-default")
          .__("Last 5 minutes").__().th().$class("ui-state-default")
          .__("Last 15 minutes").__().th().$class("ui-state-default")
          .__("Last 1 hour").__().th().$class("ui-state-default")
          .__("Last 6 hours").__().th().$class("ui-state-default")
          .__("Last 12 hours").__().th().$class("ui-state-default")
          .__("Last 24 hours").__().__().__().tbody().$class("ui-widget-content")
          .tr().td(String.valueOf(values.get(0)))
          .td(String.valueOf(values.get(1))).td(String.valueOf(values.get(2)))
          .td(String.valueOf(values.get(3))).td(String.valueOf(values.get(4)))
          .td(String.valueOf(values.get(5))).td(String.valueOf(values.get(6)))
          .__().__().__();
        div.__();
      }
    }
  }

  public static class ErrorMetrics extends MetricsBase {

    @Inject
    ErrorMetrics(ViewContext ctx) {
      super(ctx);
      tableHeading = "Error Metrics";
    }

    @Override
    protected void render(Block html) {
      if (appender == null) {
        return;
      }
      values = appender.getErrorCounts(getCutoffs());
      super.render(html);
    }
  }

  public static class WarningMetrics extends MetricsBase {

    @Inject
    WarningMetrics(ViewContext ctx) {
      super(ctx);
      tableHeading = "Warning Metrics";
    }

    @Override
    protected void render(Block html) {
      if (appender == null) {
        return;
      }
      values = appender.getWarningCounts(getCutoffs());
      super.render(html);
    }
  }
}