log.h

Go to the documentation of this file.

/*
 * Copyright 2026 The A11 Authors
 *
 * 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.
 */
 
#ifndef A11_ACTIONS_LOG_H_
#define A11_ACTIONS_LOG_H_
 
#include <functional>
#include <optional>
#include <string>
#include <string_view>
 
#include <absl/base/log_severity.h>
#include <absl/status/statusor.h>
#include <absl/time/time.h>
 
#include "a11/data/types.h"
 
namespace a11::actions {
 
enum class LogLevel {
  kDebug,
  kInfo,
  kWarning,
  kError,
  kCritical,
};
 
inline constexpr LogLevel kDefaultLogLevel = LogLevel::kInfo;
 
[[nodiscard]] std::string_view LogLevelName(LogLevel level);
absl::StatusOr<LogLevel> ParseLogLevel(std::string_view name);
[[nodiscard]] absl::LogSeverity LogLevelToSeverity(LogLevel level);
 
inline constexpr std::string_view kLogLevelAttribute = "level";
inline constexpr std::string_view kLogInternalAttribute = "internal";
inline constexpr std::string_view kLogChannelAttribute = "channel";
inline constexpr std::string_view kLogFileAttribute = "file";
inline constexpr std::string_view kLogLinenoAttribute = "lineno";
inline constexpr std::string_view kLogChildActionAttribute = "a11-child-action";
inline constexpr std::string_view kLogChildCallIdAttribute =
    "a11-child-call-id";
 
inline constexpr std::string_view kLogInternalTrue = "true";
inline constexpr std::string_view kLogInternalFalse = "false";
 
struct LogOptions {
  std::string_view level{};
  std::string_view mimetype{};
  std::string_view channel{};
  std::string_view file{};
  std::optional<int> lineno{};
  bool internal = false;
  const data::ByteMap* absl_nullable metadata = nullptr;
};
 
struct LogRecord {
  std::string_view action_name{};
  std::string_view action_id{};
  LogLevel level = kDefaultLogLevel;
  std::string_view channel{};
  std::string_view file{};
  std::optional<int> lineno{};
  bool internal = false;
  absl::Time timestamp = absl::InfinitePast();
  std::string_view mimetype{};
  std::string_view data{};
};
 
using ActionLogSink = std::function<void(const LogRecord&)>;
 
void SetActionLogSink(ActionLogSink sink);
[[nodiscard]] ActionLogSink GetActionLogSink();
void ReportLog(const LogRecord& record);
 
[[nodiscard]] bool IsTextualLogMimetype(std::string_view mimetype);
 
[[nodiscard]] std::string LogText(const LogRecord& record);
 
[[nodiscard]] LogRecord LogRecordFromChunk(const data::Chunk& chunk,
                                           std::string_view action_name = {},
                                           std::string_view action_id = {});
 
}  // namespace a11::actions
 
#endif  // A11_ACTIONS_LOG_H_