Skip to content

Commit 8f60276

Browse files
ThomsonTanThomsonTan
authored
Merge branch 'main' into single-collector-delta-fastpath
2 parents 983162b + 031307b commit 8f60276

File tree

149 files changed

+4309
-396
lines changed

Some content is hidden

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

149 files changed

+4309
-396
lines changed

‎.devcontainer/Dockerfile.dev‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Copyright The OpenTelemetry Authors
2+
# SPDX-License-Identifier: Apache-2.0
3+
4+
FROM otel/cpp_format_tools
5+
6+
ARG GRPC_VERSION=v1.55.0
7+
ARG PROTOBUF_VERSION=23.4
8+
ARG ABSEIL_CPP_VERSION=20240116.1
9+
10+
ENV PROTOBUF_VERSION=${PROTOBUF_VERSION}
11+
ENV ABSEIL_CPP_VERSION=${ABSEIL_CPP_VERSION}
12+
13+
COPY ci /opt/ci
14+
15+
RUN apt update && apt install -y wget \
16+
ninja-build \
17+
libcurl4-openssl-dev \
18+
markdownlint
19+
20+
RUN cd /opt/ci && bash setup_cmake.sh
21+
RUN cd /opt/ci && bash setup_ci_environment.sh
22+
RUN cd /opt && bash ci/setup_googletest.sh \
23+
&& bash ci/setup_grpc.sh -r ${GRPC_VERSION}
24+
25+
ADD https://github.com/bazelbuild/bazelisk/releases/download/v1.22.1/bazelisk-linux-amd64 /usr/local/bin
26+
27+
RUN git config --global core.autocrlf input \
28+
&& chmod +x /usr/local/bin/bazelisk-linux-amd64

‎.devcontainer/devcontainer.json‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// Copyright The OpenTelemetry Authors
2+
// SPDX-License-Identifier: Apache-2.0
3+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
4+
// https://github.com/microsoft/vscode-dev-containers/tree/v0.162.0/containers/javascript-node
5+
{
6+
"name": "opentelemetry-cpp",
7+
"build": {
8+
"context": "..",
9+
"dockerfile": "Dockerfile.dev",
10+
"args": {
11+
"GRPC_VERSION": "v1.55.0",
12+
"PROTOBUF_VERSION": "23.4",
13+
"ABSEIL_CPP_VERSION":"20240116.1"
14+
}
15+
},
16+
"settings": {
17+
"terminal.integrated.shell.linux": "/bin/sh"
18+
},
19+
"extensions": [
20+
"ms-vscode.cpptools",
21+
"ms-azuretools.vscode-docker",
22+
"ms-vscode.cpptools-extension-pack"
23+
],
24+
25+
"remoteUser": "root"
26+
}

‎.github/dependabot.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,8 @@ updates:
66
interval: "daily"
77
labels:
88
- "GHA"
9+
10+
- package-ecosystem: "devcontainers"
11+
directory: "/"
12+
schedule:
13+
interval: daily

