com.couchbase.columnar.client.java.QueryMetrics Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of couchbase-columnar-java-client Show documentation
The official Couchbase Columnar Java SDK
The newest version!
/*
 * Copyright (c) 2018 Couchbase, Inc.
 *
 * Licensed 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 com.couchbase.columnar.client.java;

import com.couchbase.client.core.deps.com.fasterxml.jackson.core.JsonProcessingException;
import com.couchbase.client.core.deps.com.fasterxml.jackson.databind.JsonNode;
import com.couchbase.client.core.json.Mapper;
import com.couchbase.client.core.util.Golang;
import com.couchbase.columnar.client.java.internal.JacksonTransformers;

import java.io.IOException;
import java.time.Duration;
import java.util.Optional;

import static com.couchbase.client.core.logging.RedactableArgument.redactUser;

/**
 * Holds the metrics as returned from an analytics response.
 */
public final class QueryMetrics {

  /**
   * Provides a pointer into the root nodes of the raw response for easier decoding.
   */
  private final JsonNode rootNode;

  /**
   * Creates new {@link QueryMetrics} from the raw data.
   *
   * @param raw the raw analytics data.
   */
  QueryMetrics(final byte[] raw) {
    try {
      this.rootNode = JacksonTransformers.MAPPER.readTree(raw);
    } catch (IOException e) {
      throw new DataConversionException("Could not parse analytics metrics!", e);
    }
  }

  /**
   * @return The total time taken for the request, that is the time from when the
   * request was received until the results were returned, in a human-readable
   * format (eg. 123.45ms for a little over 123 milliseconds).
   */
  public Duration elapsedTime() {
    return decode(String.class, "elapsedTime").map(Golang::parseDuration).orElse(Duration.ZERO);
  }

  /**
   * @return The time taken for the execution of the request, that is the time from
   * when query execution started until the results were returned, in a human-readable
   * format (eg. 123.45ms for a little over 123 milliseconds).
   */
  public Duration executionTime() {
    return decode(String.class, "executionTime").map(Golang::parseDuration).orElse(Duration.ZERO);
  }

  /**
   * @return The total number of objects in the results.
   */
  public long resultCount() {
    return decode(Long.class, "resultCount").orElse(0L);
  }

  /**
   * @return The total number of bytes in the results.
   */
  public long resultSize() {
    return decode(Long.class, "resultSize").orElse(0L);
  }

  /**
   * @return The number of processed objects for the request.
   */
  public long processedObjects() {
    return decode(Long.class, "processedObjects").orElse(0L);
  }

  /**
   * Helper method to turn a given path of the raw data into the target class.
   *
   * @param target the target class to decode into.
   * @param path the path of the raw json.
   * @param  the generic type to decide into.
   * @return the generic decoded object if present and not null.
   */
  private  Optional decode(final Class target, final String path) {
    try {
      JsonNode subNode = rootNode.path(path);
      if (subNode == null || subNode.isNull() || subNode.isMissingNode()) {
        return Optional.empty();
      }
      return Optional.ofNullable(JacksonTransformers.MAPPER.treeToValue(subNode, target));
    } catch (JsonProcessingException e) {
      throw new DataConversionException("Could not decode " + path + " in analytics metrics!", e);
    }
  }

  @Override
  public String toString() {
    return "QueryMetrics{" +
      "raw=" + redactUser(Mapper.encodeAsString(rootNode)) +
      '}';
  }

}