arangodb/arangod/Aql/QueryList.h

////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2014-2016 ArangoDB GmbH, Cologne, Germany
/// Copyright 2004-2014 triAGENS GmbH, Cologne, Germany
///
/// 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.
///
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
///
/// @author Jan Steemann
////////////////////////////////////////////////////////////////////////////////

#ifndef ARANGOD_AQL_QUERY_LIST_H
#define ARANGOD_AQL_QUERY_LIST_H 1

#include "Aql/QueryExecutionState.h"
#include "Basics/Common.h"
#include "Basics/ReadWriteLock.h"
#include "VocBase/voc-types.h"

#include <list>

struct TRI_vocbase_t;

namespace arangodb {
namespace velocypack {
class Builder;
}

namespace aql {

class Query;

struct QueryEntryCopy {
  QueryEntryCopy(TRI_voc_tick_t id, std::string&& queryString,
                 std::shared_ptr<arangodb::velocypack::Builder> const& bindParameters,
                 double started, double runTime,
                 QueryExecutionState::ValueType state, bool stream);

  TRI_voc_tick_t const id;
  std::string const queryString;
  std::shared_ptr<arangodb::velocypack::Builder> const bindParameters;
  double const started;
  double const runTime;
  QueryExecutionState::ValueType const state;
  bool stream;
};

class QueryList {
 public:
  /// @brief create a query list
  explicit QueryList(TRI_vocbase_t*);

  /// @brief destroy a query list
  ~QueryList() = default;

 public:
  /// @brief whether or not queries are tracked
  /// we're not using a lock here for performance reasons - thus concurrent
  /// modifications of this variable are possible but are considered unharmful
  inline bool enabled() const {
    return _enabled.load(std::memory_order_relaxed);
  }

  /// @brief toggle query tracking
  /// we're not using a lock here for performance reasons - thus concurrent
  /// modifications of this variable are possible but are considered unharmful
  inline void enabled(bool value) { _enabled.store(value); }

  /// @brief whether or not slow queries are tracked
  /// we're not using a lock here for performance reasons - thus concurrent
  /// modifications of this variable are possible but are considered unharmful
  inline bool trackSlowQueries() const {
    return _trackSlowQueries.load(std::memory_order_relaxed);
  }

  /// @brief toggle slow query tracking
  /// we're not using a lock here for performance reasons - thus concurrent
  /// modifications of this variable are possible but are considered unharmful
  inline void trackSlowQueries(bool value) { _trackSlowQueries.store(value); }

  /// @brief whether or not bind vars are tracked with queries
  /// we're not using a lock here for performance reasons - thus concurrent
  /// modifications of this variable are possible but are considered unharmful
  inline bool trackBindVars() const {
    return _trackBindVars.load(std::memory_order_relaxed);
  }

  /// @brief toggle query bind vars tracking
  /// we're not using a lock here for performance reasons - thus concurrent
  /// modifications of this variable are possible but are considered unharmful
  inline void trackBindVars(bool value) { _trackBindVars.store(value); }

  /// @brief threshold for slow queries (in seconds)
  /// we're not using a lock here for performance reasons - thus concurrent
  /// modifications of this variable are possible but are considered unharmful
  inline double slowQueryThreshold() const {
    return _slowQueryThreshold.load(std::memory_order_relaxed);
  }

  /// @brief set the slow query threshold
  /// we're not using a lock here for performance reasons - thus concurrent
  /// modifications of this variable are possible but are considered unharmful
  inline void slowQueryThreshold(double value) {
    if (value < 0.0 || value == HUGE_VAL || value != value) {
      // sanity checks
      value = 0.0;
    }
    _slowQueryThreshold.store(value);
  }

  /// @brief threshold for slow streaming queries (in seconds)
  /// we're not using a lock here for performance reasons - thus concurrent
  /// modifications of this variable are possible but are considered unharmful
  inline double slowStreamingQueryThreshold() const {
    return _slowStreamingQueryThreshold.load(std::memory_order_relaxed);
  }

