logging.hpp File Reference

Provides logging capability. More...

#include <functional>
#include <memory>
#include <string>
#include <spdlog/logger.h>
#include <spdlog/spdlog.h>

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
using	pinecone::util::Logger = std::shared_ptr< spdlog::logger >

Functions
auto	pinecone::util::logger () noexcept -> Logger
	Retrieves the logger to use for Cppinecone logging. More...
auto	pinecone::util::setup_logger (std::function< Logger(std::string const &)> const &builder) noexcept -> Logger
	Configure the logger to user for Cppinecone logging. More...

Detailed Description

Provides logging capability.

Definition in file logging.hpp.

Function Documentation

logger()

auto pinecone::util::logger ( ) -> Logger

inlinenoexcept

Retrieves the logger to use for Cppinecone logging.

setup_logger should be called before this function is used; otherwise, no logger will be configured, and written logs will not be persisted.

Returns

a logger

Definition at line 26 of file logging.hpp.

Referenced by pinecone::util::logger().

setup_logger()

auto pinecone::util::setup_logger ( std::function< Logger(std::string const &)> const &  builder ) -> Logger

inlinenoexcept

Configure the logger to user for Cppinecone logging.

Should be called once before Cppinecone functionality is utilized. Applies for the lifetime of the application.

Parameters

builder

a function to use for instrumentation of the Cppinecone logger.

Returns

a logger

Examples

main.cpp.

Definition at line 36 of file logging.hpp.

Referenced by pinecone::util::setup_logger().