Skip to content

Commit f964517

Browse files
Fix upstream references (#437)
* Fix upstream references * Update docs/reference/edot-sdks/dotnet/setup/zero-code.md Co-authored-by: Aleksandra Spilkowska <[email protected]> * Update docs/reference/edot-sdks/nodejs/configuration.md Co-authored-by: Aleksandra Spilkowska <[email protected]> --------- Co-authored-by: Aleksandra Spilkowska <[email protected]>
1 parent 7243dd7 commit f964517

35 files changed

+87
-87
lines changed

docs/reference/architecture/hosts_vms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ These collectors have two main purposes:
2727
See the recommended architectures per Elastic deployment scenarios:
2828

2929
:::{note}
30-
Elastic's Observability solution is technically compatible with edge setups that are fully based on upstream OTel components as long as the ingestion path follows the recommendations outlined in the following sections.
30+
Elastic's Observability solution is technically compatible with edge setups that are fully based on contrib OTel components as long as the ingestion path follows the recommendations outlined in the following sections.
3131
:::
3232

3333
### Elastic Cloud Serverless

docs/reference/architecture/k8s.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ For self-managed and {{ech}} deployment models the Gateway Collector does some a
4242
See the recommended architectures per Elastic deployment scenarios:
4343

4444
::::{note}
45-
Elastic's Observability solution is technically compatible with setups that are fully based on upstream OTel components, as long as the ingestion path follows the recommendations outlined in following sub-sections for the different Elastic deployment options.
45+
Elastic's Observability solution is technically compatible with setups that are fully based on contrib OTel components, as long as the ingestion path follows the recommendations outlined in following sub-sections for the different Elastic deployment options.
4646
::::
4747

4848
### Elastic Cloud Serverless

docs/reference/compatibility/collectors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ For information on the compatibility of each Collector component, refer to the [
6161

6262
## Other Collector distributions
6363

64-
Non-EDOT distributions of the OTel Collector, such as custom Collector builds, upstream Collector distributions, and so on aren't officially supported through Elastic but are technically compatible ([Compatible]) if they contain the [required OTel Collector components](/reference/edot-collector/custom-collector.md) and are configured like the EDOT Collector.
64+
Non-EDOT distributions of the OTel Collector, such as custom Collector builds, contrib Collector distributions, and so on aren't officially supported through Elastic but are technically compatible ([Compatible]) if they contain the [required OTel Collector components](/reference/edot-collector/custom-collector.md) and are configured like the EDOT Collector.
6565

6666
You can retrieve required components and configuration options from the [example configuration files](https://github.com/elastic/elastic-agent/tree/v<COLLECTOR_VERSION>/internal/pkg/otel/samples/linux) for the EDOT Collector.
6767

68-
For a comparison between EDOT and the upstream OTel, refer to [EDOT compared to upstream OTel](edot-vs-upstream.md).
68+
For a comparison between EDOT and the contrib OTel Collector, refer to [EDOT compared to contrib Collector](edot-vs-upstream.md).
6969

7070
[Incompatible]: nomenclature.md
7171
[Compatible]: nomenclature.md
Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
navigation_title: EDOT compared to upstream OTel
3-
description: Differences between Elastic Distributions of OpenTelemetry (EDOT) and upstream OpenTelemetry.
2+
navigation_title: EDOT compared to contrib Collector
3+
description: Differences between Elastic Distributions of OpenTelemetry (EDOT) and contrib OpenTelemetry Collector.
44
applies_to:
55
stack:
66
serverless:
@@ -12,13 +12,13 @@ products:
1212
- id: edot-sdk
1313
---
1414

15-
# EDOT compared to upstream OpenTelemetry
15+
# EDOT compared to contrib OpenTelemetry Collector
1616

17-
The [Elastic Distributions of OpenTelemetry (EDOT)](/reference/index.md) are based on the upstream OpenTelemetry project but include additional features and configurations that are specific to the Elastic ecosystem. Each EDOT component is carefully selected and tested to ensure it works seamlessly with Elastic Stack components.
17+
The [Elastic Distributions of OpenTelemetry (EDOT)](/reference/index.md) are based on the contrib OpenTelemetry project but include additional features and configurations that are specific to the Elastic ecosystem. Each EDOT component is carefully selected and tested to ensure it works seamlessly with Elastic Stack components.
1818

19-
Here are some key differences and considerations when using EDOT compared to upstream OpenTelemetry:
19+
Here are some key differences and considerations when using EDOT compared to contrib OpenTelemetry Collector:
2020

21-
| Feature | EDOT | Upstream OpenTelemetry |
21+
| Feature | EDOT | Contrib |
2222
|---------|------|------------------------|
2323
| Configuration | Configured for Elastic Observability. | Requires manual configuration.|
2424
| Support | Official Elastic support with SLAs. | Community support only. |
@@ -28,15 +28,15 @@ Here are some key differences and considerations when using EDOT compared to ups
2828
| Central management | Central management of OTel SDKs and Collectors. | No central management. |
2929
| Compatibility | Fully compatible with Elastic Stack components. | Compatible but may require additional configuration. |
3030
| Self-managed/ECH | Required for full functionality. | Compatible but without guaranteed support. |
31-
| Updates | Future updates aligned with Elastic Stack releases. | Updates depend on upstream OpenTelemetry release cycle. |
31+
| Updates | Future updates aligned with Elastic Stack releases. | Updates depend on contrib OpenTelemetry release cycle. |
3232
| EDOT-specific components | Includes custom components optimized for Elastic. | Uses standard OpenTelemetry components. |
3333

34-
EDOT offers a streamlined experience with less configuration burden compared to upstream OpenTelemetry. While you can use upstream components with Elastic, these components aren't covered under official Elastic support SLAs.
34+
EDOT offers a streamlined experience with less configuration burden compared to contrib OpenTelemetry Collector. While you can use contrib components with Elastic, these components aren't covered under official Elastic support SLAs.
3535

36-
## EDOT Collector compared to upstream OTel Collector
36+
## EDOT Collector compared to contrib OpenTelemetry Collector
3737

38-
The OpenTelemetry project does not provide a single, recommended distribution of the OpenTelemetry Collector for production use. Instead, it offers a variety of components that can be assembled into a custom Collector. Using the upstream Collector requires careful selection and configuration of components, which can be complex and time-consuming.
38+
The OpenTelemetry project does not provide a single, recommended distribution of the OpenTelemetry Collector for production use. Instead, it offers a variety of components that can be assembled into a custom Collector. Using the contrib Collector requires careful selection and configuration of components, which can be complex and time-consuming.
3939

40-
EDOT Collector is a curated version of the OpenTelemetry Collector that includes specific components and configurations optimized for Elastic Observability. It is designed to work seamlessly with Elastic Stack components, such as Elasticsearch and Kibana, and provides additional features that are not available in the upstream OpenTelemetry Collector.
40+
EDOT Collector is a curated version of the OpenTelemetry Collector that includes specific components and configurations optimized for Elastic Observability. It is designed to work seamlessly with Elastic Stack components, such as Elasticsearch and Kibana, and provides additional features that are not available in the contrib OpenTelemetry Collector.
4141

4242
For a complete list of components included in the EDOT Collector, refer to [EDOT Collector components](/reference/edot-collector/components.md).

docs/reference/compatibility/limitations.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ products:
1414

1515
# Limitations of Elastic Distributions of OpenTelemetry
1616

17-
The Elastic Distributions of OpenTelemetry (EDOT) come with a new way of ingesting data in OTel-native way and format. Elastic is continuously working on providing a great experience with OTel-native data within Elastic solutions, contributing popular Elastic features to the upstream OpenTelemetry projects and aligning concepts with OpenTelemetry.
17+
The Elastic Distributions of OpenTelemetry (EDOT) come with a new way of ingesting data in OTel-native way and format. Elastic is continuously working on providing a great experience with OTel-native data within Elastic solutions, contributing popular Elastic features to the contrib OpenTelemetry projects and aligning concepts with OpenTelemetry.
1818

1919
While EDOT and OTel-native data collection already covers most of the core Observability use cases, the following limitations apply compared to data collection with classic Elastic data ingestion components.
2020

@@ -27,7 +27,7 @@ EDOT already supports most core observability use cases, but in some scenarios,
2727
* **Existing integrations and dashboards:** Many prebuilt Elastic integrations and dashboards are designed for ECS-formatted data and may not work as expected with the OpenTelemetry semantic conventions without customization.
2828
* **Ingest pipelines for structuring logs:** {{es}} ingest pipelines cannot directly parse OTel-native data with dotted field names without preprocessing. See [Centralized parsing and processing of data](#centralized-parsing-and-processing-of-data) for workarounds.
2929
* **Tail-based sampling (TBS):**
30-
If you need the full tail-based sampling capabilities of APM Server, use APM Server with an Elasticsearch output. EDOT does not provide managed TBS. You can run TBS in a self-managed EDOT Collector or any upstream OTel Collector and ingest the sampled traces into Elastic with some caveats - refer to [Tail-based sampling limitations](#tail-based-sampling-tbs) for more information.
30+
If you need the full tail-based sampling capabilities of APM Server, use APM Server with an Elasticsearch output. EDOT does not provide managed TBS. You can run TBS in a self-managed EDOT Collector or any contrib OTel Collector and ingest the sampled traces into Elastic with some caveats - refer to [Tail-based sampling limitations](#tail-based-sampling-tbs) for more information.
3131

3232
Refer to [EDOT data streams compared to classic APM](../compatibility/data-streams.md) for an overview of how these ingestion paths differ.
3333

@@ -43,11 +43,11 @@ Refer to [these examples](/reference/edot-collector/config/configure-logs-collec
4343

4444
## Infrastructure and host metrics
4545

46-
Due to limitations and gaps in data collection with the upstream OTel `hostmetrics`, there are corresponding limitations with the curated infrastructure and host metrics UIs in Elastic.
46+
Due to limitations and gaps in data collection with the contrib OTel `hostmetrics`, there are corresponding limitations with the curated infrastructure and host metrics UIs in Elastic.
4747

4848
| Limitation | Explanation |
4949
|------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
50-
| Host network panels do not display data in some Elastic Observability UIs. | Due to an upstream limitation, `host.network.*` metrics are not available from OpenTelemetry. |
50+
| Host network panels do not display data in some Elastic Observability UIs. | Due to an contrib limitation, `host.network.*` metrics are not available from OpenTelemetry. |
5151
| Process state is unavailable in OpenTelemetry host metrics. | The `process.state` metric is not present and is assigned a dummy value of "Unknown" in the State column of the host processes table. |
5252
| Host OS version and operating system may show as "N/A". | Although the {{es}} exporter processes resource attributes, it may not populate these values. |
5353
| Normalized Load data is missing unless the CPU scraper is enabled. | The `system.load.cores` metric is required for the Normalized Load column in the Hosts table and the Normalized Load visualization in the host detailed view. |
@@ -86,7 +86,7 @@ Runtime metrics can be ingested and used to create custom dashboards. As a tempo
8686

8787
If you need the full tail-based sampling capabilities of APM Server, use APM Server with an Elasticsearch output. EDOT does not provide a managed TBS service.
8888

89-
You can run tail-based sampling in a self-managed EDOT Collector or any upstream OTel Collector and ingest the sampled traces into Elastic, with these caveats:
89+
You can run tail-based sampling in a self-managed EDOT Collector or any contrib OTel Collector and ingest the sampled traces into Elastic, with these caveats:
9090

9191
* **Metric accuracy:** Counts and rate metrics reflect sampled data, not total volumes. The Elastic APM backend cannot extrapolate totals because the `tailsamplingprocessor` does not send sampling probability metadata.
9292
* **Service map coverage:** Some edges between services may be missing.

docs/reference/compatibility/nomenclature.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ products:
1616

1717
OpenTelemetry (OTel) is a modular, extensible framework designed to integrate with a wide range of technologies. Its architecture enables interoperability across many components, extensions, and tools, giving users flexibility to shape their observability pipelines.
1818

19-
Elastic Distributions for OpenTelemetry (EDOT) are built from upstream OTel components and are technically compatible with a broad set of community components. Users can also send data to Elastic using other upstream OTel components or distributions like the contrib Collector and OTel SDKs, which are technically compatible with Elastic’s ingestion APIs.
19+
Elastic Distributions for OpenTelemetry (EDOT) are built from contrib OTel components and are technically compatible with a broad set of community components. Users can also send data to Elastic using other contrib OTel components or distributions like the contrib Collector and OTel SDKs, which are technically compatible with Elastic’s ingestion APIs.
2020

2121
*Supported through Elastic* refers to components and configurations that Elastic has explicitly tested, validated, and committed to maintaining under our [Support Policies](https://www.elastic.co/support). This includes regular updates, issue triaging, and guidance from Elastic’s support and engineering teams. Components outside of this supported set may still work, but Elastic does not provide guaranteed support or troubleshooting assistance for them.
2222

@@ -35,15 +35,15 @@ The EDOT Collector includes two types of components with different compatibility
3535

3636
### Core components
3737

38-
Core components are used by default in Elastics onboarding flows and are essential for common use cases. They are fully supported under your Service Level Agreement (SLA).
38+
Core components are used by default in Elastic's onboarding flows and are essential for common use cases. They are fully supported under your Service Level Agreement (SLA).
3939

4040
### Extended components
4141

42-
Extended components are a curated set of optional components that enhance functionality and are technically compatible. These are not part of Elastics core product journeys and are not covered by SLAs. Youre free to use them, but Elastic provides limited support.
42+
Extended components are a curated set of optional components that enhance functionality and are technically compatible. These are not part of Elastic's core product journeys and are not covered by SLAs. You're free to use them, but Elastic provides limited support.
4343

4444
### Breaking changes
4545

46-
Because the EDOT Collector is built on upstream OpenTelemetry, breaking upstream changes might impact both Extended and Core components. For example, breaking changes in semantic conventions or configuration options. Elastic highlights and manages these through docs and support channels.
46+
Because the EDOT Collector is built on contrib OpenTelemetry, breaking contrib changes might impact both Extended and Core components. For example, breaking changes in semantic conventions or configuration options. Elastic highlights and manages these through docs and support channels.
4747

4848
:::{tip}
4949
For the best support experience, rely on Core components and use Extended Components only when required.

docs/reference/edot-collector/config/authentication-methods.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The `apikeyauth` extension is an Elastic-specific authentication method that val
3333

3434
### Bearer Token Authentication (`bearertokenauth`)
3535

36-
The `bearertokenauth` extension is an upstream OpenTelemetry authentication method that supports static bearer tokens. This extension is useful for token-based authentication scenarios.
36+
The `bearertokenauth` extension is an contrib OpenTelemetry authentication method that supports static bearer tokens. This extension is useful for token-based authentication scenarios.
3737

3838
## Configuration examples
3939

docs/reference/edot-collector/config/configure-metrics-collection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ hostmetrics:
106106
107107
You must grant access to the `/proc` filesystem to the receiver by running the Collector with privileged access and mounting /proc and /sys appropriately. Refer to the hostmetrics container use [guide](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/hostmetricsreceiver#collecting-host-metrics-from-inside-a-container-linux-only) (Linux only).
108108

109-
Turning on the process scraper might significantly increase the volume of scraped metrics, potentially impacting performance. Refer to the upstream issue [#39423](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/39423) for discussion.
109+
Turning on the process scraper might significantly increase the volume of scraped metrics, potentially impacting performance. Refer to the contrib issue [#39423](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/39423) for discussion.
110110

111111
To ensure compatibility with {{kib}}'s Infrastructure dashboards, include the [elasticinframetrics processor](https://github.com/elastic/opentelemetry-collector-components/tree/main/processor/elasticinframetricsprocessor) in your pipeline:
112112

docs/reference/edot-collector/config/default-config-standalone.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The following sample config files for Agent mode are available:
3232
| Platform logs and host metrics | [Logs &#124; Metrics - ES] | [Logs &#124; Metrics - OTLP] |
3333
| Platform logs, host metrics, <br> and application telemetry | [Logs &#124; Metrics &#124; App - ES]<br>(*default*) | [Logs &#124; Metrics &#124; App - OTLP]<br>(*default*) |
3434

35-
Use the previous example configurations as a reference when configuring your upstream Collector or customizing your EDOT Collector configuration.
35+
Use the previous example configurations as a reference when configuring your contrib Collector or customizing your EDOT Collector configuration.
3636

3737
The following sections describe the default pipelines by use cases.
3838

@@ -51,7 +51,7 @@ The goal of EDOT is to preserve OTel data formats and semantics as much as possi
5151

5252
#### Logs collection pipeline
5353

54-
For logs collection, the default configuration uses the [`filelog`] receiver to read log entries from files. In addition, the [`resourcedetection`] processor enriches the log entries with metadata about the corresponding host and operating system.
54+
For logs collection, the default configuration uses the [`filelog`] receiver to read log entries from files. In addition, the [`resourcedetection`] processor enriches the log entries with metadata about the corresponding host and operating system.
5555

5656
:::{note}
5757
The `from_context: client_metadata` option in the `resource` processor only applies to transport-level metadata. It cannot extract custom application attributes.

docs/reference/edot-collector/config/proxy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,4 +85,4 @@ If you're using an SDK that doesn't support proxy variables directly, consider r
8585

8686
## Resources
8787

88-
[Proxy support - upstream documentation](https://opentelemetry.io/docs/collector/configuration/#proxy-support)
88+
[Proxy support - contrib documentation](https://opentelemetry.io/docs/collector/configuration/#proxy-support)

0 commit comments

Comments
 (0)