Skip to content

Commit 8c82d24

Browse files
ThomsonTanThomsonTan
authored
Mark logs signal as stable API/SDK (#2229)
1 parent 8f97cab commit 8c82d24

File tree

119 files changed

+920
-1250
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

119 files changed

+920
-1250
lines changed

‎CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ Increment the:
1515

1616
## [Unreleased]
1717

18+
* [SDK] Mark logs signal as stable API/SDK
19+
[#2229](https://github.com/open-telemetry/opentelemetry-cpp/pull/2229)
20+
1821
Breaking changes:
1922

2023
* [SDK] Add unit to Instrument selection criteria

‎CMakeLists.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,10 @@ option(
236236

237237
option(WITH_FUNC_TESTS "Whether to build functional tests" ON)
238238

239-
option(WITH_LOGS_PREVIEW "Whether to build logs preview" OFF)
239+
if(DEFINED WITH_LOGS_PREVIEW)
240+
message(WARNING "WITH_LOGS_PREVIEW is removed because logs signal is stable")
241+
endif()
242+
240243
option(WITH_ASYNC_EXPORT_PREVIEW "Whether to enable async export" OFF)
241244

242245
# EXPERIMENTAL

‎README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,7 @@ The C++ [OpenTelemetry](https://opentelemetry.io/) client.
1414
| ------- | ----------------------- | ------------------------------------------------------------------------ |
1515
| Traces | Public Release | N/A |
1616
| Metrics | Public Release | N/A |
17-
| Logs | Experimental [1] | [Release Milestone](https://github.com/open-telemetry/opentelemetry-cpp/milestone/18)|
18-
19-
* [1]: The current Log Signal Implementation is Experimental, and will change as
20-
the current OpenTelemetry Log specification matures. The current
21-
implementation can be included in build by setting `ENABLE_LOGS_PREVIEW`
22-
preprocessor macro.
17+
| Logs | Public Release | N/A |
2318

2419
## Supported C++ Versions
2520

‎api/CMakeLists.txt

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,6 @@ if(OPENTELEMETRY_INSTALL)
1717
LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
1818
ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR})
1919

20-
set(LOGS_EXCLUDE_PATTERN "")
21-
if(NOT WITH_LOGS_PREVIEW)
22-
set(LOGS_EXCLUDE_PATTERN "logs")
23-
endif()
24-
2520
install(
2621
DIRECTORY include/opentelemetry
2722
DESTINATION include
@@ -33,8 +28,7 @@ if(OPENTELEMETRY_INSTALL)
3328
DIRECTORY include/opentelemetry
3429
DESTINATION include
3530
FILES_MATCHING
36-
PATTERN "*.h"
37-
PATTERN "${LOGS_EXCLUDE_PATTERN}" EXCLUDE)
31+
PATTERN "*.h")
3832
endif()
3933

4034
if(BUILD_TESTING)
@@ -79,10 +73,6 @@ if(WITH_GSL)
7973
endif()
8074
endif()
8175

82-
if(WITH_LOGS_PREVIEW)
83-
target_compile_definitions(opentelemetry_api INTERFACE ENABLE_LOGS_PREVIEW)
84-
endif()
85-
8676
if(WITH_NO_GETENV)
8777
target_compile_definitions(opentelemetry_api INTERFACE NO_GETENV)
8878
endif()

‎api/include/opentelemetry/logs/event_id.h

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,11 @@
33

44
#pragma once
55

6-
#ifdef ENABLE_LOGS_PREVIEW
6+
#include <algorithm>
77

8-
# include <algorithm>
9-
10-
# include "opentelemetry/nostd/string_view.h"
11-
# include "opentelemetry/nostd/unique_ptr.h"
12-
# include "opentelemetry/version.h"
8+
#include "opentelemetry/nostd/string_view.h"
9+
#include "opentelemetry/nostd/unique_ptr.h"
10+
#include "opentelemetry/version.h"
1311

1412
OPENTELEMETRY_BEGIN_NAMESPACE
1513
namespace logs
@@ -37,4 +35,3 @@ class EventId
3735

3836
} // namespace logs
3937
OPENTELEMETRY_END_NAMESPACE
40-
#endif

‎api/include/opentelemetry/logs/event_logger.h

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,14 @@
22
// SPDX-License-Identifier: Apache-2.0
33

44
#pragma once
5-
#ifdef ENABLE_LOGS_PREVIEW
65

7-
# include "opentelemetry/logs/log_record.h"
8-
# include "opentelemetry/logs/logger.h"
9-
# include "opentelemetry/logs/logger_type_traits.h"
10-
# include "opentelemetry/nostd/shared_ptr.h"
11-
# include "opentelemetry/nostd/string_view.h"
12-
# include "opentelemetry/nostd/unique_ptr.h"
13-
# include "opentelemetry/version.h"
6+
#include "opentelemetry/logs/log_record.h"
7+
#include "opentelemetry/logs/logger.h"
8+
#include "opentelemetry/logs/logger_type_traits.h"
9+
#include "opentelemetry/nostd/shared_ptr.h"
10+
#include "opentelemetry/nostd/string_view.h"
11+
#include "opentelemetry/nostd/unique_ptr.h"
12+
#include "opentelemetry/version.h"
1413

1514
OPENTELEMETRY_BEGIN_NAMESPACE
1615
namespace logs
@@ -84,5 +83,3 @@ class EventLogger
8483
};
8584
} // namespace logs
8685
OPENTELEMETRY_END_NAMESPACE
87-
88-
#endif

