diff --git a/README.md b/README.md index 78b0d67..c659533 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ MATLAB® interface to [OpenTelemetry™](https://opentelemetry.io/), based on the [OpenTelemetry Specification](https://opentelemetry.io/docs/reference/specification/). OpenTelemetry is an observability framework for creating and managing telemetry data, such as traces, metrics, and logs. This data can then be sent to an observability back-end for monitoring, alerts, and analysis. -## Status +### Status - Currently only tracing is supported. Metrics and logs will be in the future. - This package is supported and has been tested on Windows® and Linux®. We will add macOS support in the future. @@ -37,17 +37,17 @@ Before proceeding, ensure that the below products are installed: 2. Download, build and install [OpenTelemetry C++](https://github.com/open-telemetry/opentelemetry-cpp) ``` -cd \\ -cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_POSITION_INDEPENDENT_CODE=ON -DCMAKE_CXX_STANDARD=20 -DWITH_OTLP_HTTP=TRUE -DWITH_OTLP_GRPC=TRUE -DOPENTELEMETRY_INSTALL=ON -DCMAKE_TOOLCHAIN_FILE=\\scripts\buildsystems\vcpkg.cmake +cd +cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_POSITION_INDEPENDENT_CODE=ON -DCMAKE_CXX_STANDARD=20 -DWITH_OTLP_HTTP=TRUE -DWITH_OTLP_GRPC=TRUE -DOPENTELEMETRY_INSTALL=ON -DCMAKE_TOOLCHAIN_FILE=\scripts\buildsystems\vcpkg.cmake cmake --build build --config Release --target ALL_BUILD -cmake --install build --prefix \\ +cmake --install build --prefix ``` 3. Download OpenTelemetry MATLAB 4. Build and install OpenTelemetry MATLAB ``` -cd \\ -cmake -S . -B build -DCMAKE_INSTALL_PREFIX=\\ -DCMAKE_TOOLCHAIN_FILE=\\scripts\buildsystems\vcpkg.cmake -DCMAKE_PREFIX_PATH=\\ +cd +cmake -S . -B build -DCMAKE_INSTALL_PREFIX= -DCMAKE_TOOLCHAIN_FILE=\scripts\buildsystems\vcpkg.cmake -DCMAKE_PREFIX_PATH= cmake --build build --config Release --target install ``` @@ -56,12 +56,12 @@ cmake --build build --config Release --target install ## Getting Started 1. Start OpenTelemetry Collector ``` -otelcol --config \\ +otelcol --config ``` 2. Start MATLAB 3. Add the OpenTelemetry MATLAB install directories to your MATLAB path ``` ->> addpath \\ +>> addpath ``` ## Examples 1. Create a default tracer provider and save it. @@ -81,7 +81,7 @@ otelcol --config \\ 4. If your collector is configured to display the data, you should see your span displayed. ## Help -To view documentation of individual function, type "help ". For example, +To view documentation of individual function, type "help \\". For example, ``` >> help opentelemetry.sdk.trace.TracerProvider ```