Skip to content

Commit

Permalink
Move integrations to registry (#4991)
Browse files Browse the repository at this point in the history
Signed-off-by: svrnm <[email protected]>
Co-authored-by: Patrice Chalin <[email protected]>
  • Loading branch information
svrnm and chalin authored Aug 7, 2024
1 parent 3078352 commit 825010e
Show file tree
Hide file tree
Showing 78 changed files with 1,514 additions and 397 deletions.
2 changes: 1 addition & 1 deletion .textlintrc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ filters:
allowlist:
allow:
# Don't check registry .yml file fields for language, repo, url and tags:
- '/^\s*(?:language|repo|name|docs|url): .*$/m'
- '/^\s*(?:language|repo|name|docs|url|website): .*$/m'
- /^(?:tags):(\s*-.+$)*/m
# Hugo template syntax:
- /{{.*?}}/
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/cpp/library.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linkTitle: Libraries
weight: 40
---

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

## Using instrumentation libraries

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/erlang/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 40
cSpell:ignore: Ecto Hex
---

{{% docs/languages/libraries-intro "Erlang" %}}
{{% docs/languages/libraries-intro "erlang" %}}

## Use instrumentation libraries

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/go/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ aliases:
weight: 40
---

{{% docs/languages/libraries-intro Go %}}
{{% docs/languages/libraries-intro "go" %}}

## Use instrumentation libraries

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/java/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 40
cSpell:ignore: getenv httpclient println
---

{{% docs/languages/libraries-intro "Java" %}}
{{% docs/languages/libraries-intro "java" %}}

## Use Instrumentation Libraries

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/js/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: How to instrument libraries an app depends on
cSpell:ignore: metapackage metapackages
---

{{% docs/languages/libraries-intro JavaScript %}}
{{% docs/languages/libraries-intro "js" %}}

## Use Instrumentation Libraries

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/net/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linkTitle: Libraries
weight: 40
---

{{% docs/languages/libraries-intro ".NET" %}}
{{% docs/languages/libraries-intro "dotnet" %}}

## Use Instrumentation Libraries

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/php/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 40
cSpell:ignore: Packagist
---

{{% docs/languages/libraries-intro "PHP" %}}
{{% docs/languages/libraries-intro "php" %}}

## Use instrumentation libraries

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/python/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 40
cSpell:ignore: HTTPX httpx instrumentor uninstrument
---

{{% docs/languages/libraries-intro "Python" %}}
{{% docs/languages/libraries-intro "python" %}}

## Use instrumentation libraries

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/ruby/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ cSpell:ignore: faraday metapackage sinatra
weight: 30
---

{{% docs/languages/libraries-intro Ruby %}}
{{% docs/languages/libraries-intro ruby %}}

## Use Instrumentation Libraries

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/rust/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 40
description: How to instrument libraries an app depends on
---

{{% docs/languages/libraries-intro Rust %}}
{{% docs/languages/libraries-intro rust %}}

## Use Instrumentation Libraries

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/swift/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ cSpell:ignore: darwin inout iphone NSURL wifi

<!-- markdownlint-disable no-duplicate-heading -->

{{% docs/languages/libraries-intro "Swift" %}}
{{% docs/languages/libraries-intro "swift" %}}

## Use instrumentation libraries

Expand Down
30 changes: 26 additions & 4 deletions content/en/ecosystem/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,29 @@ The mission of OpenTelemetry is
[to enable effective observability by making high-quality, portable telemetry ubiquitous](/community/mission/).
In other words, observability should be built in into the software you develop.

While external instrumentation through
[zero code instrumentation solutions](/docs/concepts/instrumentation/zero-code)
and
[instrumentation libraries](/docs/specs/otel/overview/#instrumentation-libraries)
provide a convenient way to make your application observable, we believe that
ultimately all applications should either integrated the OpenTelemetry APIs and
SDKs directly for native telemetry, or provide a first-party plugin that fits
into the ecosystem of the given software.

On this page you will find a sample of libraries, services and apps, that
provide such a native instrumentation or first class plugin.

## Libraries

Native library instrumentation with OpenTelemetry provides better observability
and developer experience for users, removing the need for libraries to expose
and document hooks. Below you will find a list of libraries that use the
OpenTelemetry API to provide out of the box observability.

{{% ecosystem/integrations-table "native libraries" %}}

## Applications and Services

The following list contains a sample of libraries, services, and apps that have
either integrated OpenTelemetry APIs and SDKs directly for native telemetry or
provide a first-party plugin that fits into their own extensibility ecosystem.
Expand All @@ -17,14 +40,13 @@ You will find open source (OSS) projects at the beginning of the list;
commercial projects follow. Projects which are part of the
[CNCF](https://www.cncf.io/) show a small CNCF logo beside their name.

{{% ecosystem/integrations-table %}}
{{% ecosystem/integrations-table "application integrations" %}}

## How to add your integration {#how-to-add}

To have your library, service, or app listed, submit a PR with an entry added to
the
[integrations list](https://github.com/open-telemetry/opentelemetry.io/tree/main/data/ecosystem/integrations.yaml).
The entry should include the following:
the [registry](/ecosystem/registry/adding). The entry should include the
following:

- Link to the main page of your library, service, or app
- Link to the documentation that explains how enable observability using
Expand Down
Loading

0 comments on commit 825010e

Please sign in to comment.