.. .. Copyright (c) 2019 AT&T Intellectual Property. .. .. Copyright (c) 2019 Nokia. .. .. .. Licensed under the Creative Commons Attribution 4.0 International .. .. Public License (the "License"); you may not use this file except .. .. in compliance with the License. You may obtain a copy of the License at .. .. .. https://creativecommons.org/licenses/by/4.0/ .. .. .. Unless required by applicable law or agreed to in writing, documentation .. .. distributed under the License is distributed on an "AS IS" BASIS, .. .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .. .. See the License for the specific language governing permissions and .. .. limitations under the License. .. .. This source code is part of the near-RT RIC (RAN Intelligent Controller) .. platform project (RICP). .. Developer Guide =============== The library includes a function for creating a configured tracer instance. It hides the underlaying tracer implementation from the application. Tracelib Cpp Repo ----------------- .. code:: bash git clone "https://gerrit.o-ran-sc.org/r/ric-plt/tracelibcpp" Usage ----- Create a global tracer .. code:: bash #include #include opentracing::Tracer::InitGlobal(tracelibcpp::createTracer("my-service-name")); Span context propagation between different software components in RIC is using a TextMap carrier and JSON format serialization. The [opentracing C++](https://github.com/opentracing/opentracing-cpp) Readme gives examples how span context **inject** and **extract** with textmap can be done. Serialization to JSON can be done with any JSON library. Configuration ------------- The trace library currently supports only [Jaeger](https://www.jaegertracing.io/) [C++ client](https://github.com/jaegertracing/jaeger-client-cpp) tracer implementation. The configuration is done using environment variables: +------------------------------+-------------------------------------+----------------+ | **environment variable** | **values** | **default** | | | | | +------------------------------+-------------------------------------+----------------+ | TRACING_ENABLED | 1, true, 0, false | false | | | | | +------------------------------+-------------------------------------+----------------+ | TRACING_JAEGER_SAMPLER_TYPE | const, propabilistic, ratelimiting | const | | | | | +------------------------------+-------------------------------------+----------------+ | TRACING_JAEGER_SAMPLER_PARAM | float | 0.001 | | | | | +------------------------------+-------------------------------------+----------------+ | TRACING_JAEGER_AGENT_ADDR | IP addr + port | 127.0.0.1:6831 | | | | | +------------------------------+-------------------------------------+----------------+ | TRACING_JAEGER_LOG_LEVEL | all, error, none | none | | | | | +------------------------------+-------------------------------------+----------------+ Meaning of the configuration variables is described in Jaeger web pages. By default a no-op tracer is created. Pre-Requisites -------------- * cmake * gcc/c++ * opentracing-cpp version 1.5.0 Compilation ----------- .. code:: bash mkdir build cd build cmake .. make Unit testing ------------ To run unit tests the project needs to be configured with testing option .. code:: bash cmake -DWITH_TESTING=ON .. make check Or with output .. code:: bash CTEST_OUTPUT_ON_FAILURE=1 make check Coverage -------- Unit testing generates also coverage data. To get that in html format run commands, assuming you are building in `build` dir under the tracelibcpp .. code:: bash lcov -c --no-external --base-directory $(dirname $PWD) --directory . --output-file cov.info genhtml cov.info Binary package support ---------------------- Binary packages of the libary can be created with `make package` target, or with the Dockerfile in the `ci` directory. The Docker build executes unit tests and compiles binary packages which can then be exported from the container by running it and giving the target directory as a command line argument. The target directory must mounted to the container. .. code:: bash docker build -t tracelibcpp -f ci/Dockerfile . # Export binary packages to /tmp docker run -v /tmp:/tmp tracelibcpp /tmp