alluxio-master-2.x/core/common/src/test/java/alluxio/metrics/MetricsSystemTest.java
/*
 * The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
 * (the "License"). You may not use this work except in compliance with the License, which is
 * available at www.apache.org/licenses/LICENSE-2.0
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied, as more fully set forth in the License.
 *
 * See the NOTICE file distributed with this work for information regarding copyright ownership.
 */

package alluxio.metrics;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;

import alluxio.AlluxioTestDirectory;
import alluxio.AlluxioURI;
import alluxio.grpc.MetricType;

import com.codahale.metrics.Counter;
import org.junit.Before;
import org.junit.Test;

import java.io.File;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Properties;
import java.util.Set;

/**
 * Unit tests for {@link MetricsSystem}.
 */
public final class MetricsSystemTest {

  /**
   * Sets up the properties for the configuration of the metrics before a test runs.
   */
  @Before
  public final void before() {
    MetricsSystem.resetAllMetrics();
  }

  @Test
  public void multipleSinksTest() {
    Properties metricsProps = new Properties();
    metricsProps.setProperty("sink.console.class", "alluxio.metrics.sink.ConsoleSink");
    metricsProps.setProperty("sink.console.period", "20");
    metricsProps.setProperty("sink.console.period", "20");
    metricsProps.setProperty("sink.console.unit", "minutes");
    metricsProps.setProperty("sink.jmx.class", "alluxio.metrics.sink.JmxSink");
    MetricsConfig metricsConfig = new MetricsConfig(metricsProps);
    MetricsSystem.startSinksFromConfig(metricsConfig);

    assertEquals(2, MetricsSystem.getNumSinks());

    MetricsSystem.stopSinks();
  }

  @Test
  public void startStopSinkTest() throws Exception {
    File workerDirectory =
        AlluxioTestDirectory.createTemporaryDirectory("sinks");
    Properties properties = new Properties();
    properties.put("sink.csv.class", "alluxio.metrics.sink.CsvSink");
    properties.put("sink.csv.period", "1");
    properties.put("sink.csv.unit", "seconds");
    properties.put("sink.csv.directory", workerDirectory.getAbsolutePath());
    MetricsConfig config = new MetricsConfig(properties);
    MetricsSystem.startSinksFromConfig(config);

    String counterName = "Master.CounterForSinkTest";
    MetricsSystem.counter(counterName).inc(100);
    // Sleep 2 seconds to make sure sinks do happen and include the new metrics changes
    Thread.sleep(2000);
    String[] pathNames = workerDirectory.list();
    assertNotNull(pathNames);
    Set<String> filesSet = new HashSet<>(Arrays.asList(pathNames));
    assertNotEquals(0, filesSet.size());
    assertTrue(filesSet.contains(counterName + ".csv"));

    MetricsSystem.stopSinks();

    String meterName = "Master.MeterForSinkTest";
    MetricsSystem.meter(meterName).mark(1000);
    pathNames = workerDirectory.list();
    assertNotNull(pathNames);
    filesSet = new HashSet<>(Arrays.asList(pathNames));
    assertTrue(!filesSet.contains(meterName + ".csv"));
  }

  /**
   * Tests the "/" "." and "%" special characters can be escaped.
   */
  @Test
  public void testEscape() {
    AlluxioURI localUri1 = new AlluxioURI("/foo/alluxio/underFSStorage");
    String localUriEscaped1 = MetricsSystem.escape(localUri1);
    assertEquals("%2Ffoo%2Falluxio%2FunderFSStorage",
            localUriEscaped1);

    AlluxioURI localUri2 = new AlluxioURI("/.alluxio.wololo/alluxio/underFSStorage");
    String localUriEscaped2 = MetricsSystem.escape(localUri2);
    assertEquals("%2F%2Ealluxio%2Ewololo%2Falluxio%2FunderFSStorage",
            localUriEscaped2);

    AlluxioURI localUri3 = new AlluxioURI("/%25alluxio%20user%2Ffoo%2Ebar/alluxio/underFSStorage");
    String localUriEscaped3 = MetricsSystem.escape(localUri3);
    assertEquals("%2F%2525alluxio%2520user%252Ffoo%252Ebar%2Falluxio%2FunderFSStorage",
            localUriEscaped3);

    AlluxioURI localUri4 = new AlluxioURI("s3a://test/Tasks+Export+%282017–11–05+06%3A10+PM%2Ecsv");
    String localUriEscaped4 = MetricsSystem.escape(localUri4);
    assertEquals("s3a:%2F%2Ftest%2FTasks+Export+%25282017–11–05+06%253A10+PM%252Ecsv",
            localUriEscaped4);
  }

