Skip to content

Commit

Permalink
Add distribution page and data inside Ecosystem (#3854)
Browse files Browse the repository at this point in the history
Co-authored-by: Severin Neumann <neumanns@cisco.com>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Co-authored-by: Phillip Carter <pcarter@fastmail.com>
  • Loading branch information
4 people committed Jan 31, 2024
1 parent ae36b80 commit e9b5253
Show file tree
Hide file tree
Showing 10 changed files with 255 additions and 60 deletions.
8 changes: 4 additions & 4 deletions content/en/docs/concepts/distributions.md
Expand Up @@ -48,10 +48,10 @@ Distributions would broadly fall into the following categories:
## Who would create a distribution?

Anyone could create a distribution. Today, several
[vendors](/ecosystem/vendors/) offer distributions. In addition, end-users may
consider creating a distribution if they wish to use components in the
[Registry](/ecosystem/registry/) that are not upstreamed to the OpenTelemetry
project.
[vendors](/ecosystem/vendors/) offer [distributions](/ecosystem/distributions/).
In addition, end-users can consider creating a distribution if they wish to use
components in the [Registry](/ecosystem/registry/) that are not upstreamed to
the OpenTelemetry project.

## Contribution or distribution?

Expand Down
48 changes: 48 additions & 0 deletions content/en/ecosystem/distributions.md
@@ -0,0 +1,48 @@
---
title: Distributions
description:
List of open source OpenTelemetry distributions maintained by third parties.
---

OpenTelemetry [distributions](/docs/concepts/distributions/) are a way of
customizing OpenTelemetry components so that they're easier to deploy and use
with specific observability backends.

Any third-party can customize OpenTelemetry components with backend, vendor, or
end-user specific changes. You don't have to use a distributions in order to use
OpenTelemetry components, though distributions might facilitate usage under
certain circumstances, such as specific vendor requirements.

The following list contains a sample of OpenTelemetry distributions and the
component they customize.

{{% alert title="Note" color="warning" %}} OpenTelemetry **does not validate or
endorse** the third-party distributions listed in the following table. The list
is provided as a convenience for the community. {{% /alert %}}

{{% ecosystem/distributions-table %}}

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

To have your distribution listed, submit a PR with an entry added to the
[distributions list](https://github.com/open-telemetry/opentelemetry.io/tree/main/data/ecosystem/distributions.yaml).
The entry must include the following:

- Link to the main page of your distribution
- Link to the documentation that explains how to use the distribution
- List the components your distribution contains
- GitHub handle or email address as a point of contact so that we can reach out
in case we have questions

{{% alert title="Notes" color="info" %}}

- If you provide external integration of OpenTelemetry for any kind of library,
service, or app, then consider
[adding it to the registry](/ecosystem/registry/adding).
- If you adopt OpenTelemetry for observability as an end user and do not provide
any kind of services around OpenTelemetry, see
[Adopters](/ecosystem/adopters).
- If you provide a solution that consumes OpenTelemetry to offer observability
to end users, see [Vendors](/ecosystem/vendors).

{{% /alert %}}
2 changes: 1 addition & 1 deletion content/en/ecosystem/vendors.md
Expand Up @@ -8,7 +8,7 @@ A non-exhaustive list of organizations offering solutions that consume
OpenTelemetry natively via [OTLP](/docs/specs/otlp/), such as observability
backends and observability pipelines.

Some organizations provide a [distribution](/docs/concepts/distributions/) (of
Some organizations provide a [distribution](/ecosystem/distributions/) (of
customized OpenTelemetry components), that provides additional capabilities or
for improved ease of use.

Expand Down
77 changes: 77 additions & 0 deletions data/ecosystem/distributions.yaml
@@ -0,0 +1,77 @@
# cSpell:ignore Splunk AWS ADOT Grafana observIQ BindPlane RHOSDT RedHat Sumo Liatrio Lumigo Distro
- name: Splunk Distribution of OpenTelemetry Collector
url: https://github.com/signalfx/splunk-otel-collector
docsUrl: https://docs.splunk.com/observability/en/gdi/opentelemetry/opentelemetry.html
components: [Collector]
- name: AWS Distro for OpenTelemetry (ADOT)
url: https://aws.amazon.com/otel/
docsUrl: https://aws-otel.github.io/docs/getting-started/collector
components: [Collector]
- name: Grafana Agent
url: https://github.com/grafana/agent
docsUrl: https://grafana.com/docs/agent/latest/
components: [Collector]
- name: observIQ BindPlane Agent
url: https://github.com/observIQ/observiq-otel-collector
docsUrl: https://github.com/observIQ/bindplane-agent/tree/main/docs
components: [Collector]
- name: RedHat RHOSDT OpenTelemetry Collector Distribution
url: https://github.com/os-observability/redhat-opentelemetry-collector
docsUrl: https://github.com/os-observability/redhat-opentelemetry-collector
components: [Collector]
- name: Sumo Logic Distribution for OpenTelemetry Collector
url: https://github.com/SumoLogic/sumologic-otel-collector
docsUrl: https://help.sumologic.com/docs/send-data/opentelemetry-collector/sumo-logic-opentelemetry-vs-opentelemetry-upstream-relationship/
components: [Collector]
- name: Liatrio Distribution of the OpenTelemetry Collector
url: https://github.com/liatrio/liatrio-otel-collector
docsUrl: https://github.com/liatrio/liatrio-otel-collector
components: [Collector]
- name: Lumigo OpenTelemetry Distribution for Java
url: https://github.com/lumigo-io/opentelemetry-java-distro
docsUrl: https://github.com/lumigo-io/opentelemetry-java-distro
components: [Java]
- name: Lumigo OpenTelemetry Distribution for Python
url: https://github.com/lumigo-io/opentelemetry-python-distro
docsUrl: https://github.com/lumigo-io/opentelemetry-python-distro
components: [Python]
- name: Lumigo OpenTelemetry Distribution for Node.js
url: https://github.com/lumigo-io/opentelemetry-js-distro
docsUrl: https://github.com/lumigo-io/opentelemetry-js-distro
components: [Node]
- name: Honeycomb OpenTelemetry Distribution for Node.js
url: https://github.com/honeycombio/honeycomb-opentelemetry-node
docsUrl: https://docs.honeycomb.io/getting-data-in/opentelemetry/node-distro/
components: [Node]
- name: Honeycomb OpenTelemetry Distribution for .NET
url: https://github.com/honeycombio/honeycomb-opentelemetry-dotnet
docsUrl: https://docs.honeycomb.io/getting-data-in/opentelemetry/dotnet-distro/
components: [.NET]
- name: Honeycomb OpenTelemetry Distribution for Java
url: https://github.com/honeycombio/honeycomb-opentelemetry-java
docsUrl: https://docs.honeycomb.io/getting-data-in/java/opentelemetry-distro/
components: [Java]
- name: Honeycomb OpenTelemetry Distribution for Go
url: https://github.com/honeycombio/honeycomb-opentelemetry-go
docsUrl: https://docs.honeycomb.io/getting-data-in/opentelemetry/go-distro/
components: [Go]
- name: Splunk Distribution of OpenTelemetry Java
url: https://github.com/signalfx/splunk-otel-java
docsUrl: https://docs.splunk.com/observability/en/gdi/get-data-in/application/java/get-started.html
components: [Java]
- name: Splunk Distribution of OpenTelemetry Node.js
url: https://github.com/signalfx/splunk-otel-js
docsUrl: https://docs.splunk.com/observability/en/gdi/get-data-in/application/nodejs/get-started.html
components: [Node]
- name: Splunk Distribution of OpenTelemetry .NET
url: https://github.com/signalfx/splunk-otel-dotnet
docsUrl: https://docs.splunk.com/observability/en/gdi/get-data-in/application/otel-dotnet/get-started.html
components: [.NET]
- name: Splunk Distribution of OpenTelemetry Python
url: https://github.com/signalfx/splunk-otel-python
docsUrl: https://docs.splunk.com/observability/en/gdi/get-data-in/application/python/get-started.html
components: [Python]
- name: Splunk Distribution of OpenTelemetry Go
url: https://github.com/signalfx/splunk-otel-go
docsUrl: https://docs.splunk.com/observability/en/gdi/get-data-in/application/go/get-started.html
components: [Go]
15 changes: 0 additions & 15 deletions data/registry/instrumentation-dotnet-honeycomb.yml

This file was deleted.

13 changes: 0 additions & 13 deletions data/registry/instrumentation-go-honeycomb.yml

This file was deleted.

13 changes: 0 additions & 13 deletions data/registry/instrumentation-java-honeycomb.yml

This file was deleted.

14 changes: 0 additions & 14 deletions data/registry/instrumentation-js-node-honeycomb.yml

This file was deleted.

9 changes: 9 additions & 0 deletions layouts/shortcodes/ecosystem/distributions-table.md
@@ -0,0 +1,9 @@
<!-- cSpell:ignore: cond -->
{{ $data := sort (sort $.Site.Data.ecosystem.distributions "components") "name" "asc" -}}
Name[^1] | Components | Learn more
------------ | ---------- | ----------
{{- range $data }}
[{{ .name }}]({{ .url }}) | {{ delimit (sort .components) ", " }} | [{{ replace .docsUrl "https://" "" }}]({{ .docsUrl }})
{{- end }}

[^1]: Listed alphabetically

0 comments on commit e9b5253

Please sign in to comment.