File: dependencies.md

package info (click to toggle)
opentelemetry-cpp 1.23.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 11,372 kB
  • sloc: cpp: 96,239; sh: 1,766; makefile: 36; python: 31
file content (107 lines) | stat: -rw-r--r-- 4,611 bytes parent folder | download
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# Dependencies and Licenses

There are

- External dependencies as linkable libraries or externally installed headers, and
- Internal dependencies as the part of code from external libraries
  backported/copied in main repo.

The minimum required versions of the third-party libraries that are required can
be found in the [third_party_minimum](/install/cmake/third_party_minimum) file.
The minimum supported versions are listed here for convenience but the
authoritative source is always the linked file.

Both these dependencies are listed here:

## Internal dependencies

- [nostd::variant](/api/include/opentelemetry/nostd/internal/absl/types/variant.h):
  This is backported from [Abseil C++
  libraries](https://github.com/abseil/abseil-cpp) and used as default variant
  implementation. License: `Apache License 2.0`
- [TraceLoggingDynamic](/exporters/etw/include/opentelemetry/exporters/etw/TraceLoggingDynamic.h):
  Dynamic TraceLogging Provider API for C++ used by ETW exporter. License: `MIT License`

## External dependencies

- [API](/api)
  &
  [SDK](/sdk):
  - Uses Standard C++ library for latest features (std::string_view,
    std::variant, std::span, std::shared_ptr, std::unique_ptr) with  C++14/17/20
    compiler if cmake option `WITH_STL` is enabled
    or macro `OPENTELEMETRY_STL_VERSION` is defined.
    License: `GNU General Public License`
    - For C++14/17 compilers, fallback to gsl::span if [GSL C++
      library](https://github.com/microsoft/GSL) is installed. License: `MIT
      License`
    - libc++ 14.0.0 do not support construct std::span from a range or container
      .We don't use the std::span in this situation.Users can also define
      `OPENTELEMETRY_OPTION_USE_STD_SPAN=0` to indicate nostd:span will always
      not be a alias for std::span.

- [OTLP/HTTP+JSON](/exporters/otlp)
  exporter:
  - [protobuf](https://github.com/protocolbuffers/protobuf) (v3.21.6 or later):
    Library to serialize structured data.
    - OTLP messages are constructed as protobuf payloads.
    - `protoc` compiler is used to generate C++ stubs for proto files provided
      by `opentelemetry-proto`.
    - `libprotobuf` library is used for generating serialized trace/metrics/log
      data to be sent to opentelemetry collector.
    - License: The library is licensed
      [here](https://github.com/protocolbuffers/protobuf/blob/master/LICENSE).
      The  code generated by protoc compiler is owned by the owner of `.proto`
      file.
  - [libcurl](https://curl.se/libcurl/) (curl-7_81_0 or later):
    the multiprotocol file transfer library.
    - Export connects with opentelemetry collector over HTTP protocol using
      libcurl library
    - License: Inspired by `MIT/X` but not same.
      <https://curl.se/docs/copyright.html>
  - [nlohmann/json](https://github.com/nlohmann/json) (v3.10.5 or later):
    JSON for Modern C++.
    - protobuf serialized otlp messages are encoded in JSON format using this
      library.
    - License: `MIT License`
  - [zlib](https://www.zlib.net/) (v1.2.11 or later):
    A Massively Spiffy Yet Delicately Unobtrusive Compression Library.
    - The `http_client` utilizes zlib to compress the message body and send
      it in gzip format.
    - License: The library is licensed
      [here](https://www.zlib.net/zlib_license.html)

- [OTLP/gRPC](/exporters/otlp)
  exporter:
  - `protobuf`  OTLP messages are constructed as protobuf payloads.
  - [gRPC](https://github.com/grpc/grpc) (v1.49.2 or later): An RPC library and framework
    - Exporter communicates with OTLP collector using gRPC transport mechanism.
    - License: `Apache License 2.0`

- [Zipkin](/exporters/zipkin)
  exporter:
  - `libcurl` for connecting with Zipkin server over HTTP protocol.
  - `nlohmann/json` for encoding Zipkin messages.

- [ETW](/exporters/etw)
  exporter:
  - `nlohmann/json` for generating MessagePack serialization for message to be
    transmitted to ETW.

- [Prometheus](/exporters/prometheus)
  exporter:
  - [`prometheus-cpp`](https://github.com/jupp0r/prometheus-cpp)
    (v1.1.0 or later): Prometheus Client Library for Modern C++
    - License: `MIT License`

- [ElasticSearch](/exporters/elasticsearch)
  exporter:
  - `libcurl` for connecting with Elasticsearch server over HTTP protocol.
  - `nlohmann/json` for encoding Elastic Search messages.

- [Opentracing](/opentracing-shim)
  shim:
  - [`opentracing-cpp`](https://github.com/opentracing/opentracing-cpp)
    (v1.6.0 or later): OpenTracing API for C++
    - A bridge layer implementing the OpenTracing API using the OpenTelemetry API
    - License: `Apache License 2.0`