‎api/include/opentelemetry/logs/event_logger_provider.h

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22
// SPDX-License-Identifier: Apache-2.0
33

44
#pragma once
5-
#ifdef ENABLE_LOGS_PREVIEW
65

7-
# include "opentelemetry/nostd/shared_ptr.h"
8-
# include "opentelemetry/nostd/string_view.h"
9-
# include "opentelemetry/version.h"
6+
#include "opentelemetry/nostd/shared_ptr.h"
7+
#include "opentelemetry/nostd/string_view.h"
8+
#include "opentelemetry/version.h"
109

1110
OPENTELEMETRY_BEGIN_NAMESPACE
1211
namespace logs
@@ -34,4 +33,3 @@ class EventLoggerProvider
3433
};
3534
} // namespace logs
3635
OPENTELEMETRY_END_NAMESPACE
37-
#endif

‎api/include/opentelemetry/logs/log_record.h

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22
// SPDX-License-Identifier: Apache-2.0
33

44
#pragma once
5-
#ifdef ENABLE_LOGS_PREVIEW
65

7-
# include "opentelemetry/common/attribute_value.h"
8-
# include "opentelemetry/common/timestamp.h"
9-
# include "opentelemetry/version.h"
6+
#include "opentelemetry/common/attribute_value.h"
7+
#include "opentelemetry/common/timestamp.h"
8+
#include "opentelemetry/version.h"
109

1110
OPENTELEMETRY_BEGIN_NAMESPACE
1211
namespace trace
@@ -91,4 +90,3 @@ class LogRecord
9190
};
9291
} // namespace logs
9392
OPENTELEMETRY_END_NAMESPACE
94-
#endif

‎api/include/opentelemetry/logs/logger.h

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,12 @@
22
// SPDX-License-Identifier: Apache-2.0
33

44
#pragma once
5-
#ifdef ENABLE_LOGS_PREVIEW
65

7-
# include "opentelemetry/logs/logger_type_traits.h"
8-
# include "opentelemetry/logs/severity.h"
9-
# include "opentelemetry/nostd/string_view.h"
10-
# include "opentelemetry/nostd/unique_ptr.h"
11-
# include "opentelemetry/version.h"
6+
#include "opentelemetry/logs/logger_type_traits.h"
7+
#include "opentelemetry/logs/severity.h"
8+
#include "opentelemetry/nostd/string_view.h"
9+
#include "opentelemetry/nostd/unique_ptr.h"
10+
#include "opentelemetry/version.h"
1211

1312
OPENTELEMETRY_BEGIN_NAMESPACE
1413
namespace common
@@ -475,5 +474,3 @@ class Logger
475474
};
476475
} // namespace logs
477476
OPENTELEMETRY_END_NAMESPACE
478-
479-
#endif // end of ENABLE_LOGS_PREVIEW

‎api/include/opentelemetry/logs/logger_provider.h

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,13 @@
33

44
#pragma once
55

