TelemetryLogger.h

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * 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.
 */
 
#pragma once
 
#include <atomic>
#include <memory>
#include <string>
 
#include <vrs/VrsExport.h>
 
namespace vrs {
 
using std::string;
using std::unique_ptr;
 
struct VRS_API OperationContext {
  string operation;
  string sourceLocation;
 
  OperationContext() = default;
  OperationContext(string op, string sourceLoc)
      : operation{std::move(op)}, sourceLocation{std::move(sourceLoc)} {}
  OperationContext(const OperationContext& rhs) = default;
  OperationContext(OperationContext&& rhs) noexcept = default;
  ~OperationContext() = default;
 
  OperationContext& operator=(const OperationContext& rhs) = default;
  OperationContext& operator=(OperationContext&& rhs) noexcept = default;
 
  bool operator<(const OperationContext& rhs) const {
    auto tie = [](const OperationContext& oc) { return std::tie(oc.operation, oc.sourceLocation); };
    return tie(*this) < tie(rhs);
  }
};
 
struct VRS_API LogEvent {
  LogEvent() = default;
  LogEvent(string type, OperationContext opContext, string message, string serverReply)
      : type{std::move(type)},
        operationContext{std::move(opContext)},
        message{std::move(message)},
        serverReply{std::move(serverReply)} {}
  LogEvent(const LogEvent& rhs) = default;
  LogEvent(LogEvent&& rhs) noexcept = default;
  ~LogEvent() = default;
 
  LogEvent& operator=(const LogEvent& rhs) = default;
  LogEvent& operator=(LogEvent&& rhs) noexcept = default;
 
  string type;
  OperationContext operationContext;
  string message;
  string serverReply;
};
 
struct VRS_API TrafficEvent {
  bool isSuccess = false;
  bool uploadNotDownload = false;
  int64_t transferStartTime = 0; // start time
  int64_t totalDurationMs = -1; // overall request duration, including retries
  int64_t transferDurationMs = -1; // last network transfer duration (last attempt)
  size_t transferOffset = 0; // offset to read from
  size_t transferRequestSize = 0; // bytes
  size_t transferSize = 0; // bytes
  size_t retryCount = 0;
  size_t errorCount = 0;
  size_t error429Count = 0;
  long httpStatus = -1;
  string serverName;
 
  TrafficEvent& setIsSuccess(bool success) {
    isSuccess = success;
    return *this;
  }
  TrafficEvent& setIsUpload() {
    uploadNotDownload = true;
    return *this;
  }
  TrafficEvent& setIsDownload() {
    uploadNotDownload = false;
    return *this;
  }
  TrafficEvent& setAttemptStartTime();
  TrafficEvent& setTotalDurationMs(int64_t durationMs) {
    totalDurationMs = durationMs;
    return *this;
  }
  TrafficEvent& setTransferDurationMs(int64_t aTransferDurationMs) {
    transferDurationMs = aTransferDurationMs;
    return *this;
  }
  TrafficEvent& setTransferOffset(size_t offset) {
    transferOffset = offset;
    return *this;
  }
  TrafficEvent& setTransferRequestSize(size_t aTransferRequestSize) {
    transferRequestSize = aTransferRequestSize;
    return *this;
  }
  TrafficEvent& setTransferSize(size_t aTransferSize) {
    transferSize = aTransferSize;
    return *this;
  }
  TrafficEvent& setRetryCount(size_t aRetryCount) {
    retryCount = aRetryCount;
    return *this;
  }
  TrafficEvent& setError429Count(size_t anError429Count) {
    error429Count = anError429Count;
    return *this;
  }
  TrafficEvent& setErrorCount(size_t anErrorCount) {
    errorCount = anErrorCount;
    return *this;
  }
  TrafficEvent& setHttpStatus(long status) {
    httpStatus = status;
    return *this;
  }
  TrafficEvent& setUrl(const string& aServerName);
};
 
class VRS_API TelemetryLogger {
 public:
  virtual ~TelemetryLogger();
 
  static constexpr const char* kErrorType = "error";
  static constexpr const char* kWarningType = "warning";
  static constexpr const char* kInfoType = "info";
 
  static void setLogger(unique_ptr<TelemetryLogger> telemetryLogger = nullptr);
 
  static inline void error(
      const OperationContext& operationContext,
      const string& message,
      const string& serverMessage = {}) {
    getInstance()->logEvent(LogEvent(kErrorType, operationContext, message, serverMessage));
  }
  static inline void warning(
      const OperationContext& operationContext,
      const string& message,
      const string& serverMessage = {}) {
    getInstance()->logEvent(LogEvent(kWarningType, operationContext, message, serverMessage));
  }
  static inline void info(
      const OperationContext& operationContext,
      const string& message,
      const string& serverMessage = {}) {
    getInstance()->logEvent(LogEvent(kInfoType, operationContext, message, serverMessage));
  }
  static inline void event(
      const string& eventType,
      const OperationContext& operationContext,
      const string& message,
      const string& serverMessage = {}) {
    getInstance()->logEvent(LogEvent(eventType, operationContext, message, serverMessage));
  }
  static inline void traffic(const OperationContext& operationContext, const TrafficEvent& event) {
    getInstance()->logTraffic(operationContext, event);
  }
  static inline void flush() {
    getInstance()->flushEvents();
  }
 
  virtual void logEvent(LogEvent&& event);
  virtual void logTraffic(const OperationContext& operationContext, const TrafficEvent& event);
  virtual void flushEvents() {}
 
  virtual void start() {}
  virtual void stop() {}
 
 private:
  static TelemetryLogger* getDefaultLogger();
  static std::atomic<TelemetryLogger*>& getCurrentLogger();
 
  static inline TelemetryLogger* getInstance() {
    return getCurrentLogger().load(std::memory_order_relaxed);
  }
};
 
} // namespace vrs