Skip to content

Commit 495f497

Browse files
authored
[DOC] Document minimum required versions (#3562)
1 parent ba38077 commit 495f497

File tree

2 files changed

+19
-11
lines changed

2 files changed

+19
-11
lines changed

docs/dependencies.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ There are
66
- Internal dependencies as the part of code from external libraries
77
backported/copied in main repo.
88

9+
The minimum required versions of the third-party libraries that are required can
10+
be found in the [third_party_minimum](/install/cmake/third_party_minimum) file.
11+
The minimum supported versions are listed here for convenience but the
12+
authoritative source is always the linked file.
13+
914
Both these dependencies are listed here:
1015

1116
## Internal dependencies
@@ -37,8 +42,8 @@ Both these dependencies are listed here:
3742

3843
- [OTLP/HTTP+JSON](/exporters/otlp)
3944
exporter:
40-
- [protobuf](https://github.com/protocolbuffers/protobuf): Library to
41-
serialize structured data.
45+
- [protobuf](https://github.com/protocolbuffers/protobuf) (v3.21.6 or later):
46+
Library to serialize structured data.
4247
- OTLP messages are constructed as protobuf payloads.
4348
- `protoc` compiler is used to generate C++ stubs for proto files provided
4449
by `opentelemetry-proto`.
@@ -48,18 +53,19 @@ Both these dependencies are listed here:
4853
[here](https://github.com/protocolbuffers/protobuf/blob/master/LICENSE).
4954
The code generated by protoc compiler is owned by the owner of `.proto`
5055
file.
51-
- [libcurl](https://curl.se/libcurl/) : the multiprotocol file transfer
52-
library.
56+
- [libcurl](https://curl.se/libcurl/) (curl-7_81_0 or later):
57+
the multiprotocol file transfer library.
5358
- Export connects with opentelemetry collector over HTTP protocol using
5459
libcurl library
5560
- License: Inspired by `MIT/X` but not same.
5661
<https://curl.se/docs/copyright.html>
57-
- [nlohmann/json](https://github.com/nlohmann/json): JSON for Modern C++.
62+
- [nlohmann/json](https://github.com/nlohmann/json) (v3.10.5 or later):
63+
JSON for Modern C++.
5864
- protobuf serialized otlp messages are encoded in JSON format using this
5965
library.
6066
- License: `MIT License`
61-
- [zlib](https://www.zlib.net/): A Massively Spiffy Yet Delicately
62-
Unobtrusive Compression Library.
67+
- [zlib](https://www.zlib.net/) (v1.2.11 or later):
68+
A Massively Spiffy Yet Delicately Unobtrusive Compression Library.
6369
- The `http_client` utilizes zlib to compress the message body and send
6470
it in gzip format.
6571
- License: The library is licensed
@@ -68,7 +74,7 @@ Both these dependencies are listed here:
6874
- [OTLP/gRPC](/exporters/otlp)
6975
exporter:
7076
- `protobuf` OTLP messages are constructed as protobuf payloads.
71-
- [gRPC](https://github.com/grpc/grpc): An RPC library and framework
77+
- [gRPC](https://github.com/grpc/grpc) (v1.49.2 or later): An RPC library and framework
7278
- Exporter communicates with OTLP collector using gRPC transport mechanism.
7379
- License: `Apache License 2.0`
7480

@@ -84,8 +90,8 @@ Both these dependencies are listed here:
8490

8591
- [Prometheus](/exporters/prometheus)
8692
exporter:
87-
- [`prometheus-cpp`](https://github.com/jupp0r/prometheus-cpp) Prometheus
88-
Client Library for Modern C++
93+
- [`prometheus-cpp`](https://github.com/jupp0r/prometheus-cpp)
94+
(v1.1.0 or later): Prometheus Client Library for Modern C++
8995
- License: `MIT License`
9096

9197
- [ElasticSearch](/exporters/elasticsearch)
@@ -96,6 +102,6 @@ Both these dependencies are listed here:
96102
- [Opentracing](/opentracing-shim)
97103
shim:
98104
- [`opentracing-cpp`](https://github.com/opentracing/opentracing-cpp)
99-
OpenTracing API for C++
105+
(v1.6.0 or later): OpenTracing API for C++
100106
- A bridge layer implementing the OpenTracing API using the OpenTelemetry API
101107
- License: `Apache License 2.0`

install/cmake/third_party_minimum

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
# Minimum supported version git tags of third-party dependencies
55
# Format: <dependency_name>=<release_git_tag>
66

7+
# Update docs/dependencies.md whenever the minimum version of a library is modified.
8+
79
abseil=20220623.2
810
zlib=v1.2.11
911
curl=curl-7_81_0

0 commit comments

Comments
 (0)