org.apache.spark.groupon.metrics.MetricMessage.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spark-metrics Show documentation

A library to expose more of Apache Spark's metrics system

There is a newer version: 2.0.0

/*
 * Copyright (c) 2016, Groupon, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * Neither the name of GROUPON nor the names of its contributors may be
 * used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.apache.spark.groupon.metrics

import com.codahale.metrics.{Clock, Reservoir}

/**
 * [[MetricMessage]] contains the data and metadata about a metric data point.
 *
 * Each [[MetricMessage]] has the metric value itself and metadata about the type of [[com.codahale.metrics.Metric]]
 * that it belongs to.
 */
sealed trait MetricMessage {
  val metricName: String
  val value: AnyVal
}

private[metrics] case class CounterMessage(
    override val metricName: String,
    override val value: Long) extends MetricMessage

private[metrics] case class GaugeMessage(
    override val metricName: String,
    override val value: AnyVal)
  extends MetricMessage

private[metrics] case class HistogramMessage(
    override val metricName: String,
    override val value: Long,
    reservoirClass: Class[_ <: Reservoir]) extends MetricMessage

private[metrics] case class MeterMessage(
    override val metricName: String,
    override val value: Long)
  extends MetricMessage

private[metrics] case class TimerMessage(
    override val metricName: String,
    override val value: Long,
    reservoirClass: Class[_ <: Reservoir],
    clockClass: Class[_ <: Clock])
  extends MetricMessage