content: /*
   * 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.camel.component.metrics.routepolicy;
  
  import java.util.concurrent.TimeUnit;
  import java.util.regex.Matcher;
  
  import com.codahale.metrics.MetricRegistry;
  import com.codahale.metrics.Timer;
  import org.apache.camel.CamelContext;
  import org.apache.camel.Exchange;
  import org.apache.camel.NonManagedService;
  import org.apache.camel.Route;
  import org.apache.camel.RuntimeCamelException;
  import org.apache.camel.spi.ManagementStrategy;
  import org.apache.camel.support.RoutePolicySupport;
  
  /**
   * A {@link org.apache.camel.spi.RoutePolicy} which gathers statistics and reports them using
   * {@link com.codahale.metrics.MetricRegistry}.
   * <p/>
   * The metrics is reported in JMX by default, but this can be configured.
   */
  public class MetricsRoutePolicy extends RoutePolicySupport implements NonManagedService {
  
      public static final String NAME_TOKEN = "##name##";
      public static final String ROUTE_ID_TOKEN = "##routeId##";
      public static final String TYPE_TOKEN = "##type##";
  
      private MetricRegistry metricsRegistry;
      private MetricsRegistryService registryService;
      private boolean useJmx = true;
      private String jmxDomain = "org.apache.camel.metrics";
      private boolean prettyPrint;
      private TimeUnit rateUnit = TimeUnit.SECONDS;
      private TimeUnit durationUnit = TimeUnit.MILLISECONDS;
      private MetricsStatistics statistics;
      private Route route;
      private String namePattern = String.format("%s.%s.%s", NAME_TOKEN, ROUTE_ID_TOKEN, TYPE_TOKEN);
      boolean registerKamelets;
      boolean registerTemplates = true;
  
      private static final class MetricsStatistics {
          private final String routeId;
          private final Timer responses;
  
          private MetricsStatistics(Route route, Timer responses) {
              this.routeId = route.getId();
              this.responses = responses;
          }
  
          public void onExchangeBegin(Exchange exchange) {
              Timer.Context context = responses.time();
              exchange.setProperty("MetricsRoutePolicy-" + routeId, context);
          }
  
          public void onExchangeDone(Exchange exchange) {
              Timer.Context context = (Timer.Context) exchange.removeProperty("MetricsRoutePolicy-" + routeId);
              if (context != null) {
                  context.stop();
              }
          }
      }
  
      public MetricRegistry getMetricsRegistry() {
          return metricsRegistry;
      }
  
      public void setMetricsRegistry(MetricRegistry metricsRegistry) {
          this.metricsRegistry = metricsRegistry;
      }
  
      public boolean isUseJmx() {
          return useJmx;
      }
  
      public void setUseJmx(boolean useJmx) {
          this.useJmx = useJmx;
      }
  
      public String getJmxDomain() {
          return jmxDomain;
      }
  
      public void setJmxDomain(String jmxDomain) {
          this.jmxDomain = jmxDomain;
      }
  
      public boolean isPrettyPrint() {
          return prettyPrint;
      }
  
      public void setPrettyPrint(boolean prettyPrint) {
          this.prettyPrint = prettyPrint;
      }
  
      public TimeUnit getRateUnit() {
          return rateUnit;
      }
  
      public void setRateUnit(TimeUnit rateUnit) {
          this.rateUnit = rateUnit;
      }
  
      public TimeUnit getDurationUnit() {
          return durationUnit;
      }
  
      public void setDurationUnit(TimeUnit durationUnit) {
          this.durationUnit = durationUnit;
      }
  
      public String getNamePattern() {
          return namePattern;
      }
  
      /**
       * The name pattern to use.
       * <p/>
       * Uses dot as separators, but you can change that. The values <tt>##name##</tt>, <tt>##routeId##</tt>, and
       * <tt>##type##</tt> will be replaced with actual value.
       */
      public void setNamePattern(String namePattern) {
          this.namePattern = namePattern;
      }
  
      @Override
      public void onInit(Route route) {
          super.onInit(route);
  
          ManagementStrategy ms = route.getCamelContext().getManagementStrategy();
          if (ms != null && ms.getManagementAgent() != null) {
              registerKamelets = ms.getManagementAgent().getRegisterRoutesCreateByKamelet();
              registerTemplates = ms.getManagementAgent().getRegisterRoutesCreateByTemplate();
          }
  
          this.route = route;
          try {
              registryService = route.getCamelContext().hasService(MetricsRegistryService.class);
              if (registryService == null) {
                  registryService = new MetricsRegistryService();
                  registryService.setMetricsRegistry(getMetricsRegistry());
                  registryService.setUseJmx(isUseJmx());
                  registryService.setJmxDomain(getJmxDomain());
                  registryService.setPrettyPrint(isPrettyPrint());
                  registryService.setRateUnit(getRateUnit());
                  registryService.setDurationUnit(getDurationUnit());
                  route.getCamelContext().addService(registryService);
              }
          } catch (Exception e) {
              throw RuntimeCamelException.wrapRuntimeCamelException(e);
          }
  
          // skip routes that should not be included
          boolean skip = (route.isCreatedByKamelet() && !registerKamelets)
                  || (route.isCreatedByRouteTemplate() && !registerTemplates);
          if (!skip) {
              // create statistics holder
              // for know we record only all the timings of a complete exchange (responses)
              // we have in-flight / total statistics already from camel-core
              Timer responses = registryService.getMetricsRegistry().timer(createName("responses"));
              statistics = new MetricsStatistics(route, responses);
          }
      }
  
      private String createName(String type) {
          CamelContext context = route.getCamelContext();
          String name = context.getManagementName() != null ? context.getManagementName() : context.getName();
  
          String answer = namePattern;
          answer = answer.replaceFirst(NAME_TOKEN, name);
          answer = answer.replaceFirst(ROUTE_ID_TOKEN, Matcher.quoteReplacement(route.getId()));
          answer = answer.replaceFirst(TYPE_TOKEN, type);
          return answer;
      }
  
      @Override
      public void onExchangeBegin(Route route, Exchange exchange) {
          if (statistics != null) {
              statistics.onExchangeBegin(exchange);
          }
      }
  
      @Override
      public void onExchangeDone(Route route, Exchange exchange) {
          if (statistics != null) {
              statistics.onExchangeDone(exchange);
          }
      }
  
  }
  