6-
#ifdef ENABLE_LOGS_PREVIEW
7-
8-
# include "opentelemetry/common/key_value_iterable.h"
9-
# include "opentelemetry/common/key_value_iterable_view.h"
10-
# include "opentelemetry/nostd/shared_ptr.h"
11-
# include "opentelemetry/nostd/span.h"
12-
# include "opentelemetry/nostd/string_view.h"
13-
# include "opentelemetry/nostd/type_traits.h"
14-
# include "opentelemetry/version.h"
6+
#include "opentelemetry/common/key_value_iterable.h"
7+
#include "opentelemetry/common/key_value_iterable_view.h"
8+
#include "opentelemetry/nostd/shared_ptr.h"
9+
#include "opentelemetry/nostd/span.h"
10+
#include "opentelemetry/nostd/string_view.h"
11+
#include "opentelemetry/nostd/type_traits.h"
12+
#include "opentelemetry/version.h"
1513

1614
OPENTELEMETRY_BEGIN_NAMESPACE
1715
namespace logs
@@ -71,5 +69,3 @@ class OPENTELEMETRY_EXPORT LoggerProvider
7169
};
7270
} // namespace logs
7371
OPENTELEMETRY_END_NAMESPACE
74-
75-
#endif // ENABLE_LOGS_PREVIEW

‎api/include/opentelemetry/logs/logger_type_traits.h

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,23 @@
22
// SPDX-License-Identifier: Apache-2.0
33

44
#pragma once
5-
#ifdef ENABLE_LOGS_PREVIEW
6-
7-
# include <chrono>
8-
# include <type_traits>
9-
10-
# include "opentelemetry/common/attribute_value.h"
11-
# include "opentelemetry/common/key_value_iterable.h"
12-
# include "opentelemetry/common/timestamp.h"
13-
# include "opentelemetry/logs/event_id.h"
14-
# include "opentelemetry/logs/log_record.h"
15-
# include "opentelemetry/logs/severity.h"
16-
# include "opentelemetry/nostd/string_view.h"
17-
# include "opentelemetry/nostd/type_traits.h"
18-
# include "opentelemetry/trace/span_context.h"
19-
# include "opentelemetry/trace/span_id.h"
20-
# include "opentelemetry/trace/trace_flags.h"
21-
# include "opentelemetry/trace/trace_id.h"
22-
# include "opentelemetry/version.h"
5+
6+
#include <chrono>
7+
#include <type_traits>
8+
9+
#include "opentelemetry/common/attribute_value.h"
10+
#include "opentelemetry/common/key_value_iterable.h"
11+
#include "opentelemetry/common/timestamp.h"
12+
#include "opentelemetry/logs/event_id.h"
13+
#include "opentelemetry/logs/log_record.h"
14+
#include "opentelemetry/logs/severity.h"
15+
#include "opentelemetry/nostd/string_view.h"
16+
#include "opentelemetry/nostd/type_traits.h"
17+
#include "opentelemetry/trace/span_context.h"
18+
#include "opentelemetry/trace/span_id.h"
19+
#include "opentelemetry/trace/trace_flags.h"
20+
#include "opentelemetry/trace/trace_id.h"
21+
#include "opentelemetry/version.h"
2322

2423
OPENTELEMETRY_BEGIN_NAMESPACE
2524
namespace logs
@@ -198,5 +197,3 @@ struct LogRecordHasType<ValueType, TargetType, ArgumentType...>
198197

199198
} // namespace logs
200199
OPENTELEMETRY_END_NAMESPACE
201-
202-
#endif

‎api/include/opentelemetry/logs/noop.h

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,20 @@
22
// SPDX-License-Identifier: Apache-2.0
33

44
#pragma once
5-
#ifdef ENABLE_LOGS_PREVIEW
65

76
// Please refer to provider.h for documentation on how to obtain a Logger object.
87
//
98
// This file is part of the internal implementation of OpenTelemetry. Nothing in this file should be
109
// used directly. Please refer to logger.h for documentation on these interfaces.
1110

12-
# include "opentelemetry/logs/event_logger.h"
13-
# include "opentelemetry/logs/event_logger_provider.h"
14-
# include "opentelemetry/logs/logger.h"
15-
# include "opentelemetry/logs/logger_provider.h"
16-
# include "opentelemetry/nostd/shared_ptr.h"
17-
# include "opentelemetry/nostd/string_view.h"
18-
# include "opentelemetry/nostd/unique_ptr.h"
19-
# include "opentelemetry/version.h"
11+
#include "opentelemetry/logs/event_logger.h"
12+
#include "opentelemetry/logs/event_logger_provider.h"
13+
#include "opentelemetry/logs/logger.h"
14+
#include "opentelemetry/logs/logger_provider.h"
15+
#include "opentelemetry/nostd/shared_ptr.h"
16+
#include "opentelemetry/nostd/string_view.h"
17+
#include "opentelemetry/nostd/unique_ptr.h"
18+
#include "opentelemetry/version.h"
2019

