Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "using instrumentation libraries" for cpp #4388

Merged
merged 19 commits into from
May 24, 2024
Merged
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions content/en/docs/languages/cpp/library.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: Using instrumentation libraries
linkTitle: Libraries
weight: 40
---

{{% docs/languages/libraries-intro "C++" %}}


## Using instrumentation libraries


When you develop an app, you might use third-party libraries and frameworks to accelerate your work. If you then
instrument your app using OpenTelemetry, you might want to avoid spending additional time to manually add traces,
logs, and metrics to the third-party libraries and frameworks you use.

Many libraries and frameworks already support OpenTelemetry or are supported through OpenTelemetry
[instrumentation](https://opentelemetry.io/docs/concepts/instrumentation/libraries/),
so that they can generate telemetry you can export to an observability backend.

If you are instrumenting an app or service that use third-party libraries or frameworks, follow these instructions to
learn how to use natively instrumented libraries and instrumentation libraries for your dependencies.


## Use natively instrumented libraries

If a library comes with OpenTelemetry support by default, you can get traces, metrics, and logs emitted from that
library by adding and setting up the OpenTelemetry SDK with your app.

The library might require some additional configuration for the instrumentation. See the documentation for that
library to learn more.


If a library doesn't include OpenTelemetry support, you can use
[instrumentation libraries](https://opentelemetry.io/docs/specs/otel/glossary/#instrumentation-library)
to generate telemetry data for a library or framework.
svrnm marked this conversation as resolved.
Show resolved Hide resolved

For example,
[NGINX instrumentation](https://github.com/open-telemetry/opentelemetry-cpp-contrib/tree/main/instrumentation/nginx)
adds OpenTelemetry distributed tracing support to NGINX.
theletterf marked this conversation as resolved.
Show resolved Hide resolved


## Setup

To set up an instrumentation library see [otel-cpp-contrib](https://github.com/open-telemetry/opentelemetry-cpp-contrib/tree/main/instrumentation)


## Available packages

A full list of instrumentation libraries available can be found in the [openTelemetry registry](https://opentelemetry.io/ecosystem/registry/?language=cpp&component=instrumentation)

Check failure on line 50 in content/en/docs/languages/cpp/library.md

View workflow job for this annotation

GitHub Actions / TEXT linter

textlint terminology error

Incorrect usage of the term: “openTelemetry”, use “OpenTelemetry” instead


## Next steps

After you've set up instrumentation libraries, you might want to add
[additional instrumentation](https://opentelemetry.io/docs/languages/cpp/instrumentation/) to collect
custom telemetry data.

You might also want to configure an appropriate exporter to
[export your telemetry data]( https://opentelemetry.io/docs/languages/cpp/exporters/) to one or more
telemetry backends.
Loading