Skip to content

Commit

Permalink
Add "using instrumentation libraries" for cpp (#4388)
Browse files Browse the repository at this point in the history
  • Loading branch information
devc007 authored May 24, 2024
1 parent 601ce6c commit 924b2be
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 0 deletions.
56 changes: 56 additions & 0 deletions content/en/docs/languages/cpp/library.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
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](/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](/docs/specs/otel/glossary/#instrumentation-library)
to generate telemetry data for a library or framework.

## 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](/ecosystem/registry/?language=cpp&component=instrumentation)

## Next steps

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

You might also want to configure an appropriate exporter to
[export your telemetry data](/docs/languages/cpp/exporters/) to one or more
telemetry backends.
20 changes: 20 additions & 0 deletions static/refcache.json
Original file line number Diff line number Diff line change
Expand Up @@ -6043,6 +6043,22 @@
"StatusCode": 206,
"LastSeen": "2024-02-23T22:55:04.014798-05:00"
},
"https://opentelemetry.io/docs/concepts/instrumentation/libraries/": {
"StatusCode": 206,
"LastSeen": "2024-04-30T09:31:37.735092936Z"
},
"https://opentelemetry.io/docs/languages/cpp/exporters/": {
"StatusCode": 206,
"LastSeen": "2024-04-30T09:31:38.598060401Z"
},
"https://opentelemetry.io/docs/languages/cpp/instrumentation/": {
"StatusCode": 206,
"LastSeen": "2024-04-30T09:31:38.379400427Z"
},
"https://opentelemetry.io/docs/specs/otel/glossary/#instrumentation-library": {
"StatusCode": 206,
"LastSeen": "2024-04-30T09:31:37.929550219Z"
},
"https://opentelemetry.io/docs/specs/otel/protocol": {
"StatusCode": 206,
"LastSeen": "2024-02-24T14:33:05.630341-08:00"
Expand All @@ -6055,6 +6071,10 @@
"StatusCode": 206,
"LastSeen": "2024-03-19T10:16:49.992495889Z"
},
"https://opentelemetry.io/ecosystem/registry/": {
"StatusCode": 206,
"LastSeen": "2024-04-30T09:31:38.297519267Z"
},
"https://opentracing.io": {
"StatusCode": 206,
"LastSeen": "2024-01-18T19:07:33.813401-05:00"
Expand Down

0 comments on commit 924b2be

Please sign in to comment.