2120
OPENTELEMETRY_BEGIN_NAMESPACE
2221
namespace common
@@ -100,4 +99,3 @@ class NoopEventLoggerProvider final : public EventLoggerProvider
10099

101100
} // namespace logs
102101
OPENTELEMETRY_END_NAMESPACE
103-
#endif

‎api/include/opentelemetry/logs/provider.h

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,14 @@
22
// SPDX-License-Identifier: Apache-2.0
33

44
#pragma once
5-
#ifdef ENABLE_LOGS_PREVIEW
65

7-
# include <mutex>
6+
#include <mutex>
87

9-
# include "opentelemetry/common/macros.h"
10-
# include "opentelemetry/common/spin_lock_mutex.h"
11-
# include "opentelemetry/logs/noop.h"
12-
# include "opentelemetry/nostd/shared_ptr.h"
13-
# include "opentelemetry/version.h"
8+
#include "opentelemetry/common/macros.h"
9+
#include "opentelemetry/common/spin_lock_mutex.h"
10+
#include "opentelemetry/logs/noop.h"
11+
#include "opentelemetry/nostd/shared_ptr.h"
12+
#include "opentelemetry/version.h"
1413

1514
OPENTELEMETRY_BEGIN_NAMESPACE
1615
namespace logs
@@ -90,4 +89,3 @@ class OPENTELEMETRY_EXPORT Provider
9089

9190
} // namespace logs
9291
OPENTELEMETRY_END_NAMESPACE
93-
#endif

‎api/include/opentelemetry/logs/severity.h

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
// SPDX-License-Identifier: Apache-2.0
33

44
#pragma once
5-
#ifdef ENABLE_LOGS_PREVIEW
65

7-
# include "opentelemetry/nostd/string_view.h"
8-
# include "opentelemetry/version.h"
6+
#include "opentelemetry/nostd/string_view.h"
7+
#include "opentelemetry/version.h"
98

109
OPENTELEMETRY_BEGIN_NAMESPACE
1110
namespace logs
@@ -64,4 +63,3 @@ const nostd::string_view SeverityNumToText[25] = {
6463

6564
} // namespace logs
6665
OPENTELEMETRY_END_NAMESPACE
67-
#endif

‎api/test/CMakeLists.txt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ add_subdirectory(plugin)
77
add_subdirectory(nostd)
88
add_subdirectory(trace)
99
add_subdirectory(metrics)
10-
if(WITH_LOGS_PREVIEW)
11-
add_subdirectory(logs)
12-
endif()
10+
add_subdirectory(logs)
1311
add_subdirectory(common)
1412
add_subdirectory(baggage)
1513
add_subdirectory(singleton)

‎api/test/logs/logger_benchmark.cc

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
11
// Copyright The OpenTelemetry Authors
22
// SPDX-License-Identifier: Apache-2.0
33

4-
#ifdef ENABLE_LOGS_PREVIEW
4+
#include "opentelemetry/common/timestamp.h"
5+
#include "opentelemetry/logs/logger.h"
6+
#include "opentelemetry/logs/provider.h"
7+
#include "opentelemetry/nostd/shared_ptr.h"
58

6-
# include "opentelemetry/common/timestamp.h"
7-
# include "opentelemetry/logs/logger.h"
8-
# include "opentelemetry/logs/provider.h"
9-
# include "opentelemetry/nostd/shared_ptr.h"
9+
#include <chrono>
10+
#include <condition_variable>
11+
#include <functional>
12+
#include <mutex>
13+
#include <thread>
14+
#include <vector>
1015

11-
# include <chrono>
12-
# include <condition_variable>
13-
# include <functional>
14-
# include <mutex>
15-
# include <thread>
16-
# include <vector>
17-
18-
# include <benchmark/benchmark.h>
16+
#include <benchmark/benchmark.h>
1917

2018
using opentelemetry::logs::EventId;
2119
using opentelemetry::logs::Logger;
@@ -256,5 +254,3 @@ int main(int argc, char **argv)
256254
benchmark::Initialize(&argc, argv);
257255
benchmark::RunSpecifiedBenchmarks();
258256
}
259-
260-
#endif

0 commit comments

Comments
 (0)