the-algorithm/visibilitylib/src/main/scala/com/twitter/visibility/engine/VisibilityResultsMetricRecorder.scala

package com.twitter.visibility.engine

import com.twitter.finagle.stats.NullStatsReceiver
import com.twitter.finagle.stats.StatsReceiver
import com.twitter.finagle.stats.Verbosity
import com.twitter.servo.util.Gate
import com.twitter.servo.util.MemoizingStatsReceiver
import com.twitter.visibility.builder.VisibilityResult
import com.twitter.visibility.features.Feature
import com.twitter.visibility.models.SafetyLevel
import com.twitter.visibility.rules.NotEvaluated
import com.twitter.visibility.rules.RuleResult
import com.twitter.visibility.rules.State
import com.twitter.visibility.rules.State.Disabled
import com.twitter.visibility.rules.State.FeatureFailed
import com.twitter.visibility.rules.State.MissingFeature
import com.twitter.visibility.rules.State.RuleFailed
import com.twitter.visibility.rules.Action


case class VisibilityResultsMetricRecorder(
  statsReceiver: StatsReceiver,
  captureDebugStats: Gate[Unit]) {

  private val scopedStatsReceiver = new MemoizingStatsReceiver(
    statsReceiver.scope("visibility_rule_engine")
  )
  private val actionStats: StatsReceiver = scopedStatsReceiver.scope("by_action")
  private val featureFailureReceiver: StatsReceiver =
    scopedStatsReceiver.scope("feature_failed")
  private val safetyLevelStatsReceiver: StatsReceiver =
    scopedStatsReceiver.scope("from_safety_level")
  private val ruleStatsReceiver: StatsReceiver = scopedStatsReceiver.scope("for_rule")
  private val ruleFailureReceiver: StatsReceiver =
    scopedStatsReceiver.scope("rule_failures")
  private val failClosedReceiver: StatsReceiver =
    scopedStatsReceiver.scope("fail_closed")
  private val ruleStatsBySafetyLevelReceiver: StatsReceiver =
    scopedStatsReceiver.scope("for_rule_by_safety_level")

  def recordSuccess(
    safetyLevel: SafetyLevel,
    result: VisibilityResult
  ): Unit = {
    recordAction(safetyLevel, result.verdict.fullName)

    val isFeatureFailure = result.ruleResultMap.values
      .collectFirst {
        case RuleResult(_, FeatureFailed(_)) =>
          ruleFailureReceiver.counter("feature_failed").incr()
          true
      }.getOrElse(false)

    val isMissingFeature = result.ruleResultMap.values
      .collectFirst {
        case RuleResult(_, MissingFeature(_)) =>
          ruleFailureReceiver.counter("missing_feature").incr()
          true
      }.getOrElse(false)

    val isRuleFailed = result.ruleResultMap.values
      .collectFirst {
        case RuleResult(_, RuleFailed(_)) =>
          ruleFailureReceiver.counter("rule_failed").incr()
          true
      }.getOrElse(false)

    if (isFeatureFailure || isMissingFeature || isRuleFailed) {
      ruleFailureReceiver.counter().incr()
    }

    if (captureDebugStats()) {
      val ruleBySafetyLevelStat =
        ruleStatsBySafetyLevelReceiver.scope(safetyLevel.name)
      result.ruleResultMap.foreach {
        case (rule, ruleResult) => {
          ruleBySafetyLevelStat
            .scope(rule.name)
            .scope("action")
            .counter(Verbosity.Debug, ruleResult.action.fullName).incr()
          ruleBySafetyLevelStat
            .scope(rule.name)
            .scope("state")
            .counter(Verbosity.Debug, ruleResult.state.name).incr()
        }
      }
    }
  }

  def recordFailedFeature(
    failedFeature: Feature[_],
    exception: Throwable
  ): Unit = {
    featureFailureReceiver.counter().incr()

    val featureStat = featureFailureReceiver.scope(failedFeature.name)
    featureStat.counter().incr()
    featureStat.counter(exception.getClass.getName).incr()
  }

  def recordAction(
    safetyLevel: SafetyLevel,
    action: String
  ): Unit = {
    safetyLevelStatsReceiver.scope(safetyLevel.name).counter(action).incr()
    actionStats.counter(action).incr()
  }

  def recordUnknownSafetyLevel(
    safetyLevel: SafetyLevel
  ): Unit = {
    safetyLevelStatsReceiver
      .scope("unknown_safety_level")
      .counter(safetyLevel.name.toLowerCase).incr()
  }

  def recordRuleMissingFeatures(
    ruleName: String,
    missingFeatures: Set[Feature[_]]
  ): Unit = {
    val ruleStat = ruleStatsReceiver.scope(ruleName)
    missingFeatures.foreach { featureId =>
      ruleStat.scope("missing_feature").counter(featureId.name).incr()
    }
    ruleStat.scope("action").counter(NotEvaluated.fullName).incr()
    ruleStat.scope("state").counter(MissingFeature(missingFeatures).name).incr()
  }

  def recordRuleFailedFeatures(
    ruleName: String,
    failedFeatures: Map[Feature[_], Throwable]
  ): Unit = {
    val ruleStat = ruleStatsReceiver.scope(ruleName)

    ruleStat.scope("action").counter(NotEvaluated.fullName).incr()
    ruleStat.scope("state").counter(FeatureFailed(failedFeatures).name).incr()
  }

  def recordFailClosed(rule: String, state: State) {
    failClosedReceiver.scope(state.name).counter(rule).incr();
  }

  def recordRuleEvaluation(
    ruleName: String,
    action: Action,
    state: State
  ): Unit = {
    val ruleStat = ruleStatsReceiver.scope(ruleName)
    ruleStat.scope("action").counter(action.fullName).incr()
    ruleStat.scope("state").counter(state.name).incr()
  }


  def recordRuleFallbackAction(
    ruleName: String
  ): Unit = {
    val ruleStat = ruleStatsReceiver.scope(ruleName)
    ruleStat.counter("fallback_action").incr()
  }

  def recordRuleHoldBack(
    ruleName: String
  ): Unit = {
    ruleStatsReceiver.scope(ruleName).counter("heldback").incr()
  }

  def recordRuleFailed(
    ruleName: String
  ): Unit = {
    ruleStatsReceiver.scope(ruleName).counter("failed").incr()
  }

  def recordDisabledRule(
    ruleName: String
  ): Unit = recordRuleEvaluation(ruleName, NotEvaluated, Disabled)
}

object NullVisibilityResultsMetricsRecorder
    extends VisibilityResultsMetricRecorder(NullStatsReceiver, Gate.False)