Skip to content

Commit

Permalink
Cleanup INSTALL.md (#1757)
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomsonTan authored Nov 10, 2022
1 parent 702a68c commit b157216
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can link OpenTelemetry C++ SDK with libraries provided in

## Build instructions using CMake

### Prerequisites for CMake
### Prerequisites for CMake build

- A supported platform (e.g. Windows, macOS or Linux). Refer to [Platforms
Supported](./README.md#supported-development-platforms) for more information.
Expand All @@ -38,9 +38,9 @@ You can link OpenTelemetry C++ SDK with libraries provided in
[GoogleBenchmark Build
Instructions](https://github.com/google/benchmark#installation).
- Apart from above core requirements, the Exporters and Propagators have their
build dependencies which are not covered here. E.g, Otlp Exporter needs
grpc/protobuf library, Zipkin exporter needs nlohmann-json and libcurl, ETW
exporter need nlohmann-json to build. This is covered in the build
build dependencies which are not covered here. E.g, the OTLP Exporter needs
grpc/protobuf library, the Zipkin exporter needs nlohmann-json and libcurl,
the ETW exporter needs nlohmann-json to build. This is covered in the build
instructions for each of these components.

### Building as standalone CMake Project
Expand All @@ -50,8 +50,7 @@ You can link OpenTelemetry C++ SDK with libraries provided in
```console
# Change to the directory where you want to create the code repository
$ cd ~
$ mkdir source && cd source
$ git clone --recursive https://github.com/open-telemetry/opentelemetry-cpp
$ mkdir source && cd source && git clone --recursive https://github.com/open-telemetry/opentelemetry-cpp
Cloning into 'opentelemetry-cpp'...
...
Resolving deltas: 100% (3225/3225), done.
Expand All @@ -63,8 +62,7 @@ You can link OpenTelemetry C++ SDK with libraries provided in

```console
$ cd opentelemetry-cpp
$ mkdir build && cd build
$ cmake ..
$ mkdir build && cd build && cmake ..
-- The C compiler identification is GNU 9.3.0
-- The CXX compiler identification is GNU 9.3.0
...
Expand All @@ -83,12 +81,12 @@ You can link OpenTelemetry C++ SDK with libraries provided in
inclusion in shared libraries, this variable is used.
- `-DBUILD_SHARED_LIBS=ON` : To build shared libraries for the targets.
Please refer to note [below](#building-shared-libs-for-windows) for
Windows DLL support
- `-DWITH_OTLP=ON` : To enable building Otlp exporter.
Windows DLL support.
- `-DWITH_OTLP=ON` : To enable building OTLP exporter.
- `-DWITH_PROMETHEUS=ON` : To enable building prometheus exporter.

3. Once build configuration is created, build the CMake targets - this includes
building SDKs, and building unittests for API and SDK. Note that since API is
3. Once the build configuration is created, build the CMake targets - this
includes building SDKs and unittests for API and SDK. Note that since API is
header only library, no separate build is triggered for it.

```console
Expand Down Expand Up @@ -121,7 +119,7 @@ You can link OpenTelemetry C++ SDK with libraries provided in
files for SDK at custom/default install location.

```console
$ cmake --install . --prefix /<install_root>/
$ cmake --install . --prefix /<install-root>/
-- Installing: /<install-root>/lib/cmake/opentelemetry-cpp/opentelemetry-cpp-config.cmake
-- Installing: /<install-root>/lib/cmake/opentelemetry-cpp/opentelemetry-cpp-config-version.cmake
...
Expand Down Expand Up @@ -155,7 +153,7 @@ NOTE: Experimental, and not supported for all the components. Make sure the
there is a different version of googletest already installed in system-defined
path.

### Prerequisites for Bazel
### Prerequisites for Bazel build

- A supported platform (e.g. Windows, macOS or Linux). Refer to [Platforms
Supported](./README.md#supported-development-platforms) for more information.
Expand Down

1 comment on commit b157216

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'OpenTelemetry-cpp api Benchmark'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 2.

Benchmark suite Current: b157216 Previous: 702a68c Ratio
BM_SpanCreation 130.5249923166774 ns/iter 53.108042384498816 ns/iter 2.46
BM_NestedSpanCreationWithScope 2423.24587787294 ns/iter 1059.3075945655416 ns/iter 2.29
BM_SpanCreationWithManualSpanContextPropagation 476.75223178918753 ns/iter 227.87902170516855 ns/iter 2.09

This comment was automatically generated by workflow using github-action-benchmark.

Please sign in to comment.