src/developer/system_monitor/bin/harvester/dockyard_proxy.h

// Copyright 2019 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SRC_DEVELOPER_SYSTEM_MONITOR_BIN_HARVESTER_DOCKYARD_PROXY_H_
#define SRC_DEVELOPER_SYSTEM_MONITOR_BIN_HARVESTER_DOCKYARD_PROXY_H_

#include <zircon/types.h>

#include <iostream>
#include <string>

#include "src/developer/system_monitor/lib/dockyard/dockyard.h"

namespace harvester {

using SampleList = std::vector<std::pair<const std::string, uint64_t>>;
using SampleListById = std::vector<std::pair<uint64_t, uint64_t>>;
using StringSampleList =
    std::vector<std::pair<const std::string, const std::string>>;

enum class DockyardProxyStatus : int {
  OK = 0,
  ERROR = -1,
};

// Combine the |cmd| name that created the error with the |err| to create a
// human readable error message.
std::string DockyardErrorString(const std::string& cmd,
                                DockyardProxyStatus err);

// Convert the |status| (enum) into a human readable string.
std::ostream& operator<<(std::ostream& out, const DockyardProxyStatus& status);

// A proxy for a remote Dockyard.
// See //src/developer/system_monitor/lib/dockyard/dockyard.h
class DockyardProxy {
 public:
  virtual ~DockyardProxy() {}

  // Initialize the DockyardProxy.
  virtual DockyardProxyStatus Init() = 0;

  // Send log data to the Dockyard.
  virtual DockyardProxyStatus SendLogs(
      const std::vector<const std::string>& batch) = 0;

  // Send inspection data to the Dockyard.
  virtual DockyardProxyStatus SendInspectJson(const std::string& stream_name,
                                              const std::string& json) = 0;

  // Send a single sample to the Dockyard.
  virtual DockyardProxyStatus SendSample(const std::string& stream_name,
                                         uint64_t value) = 0;

  // Send a list of samples with the same timestamp to the Dockyard.
  virtual DockyardProxyStatus SendSampleList(const SampleList& list) = 0;

  virtual DockyardProxyStatus SendStringSampleList(
      const StringSampleList& list) = 0;

  virtual DockyardProxyStatus SendSamples(
      const SampleList& int_samples,
      const StringSampleList& string_samples) = 0;
};

}  // namespace harvester

#endif  // SRC_DEVELOPER_SYSTEM_MONITOR_BIN_HARVESTER_DOCKYARD_PROXY_H_