Rework components concept page (#2080)

This commit is contained in:
Severin Neumann 2022-12-09 17:39:29 +01:00 committed by GitHub
parent ea51cadc2a
commit a752e6f9a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 13 deletions

View File

@ -7,10 +7,12 @@ weight: 20
OpenTelemetry is currently made up of several main components:
- Cross-language specification
- Tools to collect, transform, and export telemetry data
- Per-language SDKs
- Automatic instrumentation and contrib packages
- [Cross-language specification](/docs/reference/specification/)
- [The OpenTelemetry Collector](/docs/collector)
- [Per-language SDKs](/docs/instrumentation)
- [Per-language instrumentation libraries](/docs/concepts/instrumenting-library/)
- [Per-language Automatic Instrumentation](/docs/concepts/instrumenting/#automatic-instrumentation)
- [K8s Operator](/docs/k8s-operator)
OpenTelemetry lets you replace the need for vendor-specific SDKs and tools for
generating and exporting telemetry data.
@ -45,31 +47,46 @@ supports processing and filtering telemetry data before it gets exported.
Collector contrib packages bring support for more data formats and vendor
backends.
For more information, see [Data Collection](/docs/concepts/data-collection/).
For more information, see [Collector](/docs/collector/).
## Language SDKs
OpenTelemetry also has language SDKs that let you use the OpenTelemetry API to
generate telemetry data with your language of choice and export that data to a
preferred backend. These SDKs also let you incorporate automatic instrumentation
preferred backend. These SDKs also let you incorporate instrumentation libraries
for common libraries and frameworks that you can use to connect to manual
instrumentation in your application. Vendors often make distributions of
language SDKs to make exporting to their backends simpler.
instrumentation in your application.
For more information, see [Instrumenting](/docs/concepts/instrumenting).
## Automatic Instrumentation
## Instrumentation Libraries
OpenTelemetry supports a broad number of components that generate relevant
telemetry data from popular libraries and frameworks for supported languages.
For example, inbound and outbound HTTP requests from an HTTP library will
generate data about those requests. Using automatic instrumentation may differ
from language to language, where one might prefer or require the use of a
component that you load alongside your application, and another might prefer
that you pull in a package explicitly in your codebase.
generate data about those requests.
It is a long-term goal that popular libraries are authored to be observable out
of the box, such that pulling in a separate component is not required.
For more information, see
[Instrumenting Libraries](/docs/concepts/instrumenting-library/).
## Automatic Instrumentation
If applicable a language specific implementation of OpenTelemetry will provide a
way to instrument your application without touching your source code. While the
underlying mechanism depends on the language, at a minimum this will add the
OpenTelemetry API and SDK capabilities to your application. Additionally they
may add a set of Instrumentation Libraries and exporter dependencies.
For more information, see
[Instrumenting](/docs/concepts/instrumenting/#automatic-instrumentation).
## K8s operator
The OpenTelemetry Operator is an implementation of a Kubernetes Operator. The
operator manages the OpenTelemetry Collector and auto-instrumentation of the
workloads using OpenTelemetry.
For more information, see [K8s Operator](/docs/k8s-operator/)