‎.github/workflows/ci.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,9 @@ jobs:
7878
sudo -E ./ci/setup_googletest.sh
7979
sudo -E ./ci/setup_ci_environment.sh
8080
sudo -E ./ci/install_protobuf.sh
81+
- name: setup grpc
82+
run: |
83+
sudo ./ci/setup_grpc.sh
8184
- name: run cmake gcc (maintainer mode, sync)
8285
env:
8386
CC: /usr/bin/gcc-14
@@ -111,6 +114,9 @@ jobs:
111114
sudo -E ./ci/setup_googletest.sh
112115
sudo -E ./ci/setup_ci_environment.sh
113116
sudo -E ./ci/install_protobuf.sh
117+
- name: setup grpc
118+
run: |
119+
sudo ./ci/setup_grpc.sh
114120
- name: run cmake gcc (maintainer mode, async)
115121
env:
116122
CC: /usr/bin/gcc-14
@@ -144,6 +150,9 @@ jobs:
144150
sudo -E ./ci/setup_googletest.sh
145151
sudo -E ./ci/setup_ci_environment.sh
146152
sudo -E ./ci/install_protobuf.sh
153+
- name: setup grpc
154+
run: |
155+
sudo ./ci/setup_grpc.sh
147156
- name: run cmake clang (maintainer mode, sync)
148157
env:
149158
CC: /usr/bin/clang-18
@@ -177,6 +186,9 @@ jobs:
177186
sudo -E ./ci/setup_googletest.sh
178187
sudo -E ./ci/setup_ci_environment.sh
179188
sudo -E ./ci/install_protobuf.sh
189+
- name: setup grpc
190+
run: |
191+
sudo ./ci/setup_grpc.sh
180192
- name: run cmake clang (maintainer mode, async)
181193
env:
182194
CC: /usr/bin/clang-18
@@ -210,6 +222,9 @@ jobs:
210222
sudo -E ./ci/setup_googletest.sh
211223
sudo -E ./ci/setup_ci_environment.sh
212224
sudo -E ./ci/install_protobuf.sh
225+
- name: setup grpc
226+
run: |
227+
sudo ./ci/setup_grpc.sh
213228
- name: run cmake clang (maintainer mode, abiv2)
214229
env:
215230
CC: /usr/bin/clang-18

‎.github/workflows/iwyu.yml‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@ jobs:
3131
libgtest-dev \
3232
libbenchmark-dev
3333
34+
- name: setup grpc
35+
run: |
36+
sudo ./ci/setup_grpc.sh
37+
3438
- name: Prepare CMake
3539
run: |
3640
TOPDIR=`pwd`
@@ -41,12 +45,14 @@ jobs:
4145
-DCMAKE_CXX_INCLUDE_WHAT_YOU_USE="include-what-you-use;-w;-Xiwyu;--mapping_file=${TOPDIR}/.iwyu.imp;" \
4246
-DBUILD_TESTING=ON \
4347
-DBUILD_W3CTRACECONTEXT_TEST=ON \
44-
-DWITH_OTLP_GRPC=OFF \
48+
-DWITH_OTLP_GRPC=ON \
4549
-DWITH_OTLP_HTTP=ON \
4650
-DWITH_OTLP_FILE=ON \
51+
-DWITH_OPENTRACING=ON \
4752
-DWITH_OTLP_HTTP_COMPRESSION=ON \
53+
-DWITH_THREAD_INSTRUMENTATION=ON \
4854
-DWITH_ZIPKIN=ON \
49-
-DWITH_PROMETHEUS=OFF \
55+
-DWITH_PROMETHEUS=ON \
5056
..
5157
5258
- name: iwyu_tool
@@ -67,7 +73,7 @@ jobs:
6773
readonly WARNING_COUNT=`grep -c "include-what-you-use reported diagnostics:" iwyu.log`
6874
echo "include-what-you-use reported ${WARNING_COUNT} warning(s)"
6975
# Acceptable limit, to decrease over time down to 0
70-
readonly WARNING_LIMIT=180
76+
readonly WARNING_LIMIT=10
7177
# FAIL the build if WARNING_COUNT > WARNING_LIMIT
7278
if [ $WARNING_COUNT -gt $WARNING_LIMIT ] ; then
7379
exit 1