  /**
   * Tests the escaped strings can be safely unescaped.
   */
  @Test
  public void testUnescape() {
    AlluxioURI localUri1 = new AlluxioURI("/foo/alluxio/underFSStorage");
    String localUriEscaped1 = MetricsSystem.escape(localUri1);
    String localUriUnescaped1 = MetricsSystem.unescape(localUriEscaped1);
    assertEquals(localUri1.toString(), localUriUnescaped1);

    AlluxioURI localUri2 = new AlluxioURI("/.alluxio.wololo/alluxio/underFSStorage");
    String localUriEscaped2 = MetricsSystem.escape(localUri2);
    String localUriUnescaped2 = MetricsSystem.unescape(localUriEscaped2);
    assertEquals(localUri2.toString(), localUriUnescaped2);

    AlluxioURI localUri3 = new AlluxioURI("/%25alluxio%20user%2Ffoo%2Ebar/alluxio/underFSStorage");
    String localUriEscaped3 = MetricsSystem.escape(localUri3);
    String localUriUnescaped3 = MetricsSystem.unescape(localUriEscaped3);
    assertEquals(localUri3.toString(), localUriUnescaped3);

    AlluxioURI localUri4 = new AlluxioURI("s3a://test/Tasks+Export+%282017–11–05+06%3A10+PM%2Ecsv");
    String localUriEscaped4 = MetricsSystem.escape(localUri4);
    String localUriUnescaped4 = MetricsSystem.unescape(localUriEscaped4);
    assertEquals(localUri4.toString(), localUriUnescaped4);
  }

  @Test
  public void testReportWorkerMetrics() {
    String metricName = "Worker.TestMetric";
    Counter counter = MetricsSystem.counter(metricName);
    if (!MetricKey.isValid(metricName)) {
      MetricKey.register(new MetricKey.Builder(metricName)
          .setMetricType(MetricType.COUNTER).setIsClusterAggregated(true).build());
      MetricsSystem.initShouldReportMetrics(MetricsSystem.InstanceType.WORKER);
    }
    counter.inc();
    assertEquals(1.0, MetricsSystem.reportWorkerMetrics().get(0).getValue(), 0);
    assertEquals(0, MetricsSystem.reportWorkerMetrics().size());
    counter.inc();
    assertEquals(1.0, MetricsSystem.reportWorkerMetrics().get(0).getValue(), 0);
  }

  @Test
  public void testReportClientMetrics() {
    String metricName = "Client.TestMetric";
    Counter counter = MetricsSystem.counter(metricName);
    if (!MetricKey.isValid(metricName)) {
      MetricKey.register(new MetricKey.Builder(metricName)
          .setMetricType(MetricType.COUNTER).setIsClusterAggregated(true).build());
    }
    counter.inc(5);
    assertEquals(5.0, MetricsSystem.reportClientMetrics().get(0).getValue(), 0);
    assertEquals(0, MetricsSystem.reportClientMetrics().size());
    counter.inc(2);
    assertEquals(2.0, MetricsSystem.reportClientMetrics().get(0).getValue(), 0);
    assertEquals(0, MetricsSystem.reportClientMetrics().size());
  }

  @Test
  public void testResetAllMetrics() {
    String counterName = "Worker.Counter";
    MetricsSystem.counter(counterName).inc();
    assertEquals(1, MetricsSystem.counter(counterName).getCount());

    String meterName = "Worker.Meter";
    MetricsSystem.meter(meterName).mark(1000);
    assertEquals(1000, MetricsSystem.meter(meterName).getCount());

    String timerName = "Worker.Timer";
    MetricsSystem.timer(timerName).time().close();
    assertEquals(1, MetricsSystem.timer(timerName).getCount());

    MetricsSystem.resetAllMetrics();
    assertEquals(0, MetricsSystem.counter(counterName).getCount());
    assertEquals(0, MetricsSystem.meter(meterName).getCount());
    assertEquals(0, MetricsSystem.reportWorkerMetrics().size());
    assertEquals(0, MetricsSystem.timer(timerName).getCount());
  }

  @Test
  public void getMetricNameTest() {
    assertEquals("Cluster.counter", MetricsSystem.getMetricName("Cluster.counter"));
    assertEquals("Master.timer", MetricsSystem.getMetricName("Master.timer"));
    String workerGaugeName = "Worker.gauge";
    assertNotEquals(workerGaugeName, MetricsSystem.getMetricName(workerGaugeName));
    assertTrue(MetricsSystem.getMetricName(workerGaugeName).startsWith(workerGaugeName));
    String clientCounterName = "Client.counter";
    assertNotEquals(clientCounterName, MetricsSystem.getMetricName(clientCounterName));
    assertTrue(MetricsSystem.getMetricName(clientCounterName).startsWith(clientCounterName));
  }

  @Test
  public void stripInstanceAndHostTest() {
    assertEquals("name", MetricsSystem.stripInstanceAndHost("Master.name"));
    assertEquals("name", MetricsSystem.stripInstanceAndHost("Worker.name.10_0_0_136"));
    assertEquals("name.UFS:ufs", MetricsSystem.stripInstanceAndHost("Client.name.UFS:ufs.0_0_0_0"));
    assertEquals("name.UFS:ufs.UFS_TYPE:local",
        MetricsSystem.stripInstanceAndHost("Worker.name.UFS:ufs.UFS_TYPE:local.0_0_0_0"));
  }
}
