blob: 85c58e9f12da279a4717ac5800772a977fa3f8c9 (
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
62
|
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
#pragma once
#ifdef ENABLE_LOGS_PREVIEW
# include <memory>
# include <vector>
# include "opentelemetry/nostd/span.h"
# include "opentelemetry/sdk/common/exporter_utils.h"
# include "opentelemetry/sdk/logs/processor.h"
# include "opentelemetry/sdk/logs/recordable.h"
OPENTELEMETRY_BEGIN_NAMESPACE
namespace sdk
{
namespace logs
{
/**
* LogExporter defines the interface that log exporters must implement.
*/
class LogExporter
{
public:
virtual ~LogExporter() = default;
/**
* Create a log recordable. This object will be used to record log data and
* will subsequently be passed to LogExporter::Export. Vendors can implement
* custom recordables or use the default LogRecord recordable provided by the
* SDK.
* @return a newly initialized Recordable object
*
* Note: This method must be callable from multiple threads.
*/
virtual std::unique_ptr<Recordable> MakeRecordable() noexcept = 0;
/**
* Exports the batch of log records to their export destination.
* This method must not be called concurrently for the same exporter instance.
* The exporter may attempt to retry sending the batch, but should drop
* and return kFailure after a certain timeout.
* @param records a span of unique pointers to log records
* @returns an ExportResult code (whether export was success or failure)
*/
virtual sdk::common::ExportResult Export(
const nostd::span<std::unique_ptr<Recordable>> &records) noexcept = 0;
/**
* Marks the exporter as ShutDown and cleans up any resources as required.
* Shutdown should be called only once for each Exporter instance.
* @param timeout minimum amount of microseconds to wait for shutdown before giving up and
* returning failure.
* @return true if the exporter 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
|