  /// @brief set the slow streaming query threshold
  /// we're not using a lock here for performance reasons - thus concurrent
  /// modifications of this variable are possible but are considered unharmful
  inline void slowStreamingQueryThreshold(double value) {
    if (value < 0.0 || value == HUGE_VAL || value != value) {
      // sanity checks
      value = 0.0;
    }
    _slowStreamingQueryThreshold.store(value);
  }

  /// @brief return the max number of slow queries to keep
  /// we're not using a lock here for performance reasons - thus concurrent
  /// modifications of this variable are possible but are considered unharmful
  inline size_t maxSlowQueries() const {
    return _maxSlowQueries.load(std::memory_order_relaxed);
  }

  /// @brief set the max number of slow queries to keep
  /// we're not using a lock here for performance reasons - thus concurrent
  /// modifications of this variable are possible but are considered unharmful
  inline void maxSlowQueries(size_t value) {
    if (value > 16384) {
      // sanity checks
      value = 16384;
    }
    _maxSlowQueries.store(value);
  }

  /// @brief return the max length of query strings that are stored / returned
  /// we're not using a lock here for performance reasons - thus concurrent
  /// modifications of this variable are possible but are considered unharmful
  inline size_t maxQueryStringLength() const {
    return _maxQueryStringLength.load(std::memory_order_relaxed);
  }

  /// @brief set the max length of query strings that are stored / returned
  /// we're not using a lock here for performance reasons - thus concurrent
  /// modifications of this variable are possible but are considered unharmful
  inline void maxQueryStringLength(size_t value) {
    // sanity checks
    if (value < 64) {
      value = 64;
    } else if (value >= 8 * 1024 * 1024) {
      value = 8 * 1024 * 1024;
    }

    _maxQueryStringLength.store(value);
  }

  /// @brief enter a query
  bool insert(Query*);

  /// @brief remove a query
  void remove(Query*);

  /// @brief kills a query
  Result kill(TRI_voc_tick_t id);

  /// @brief kills all currently running queries that match the filter function
  /// (i.e. the filter should return true for a queries to be killed)
  uint64_t kill(std::function<bool(Query&)> const& filter, bool silent);

  /// @brief return the list of running queries
  std::vector<QueryEntryCopy> listCurrent();

  /// @brief return the list of slow queries
  std::vector<QueryEntryCopy> listSlow();

  /// @brief clear the list of slow queries
  void clearSlow();

  size_t count();

 private:
  std::string extractQueryString(Query const* query, size_t maxLength) const;

  /// @brief default maximum number of slow queries to keep in list
  static constexpr size_t defaultMaxSlowQueries = 64;

  /// @brief default max length of a query when returning it
  static constexpr size_t defaultMaxQueryStringLength = 4096;

 private:
  /// @brief r/w lock for the list
  arangodb::basics::ReadWriteLock _lock;

  /// @brief list of current queries
  std::unordered_map<TRI_voc_tick_t, Query*> _current;

  /// @brief list of slow queries
  std::list<QueryEntryCopy> _slow;

  /// @brief current number of slow queries
  size_t _slowCount;

  /// @brief whether or not queries are tracked
  std::atomic<bool> _enabled;

  /// @brief whether or not slow queries are tracked
  std::atomic<bool> _trackSlowQueries;

  /// @brief whether or not bind vars are also tracked with queries
  std::atomic<bool> _trackBindVars;

  /// @brief threshold for slow queries (in seconds)
  std::atomic<double> _slowQueryThreshold;

  /// @brief threshold for slow streaming queries (in seconds)
  std::atomic<double> _slowStreamingQueryThreshold;

  /// @brief maximum number of slow queries to keep
  std::atomic<size_t> _maxSlowQueries;

  /// @brief max length of query strings to return
  std::atomic<size_t> _maxQueryStringLength;
};
}  // namespace aql
}  // namespace arangodb

#endif