com.wavefront.sdk.jersey.MetricNameUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wavefront-jersey-sdk-java Show documentation

Instruments Jersey-compliant APIs to send telemetry data to Wavefront from Java applications.

There is a newer version: 1.3.5

Show newest version

package com.wavefront.sdk.jersey;

import com.wavefront.sdk.common.Pair;

import org.apache.commons.lang3.StringUtils;
import org.glassfish.jersey.server.ContainerRequest;
import org.glassfish.jersey.server.model.Resource;

import java.util.Optional;

/**
 * A utils class to generate metric name for Jersey based application requests/responses.
 *
 * @author Sushant Dewan ([email protected]).
 */
abstract class MetricNameUtils {

  static final String REQUEST_PREFIX = "request.";
  static final String RESPONSE_PREFIX = "response.";

  /**
   * Provides the api path which is metric name friendly and the matching api path.
   *
   * @param request jersey container request.
   * @return API path for use in metric name.
   */
  static Optional> metricNameAndPath(ContainerRequest request) {
    Resource matchedResource = request.getUriInfo().getMatchedModelResource();
    if (matchedResource != null) {
      StringBuilder matchingPath = new StringBuilder(stripLeadingAndTrailingSlashes(
          matchedResource.getPath()));
      // prepend the path for every parent
      while (matchedResource.getParent() != null) {
        matchedResource = matchedResource.getParent();
        matchingPath.insert(0, stripLeadingAndTrailingSlashes(matchedResource.getPath()) + "/");
      }
      Optional optionalMetricName = metricName(request.getMethod(),
          matchingPath.toString());
      return optionalMetricName.map(
          metricName -> new Pair<>(metricName, matchingPath.toString()));
    }
    return Optional.empty();
  }

  /**
   * Accepts a resource method and extracts the path and turns slashes into dots to be more metric
   * friendly. Might return empty metric name if all the original characters in the string are not
   * metric friendly.
   *
   * @param httpMethod Jersey API HTTP request method.
   * @param path       Jersey API request relative path.
   * @return generated metric name from the original request.
   */
  private static Optional metricName(String httpMethod, String path) {
    String metricId = stripLeadingAndTrailingSlashes(path);
    // prevents metrics from trying to create object names with weird characters
    // swagger-ui introduces a route: api-docs/{route: .+} and the colon must be removed
    metricId = metricId.replace('/', '.').replace(":", "").
        replace("{", "_").replace("}", "_");
    if (StringUtils.isBlank(metricId)) {
      return Optional.empty();
    }

    return Optional.of(metricId + "." + httpMethod);
  }

  private static String stripLeadingAndTrailingSlashes(String path) {
    return path == null ? "" : StringUtils.strip(path, "/");
  }
}