blob: 36da036f311c372d8c9313c72614e24815b74d46 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
#pragma once
#ifdef ENABLE_LOGS_PREVIEW
# include <chrono>
# include <memory>
# include "opentelemetry/sdk/logs/recordable.h"
OPENTELEMETRY_BEGIN_NAMESPACE
namespace sdk
{
namespace logs
{
/**
* The Log Processor is responsible for passing log records
* to the configured exporter.
*/
class LogProcessor
{
public:
virtual ~LogProcessor() = default;
/**
* Create a log recordable. This requests a new log recordable from the
* associated exporter.
* @return a newly initialized recordable
*
* Note: This method must be callable from multiple threads.
*/
virtual std::unique_ptr<Recordable> MakeRecordable() noexcept = 0;
/**
* OnReceive is called by the SDK once a log record has been successfully created.
* @param record the log record
*/
virtual void OnReceive(std::unique_ptr<Recordable> &&record) noexcept = 0;
/**
* Exports all log records that have not yet been exported to the configured Exporter.
* @param timeout that the forceflush is required to finish within.
* @return a result code indicating whether it succeeded, failed or timed out
*/
virtual bool ForceFlush(
std::chrono::microseconds timeout = std::chrono::microseconds::max()) noexcept = 0;
/**
* Shuts down the processor and does any cleanup required.
* ShutDown should only be called once for each processor.
* @param timeout minimum amount of microseconds to wait for
* shutdown before giving up and returning failure.
* @return true if the shutdown succeeded, false otherwise
*/
virtual bool Shutdown(
std::chrono::microseconds timeout = std::chrono::microseconds::max()) noexcept = 0;
};
} // namespace logs
} // namespace sdk
OPENTELEMETRY_END_NAMESPACE
#endif
|