‎CHANGELOG.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,78 @@ Increment the:
2424
* [EXPORTER] Fix scope attributes missing from otlp traces metrics
2525
[#3185](https://github.com/open-telemetry/opentelemetry-cpp/pull/3185)
2626

27+
* [EXPORTER] Fix throw in OtlpGrpcMetricExporter with shared grpc client
28+
[#3243](https://github.com/open-telemetry/opentelemetry-cpp/pull/3243)
29+
30+
* [SDK] Better control of threads executed by opentelemetry-cpp
31+
[#3175](https://github.com/open-telemetry/opentelemetry-cpp/pull/3175)
32+
33+
* [SDK] Enable deriving from ResourceDetector to create a Resource
34+
[#3247](https://github.com/open-telemetry/opentelemetry-cpp/pull/3247)
35+
36+
* [EXPORTER] Support handling retry-able errors for OTLP/HTTP
37+
[#3223](https://github.com/open-telemetry/opentelemetry-cpp/pull/3223)
38+
39+
* [EXPORTER] Support handling retry-able errors for OTLP/gRPC
40+
[#3219](https://github.com/open-telemetry/opentelemetry-cpp/pull/3219)
41+
42+
New features:
43+
44+
* [SDK] Better control of threads executed by opentelemetry-cpp
45+
[#3175](https://github.com/open-telemetry/opentelemetry-cpp/pull/3175)
46+
47+
* This feature provides a way for applications,
48+
when configuring the SDK and exporters,
49+
to participate in the execution path
50+
of internal opentelemetry-cpp threads.
51+
52+
* The opentelemetry-cpp library provides the following:
53+
54+
* a new ThreadInstrumentation interface,
55+
* new runtime options structures, to optionally configure the SDK:
56+
* BatchSpanProcessorRuntimeOptions
57+
* PeriodicExportingMetricReaderRuntimeOptions
58+
* BatchLogRecordProcessorRuntimeOptions
59+
* new runtime options structures,
60+
to optionally configure the OTLP HTTP exporters:
61+
* OtlpHttpExporterRuntimeOptions
62+
* OtlpHttpMetricExporterRuntimeOptions
63+
* OtlpHttpLogRecordExporterRuntimeOptions
64+
* new ThreadInstrumentation parameters,
65+
to optionally configure the CURL HttpClient
66+
* new runtime options structures,
67+
to optionally configure the OTLP FILE exporters:
68+
* OtlpFileExporterRuntimeOptions
69+
* OtlpFileMetricExporterRuntimeOptions
70+
* OtlpFileLogRecordExporterRuntimeOptions
71+
* new runtime options structure,
72+
to optionally configure the OTLP FILE client:
73+
* OtlpFileClientRuntimeOptions
74+
75+
* Using the optional runtime options structures,
76+
an application can subclass the ThreadInstrumentation interface,
77+
and be notified of specific events of interest during the execution
78+
of an internal opentelemetry-cpp thread.
79+
80+
* This allows an application to call, for example:
81+
82+
* pthread_setaffinity_np(), for better performances,
83+
* setns(), to control the network namespace used by HTTP CURL connections
84+
* pthread_setname_np(), for better observability from the operating system
85+
* many more specific apis, as needed
86+
87+
* See the documentation for ThreadInstrumentation for details.
88+
89+
* A new example program, example_otlp_instrumented_http,
90+
shows how to use the feature,
91+
and add application logic in the thread execution code path.
92+
93+
* Note that this feature is experimental,
94+
protected by a WITH_THREAD_INSTRUMENTATION_PREVIEW
95+
flag in CMake. Various runtime options structures,
96+
as well as the thread instrumentation interface,
97+
may change without notice before this feature is declared stable.
98+
2799
## [1.18 2024-11-25]
28100

29101
* [EXPORTER] Fix crash in ElasticsearchLogRecordExporter

‎CMakeLists.txt‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,9 @@ if(NOT WITH_STL STREQUAL "OFF")
212212
endif()
213213
endif()
214214

215+
option(WITH_OTLP_RETRY_PREVIEW
216+
"Whether to enable experimental retry functionality" OFF)
217+
215218
option(WITH_OTLP_GRPC_SSL_MTLS_PREVIEW
216219
"Whether to enable mTLS support fro gRPC" OFF)
217220

@@ -300,6 +303,10 @@ option(WITH_ASYNC_EXPORT_PREVIEW "Whether to enable async export" OFF)
300303
option(WITH_METRICS_EXEMPLAR_PREVIEW
301304
"Whether to enable exemplar within metrics" OFF)
302305

306+
# Experimental, so behind feature flag by default
307+
option(WITH_THREAD_INSTRUMENTATION_PREVIEW
308+
"Whether to enable thread instrumentation" OFF)
309+
303310
option(OPENTELEMETRY_SKIP_DYNAMIC_LOADING_TESTS
304311
"Whether to build test libraries that are always linked as shared libs"
305312
OFF)
@@ -365,11 +372,16 @@ if(WITH_PROMETHEUS)
365372
if(EXISTS ${PROJECT_SOURCE_DIR}/third_party/prometheus-cpp/.git)
366373
set(SAVED_ENABLE_TESTING ${ENABLE_TESTING})
367374
set(SAVED_CMAKE_CXX_CLANG_TIDY ${CMAKE_CXX_CLANG_TIDY})
375+
set(SAVED_CMAKE_CXX_INCLUDE_WHAT_YOU_USE
376+
${CMAKE_CXX_INCLUDE_WHAT_YOU_USE})
368377
set(ENABLE_TESTING OFF)
369378
set(CMAKE_CXX_CLANG_TIDY "")
379+
set(CMAKE_CXX_INCLUDE_WHAT_YOU_USE "")
370380
add_subdirectory(third_party/prometheus-cpp)
371381
set(ENABLE_TESTING ${SAVED_ENABLE_TESTING})
372382
set(CMAKE_CXX_CLANG_TIDY ${SAVED_CMAKE_CXX_CLANG_TIDY})
383+
set(CMAKE_CXX_INCLUDE_WHAT_YOU_USE
384+
${SAVED_CMAKE_CXX_INCLUDE_WHAT_YOU_USE})
373385
else()
374386
message(
375387
FATAL_ERROR
@@ -711,8 +723,13 @@ if(WITH_OPENTRACING)
711723
if(EXISTS "${PROJECT_SOURCE_DIR}/${OPENTRACING_DIR}/.git")
712724
set(SAVED_BUILD_TESTING ${BUILD_TESTING})
713725
set(BUILD_TESTING OFF)
726+
set(SAVED_CMAKE_CXX_INCLUDE_WHAT_YOU_USE
727+
${CMAKE_CXX_INCLUDE_WHAT_YOU_USE})
728+
set(CMAKE_CXX_INCLUDE_WHAT_YOU_USE "")
714729
add_subdirectory(${OPENTRACING_DIR})
715730
set(BUILD_TESTING ${SAVED_BUILD_TESTING})
731+
set(CMAKE_CXX_INCLUDE_WHAT_YOU_USE
732+
${SAVED_CMAKE_CXX_INCLUDE_WHAT_YOU_USE})
716733
else()
717734
message(
718735
FATAL_ERROR

‎CONTRIBUTING.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,91 @@ bazel build //examples/simple:example_simple
6060
bazel-bin/examples/simple/example_simple
6161
```
6262

63+
### DevContainer Setup for Project
64+
65+
This guide provides instructions on how to set up and use the development
66+
container (`devcontainer`) environment to streamline testing and development
67+
for this project. With the DevContainer, you can work in a consistent environment
68+
configured with all the necessary dependencies and tools.
69+
70+
#### Prerequisites
71+
72+
Before getting started, ensure you have the following installed:
73+
74+
* **Docker**: DevContainers require Docker for containerization.
75+
* **Visual Studio Code (VSCode)** with the **Remote - Containers** extension.
76+
77+
#### Getting Started
78+
79+
* **Open the Project in DevContainer**:
80+
81+
Open the project in VSCode. When prompted to "Reopen in Container," select
82+
this option. If you’re not prompted, you can manually open the container by
83+
selecting **Remote-Containers: Reopen in Container** from the command palette
84+
(`F1` or `Ctrl+Shift+P`).
85+
86+
* **Container Setup**:
87+
88+
The DevContainer environment will automatically build based on the configuration
89+
files provided (e.g., `.devcontainer/devcontainer.json`). This setup will install
90+
required dependencies, tools, and environment variables needed for the project.
91+
92+
#### Available Commands
93+
94+
Once inside the DevContainer, you can use the following commands to run tests
95+
and CI workflows.
96+
97+
##### 1. Run Tests with Bazelisk
98+
99+
To run tests with Bazelisk using specific compilation options, use:
100+
101+
```bash
102+
bazelisk-linux-amd64 test --copt=-DENABLE_LOGS_PREVIEW
103+
--test_output=errors --cache_test_results=no --copt=-DENABLE_TEST //exporters/otlp/...
104+
```
105+
106+
###### Command Breakdown
107+
108+
* `--copt=-DENABLE_LOGS_PREVIEW`: Enables preview logs.
109+
* `--test_output=errors`: Shows only the errors in the test output.
110+
* `--cache_test_results=no`: Forces Bazel to re-run tests without caching.
111+
* `--copt=-DENABLE_TEST`: Enables testing capabilities for the target code.
112+
* `//exporters/otlp/...`: Specifies the test target path.
113+
114+
##### 2. Run CI Script
115+
116+
You can also run the CI script provided to perform testing with the
117+
following command as an
118+
example:
119+
120+
```bash
121+
bash ci/do_ci.sh cmake.exporter.otprotocol.test
122+
```
123+
124+
This command initiates the CI pipeline, executing tests specifically for the
125+
**cmake.exporter.otprotocol** module.
126+
127+
#### Troubleshooting
128+
129+
If you encounter issues:
130+
131+
* **Rebuild the DevContainer**: From the command palette, run
132+
**Remote-Containers: Rebuild Container** to reinitialize the environment.
133+
* **Check Bazelisk and CI Script Logs**: Inspect logs for any configuration or
134+
dependency issues.
135+
136+
#### Additional Notes
137+
138+
* You can adjust compiler options (`--copt`) as needed to test additional flags
139+
or enable/disable specific features.
140+
* The test results will be displayed in the terminal within the DevContainer for
141+
easy debugging.
142+
143+
#### Resources
144+
145+
* **Bazelisk Documentation**: [https://github.com/bazelbuild/bazelisk](https://github.com/bazelbuild/bazelisk)
146+
* **VSCode DevContainer Documentation**: [https://code.visualstudio.com/docs/remote/containers](https://code.visualstudio.com/docs/remote/containers)
147+
63148
## Pull Requests
64149

65150
### How to Send Pull Requests

‎api/CMakeLists.txt‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,11 @@ target_compile_definitions(
116116
opentelemetry_api
117117
INTERFACE OPENTELEMETRY_ABI_VERSION_NO=${OPENTELEMETRY_ABI_VERSION_NO})
118118

119+
if(WITH_OTLP_RETRY_PREVIEW)
120+
target_compile_definitions(opentelemetry_api
121+
INTERFACE ENABLE_OTLP_RETRY_PREVIEW)
122+
endif()
123+
119124
if(WITH_OTLP_GRPC_SSL_MTLS_PREVIEW)
120125
target_compile_definitions(opentelemetry_api
121126
INTERFACE ENABLE_OTLP_GRPC_SSL_MTLS_PREVIEW)
@@ -126,6 +131,11 @@ if(WITH_METRICS_EXEMPLAR_PREVIEW)
126131
INTERFACE ENABLE_METRICS_EXEMPLAR_PREVIEW)
127132
endif()
128133

134+
if(WITH_THREAD_INSTRUMENTATION_PREVIEW)
135+
target_compile_definitions(opentelemetry_api
136+
INTERFACE ENABLE_THREAD_INSTRUMENTATION_PREVIEW)
137+
endif()
138+
129139
if(WITH_OTLP_HTTP_COMPRESSION)
130140
target_compile_definitions(opentelemetry_api
131141
INTERFACE ENABLE_OTLP_COMPRESSION_PREVIEW)

0 commit comments

Comments
 (0)