tee_logging.h

Go to the documentation of this file.

//
// Copyright (C) 2020 The Android Open Source Project
//
// 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 <optional>
#include <string>
#include <vector>
 
#include <android-base/logging.h>
 
#include "cuttlefish/common/libs/fs/shared_fd.h"
#include "cuttlefish/common/libs/utils/result.h"
 
namespace cuttlefish {
 
std::string FromSeverity(android::base::LogSeverity severity);
Result<android::base::LogSeverity> ToSeverity(const std::string& value);
 
std::string StderrOutputGenerator(const struct tm& now, int pid, uint64_t tid,
                                  android::base::LogSeverity severity,
                                  const char* tag, const char* file,
                                  unsigned int line, const char* message);
 
android::base::LogSeverity ConsoleSeverity();
android::base::LogSeverity LogFileSeverity();
 
enum class MetadataLevel { FULL, ONLY_MESSAGE, TAG_AND_MESSAGE };
 
struct SeverityTarget {
  android::base::LogSeverity severity;
  SharedFD target;
  MetadataLevel metadata_level;
};
 
class TeeLogger {
 private:
  std::vector<SeverityTarget> destinations_;
 
 public:
  TeeLogger(const std::vector<SeverityTarget>& destinations,
            const std::string& log_prefix = "");
  ~TeeLogger() = default;
 
  void operator()(android::base::LogId log_id,
                  android::base::LogSeverity severity, const char* tag,
                  const char* file, unsigned int line, const char* message);
 
 private:
  std::string prefix_;
};
 
class ScopedTeeLogger {
 public:
  ScopedTeeLogger(TeeLogger tee_logger);
  ~ScopedTeeLogger();
 
 private:
  android::base::LogFunction old_logger_;
  android::base::ScopedLogSeverity scoped_severity_;
};
 
TeeLogger LogToStderr(
    const std::string& log_prefix = "",
    MetadataLevel stderr_level = MetadataLevel::ONLY_MESSAGE,
    std::optional<android::base::LogSeverity> stderr_severity = std::nullopt);
TeeLogger LogToFiles(const std::vector<std::string>& files,
                     const std::string& log_prefix = "");
TeeLogger LogToStderrAndFiles(
    const std::vector<std::string>& files, const std::string& log_prefix = "",
    MetadataLevel stderr_level = MetadataLevel::ONLY_MESSAGE,
    std::optional<android::base::LogSeverity> stderr_severity = std::nullopt);
 
std::string StripColorCodes(const std::string& str);
 
}  // namespace cuttlefish