Skip to content

Commit

Permalink
Merge branch 'main' into feature/issue-5913-move-new-observability-pr…
Browse files Browse the repository at this point in the history
…imer-page
  • Loading branch information
iguitton authored Jan 17, 2025
2 parents 1879c72 + 3fd0bb5 commit 552919a
Show file tree
Hide file tree
Showing 42 changed files with 3,552 additions and 819 deletions.
1 change: 1 addition & 0 deletions .cspell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,5 @@ dictionaries:
# Other
- companies
words: # Valid words across all locales
- Docsy
- htmltest
36 changes: 15 additions & 21 deletions .htmltest.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
CacheExpires: 9000h # ~ 12 months
CacheExpires: 13300h # ~ 18 months
DirectoryPath: public
IgnoreDirectoryMissingTrailingSlash: true
IgnoreAltMissing: true
Expand All @@ -15,6 +15,11 @@ IgnoreDirs:
# TODO drop next lines after https://github.com/open-telemetry/opentelemetry.io/issues/5555 is fixed for these pages:
- ^zh/docs/concepts/signals/baggage/
- ^zh/docs/zero-code/php/
# TODO drop the following config once this page is updated to reflect the corresponding `en`
# page and the link 404 (detailed below) are resolved:
# zh/docs/contributing/index.html
# Non-OK status: 404 --> https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md
- ^zh/docs/contributing/
# DO NOT EDIT! IgnoreDirs list is auto-generated from markdown file front matter.
IgnoreInternalURLs: # list of paths
IgnoreURLs: # list of regexs of paths or URLs to be ignored
Expand Down Expand Up @@ -56,35 +61,24 @@ IgnoreURLs: # list of regexs of paths or URLs to be ignored
# YouTube playlists sometimes give a 404, although they give a 200 when accessed via browser:
- ^https://www.youtube.com/playlist\?list=

# Ignore Docsy-generated GitHub links for now
- ^https?://github\.com/.*?/.*?/(new|edit)/ # view-page, edit-source etc
# TODO: drop after fix to https://github.com/google/docsy/issues/1432
- ^https://github.com/open-telemetry/opentelemetry.io/commit/ # last mod
# Ignore Docsy-generated GitHub links for now, until
# https://github.com/google/docsy/issues/1432 is fixed
- ^https?://github\.com/.*?/.*?/(new|edit|issues/new\?title)/ # view-page, edit-source etc
- ^https?://github\.com/open-telemetry/opentelemetry.io/tree/

# Ignore links to GH repo content for now.
- ^https?://github\.com/.*?/.*?/(blob|tree)/
# Ignore some links to GH repo content for now, most 4XX
- ^https?://github\.com/open-telemetry/(opentelemetry-collector-contrib|opentelemetry-collector|opentelemetry-dotnet-instrumentation|opentelemetry-helm-charts|opentelemetry-java-instrumentation|opentelemetry-java|opentelemetry-operator|opentelemetry-proto|opentelemetry-python-contrib|opentelemetry-specification|oteps|semantic-conventions|sig-end-user)/
- ^https?://github\.com/open-telemetry/opentelemetry-demo/blob/main/src/(imageprovider|loadgenerator|otelcollector|.*service)
# TODO drop the following after https://github.com/open-telemetry/semantic-conventions/pull/1753 is merged and the submodule updated:
- ^https?://github\.com/in-toto/

# Too many redirects as the server tries to figure out the country and language,
# e.g.: https://www.microsoft.com/en-ca/sql-server.
- ^https://www.microsoft.com/sql-server$

# TODO: drop after fix to https://github.com/rust-lang/crates.io/issues/788
- ^https://crates\.io/crates
# TODO: drop after fix to https://github.com/micrometer-metrics/micrometer-docs/issues/239
- ^https://micrometer\.io/docs
# TODO: ensure .json isn't set as an alternate in ecosystem/registry/index.html and then drop:
- ^https://opentelemetry.io/ecosystem/registry/index.json
# TODO: drop after fix to https://github.com/open-telemetry/semantic-conventions/pull/645 lands in this repo
- ^http://docs.couchdb.org/en/stable/api/document/common.html#get--db-docid
# TODO drop after fix to https://github.com/open-telemetry/opentelemetry.io/issues/3818
- ^https://oncallmemaybe.com
# TODO drop after https://github.com/open-telemetry/opentelemetry-specification/pull/3834 is merged
- ^https://wikipedia\.org/wiki/Monotonic_function
# TODO drop after https://github.com/open-telemetry/opamp-spec/pull/179 is merged into this repo
- ^http://www.watersprings.org/
# TODO move into content/en/blog/2023/humans-of-otel.md once https://github.com/open-telemetry/opentelemetry.io/issues/3889 is implemented
- ^https://shorturl.at/osHRX$
# TODO drop after https://github.com/open-telemetry/semantic-conventions/pull/678 is merged:
- ^https://wikipedia.org/wiki/(S.M.A.R.T|Hop_)
# TODO move into content/en/blog/2023/contributing-to-otel/index.md once https://github.com/open-telemetry/opentelemetry.io/issues/3889 is implemented
- ^https://shorturl.at/vLYZ0$
4 changes: 2 additions & 2 deletions content/en/blog/2024/otel-operator-q-and-a/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,9 +225,9 @@ install the Prometheus Operator just to use these two CRs with the Target
Allocator.

The easiest way to install the
[`PodMonitor`](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.PodMonitor)
[`PodMonitor`](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.PodMonitor)
and
[`ServiceMonitor`](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.ServiceMonitor)
[`ServiceMonitor`](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.ServiceMonitor)
CRs is to grab a copy of the individual
[PodMonitor YAML](https://github.com/prometheus-community/helm-charts/blob/main/charts/kube-prometheus-stack/charts/crds/crds/crd-podmonitors.yaml)
and
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/demo/services/accounting.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ aliases: [accountingservice]
This service calculates the total amount of sold products. This is only mocked
and received orders are printed out.

[Accounting Service](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/accountingservice/)
[Accounting Service](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/accounting/)

## Auto-instrumentation

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/demo/services/ad.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ aliases: [adservice]
This service determines appropriate ads to serve to users based on context keys.
The ads will be for products available in the store.

[Ad service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/adservice/)
[Ad service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/ad/)

## Auto-instrumentation

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/demo/services/checkout.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ cSpell:ignore: fatalf otelgrpc otelsarama otlpmetricgrpc otlptracegrpc sarama sd
This service is responsible to process a checkout order from the user. The
checkout service will call many other services in order to process an order.

[Checkout service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/checkoutservice/)
[Checkout service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/checkout/)

## Traces

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/demo/services/currency.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ cSpell:ignore: chrono decltype labelkv millis noexcept nostd
This service provides functionality to convert amounts between different
currencies.

[Currency service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/currencyservice/)
[Currency service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/currency/)

## Traces

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/demo/services/email.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ cSpell:ignore: sinatra

This service will send a confirmation email to the user when an order is placed.

[Email service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/emailservice/)
[Email service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/email/)

## Initializing Tracing

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/demo/services/payment.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This service is responsible to process credit card payments for orders. It will
return an error if the credit card is invalid or the payment can not be
processed.

[Payment service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/paymentservice/)
[Payment service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/payment/)

## Initializing OpenTelemetry

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/demo/services/product-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This service is responsible to return information about products. The service
can be used to get all products, search for specific products, or return details
about any single product.

[Product Catalog service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/productcatalogservice/)
[Product Catalog service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/product-catalog/)

## Traces

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/demo/services/quote.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ managing the Dependency Injection.

The PHP instrumentation may vary when using a different framework.

[Quote service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/quoteservice/)
[Quote service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/quote/)

## Traces

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/demo/services/shipping.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The `build.rs` supports development outside docker, given a Rust installation.
Otherwise, consider building with `docker compose` to edit / assess changes as
needed.

[Shipping service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/shippingservice/)
[Shipping service source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/shipping/)

## Traces

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/java/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ Properties for configuring [resource](../sdk/#resource):
| --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- |
| `otel.service.name` | Specify logical service name. Takes precedence over `service.name` defined with `otel.resource.attributes`. | `unknown_service:java` |
| `otel.resource.attributes` | Specify resource attributes in the following format: `key1=val1,key2=val2,key3=val3`. | |
| `otel.resource.disabled-keys` | Specify resource attribute keys to filter. | |
| `otel.resource.disabled.keys` | Specify resource attribute keys to filter. | |
| `otel.java.enabled.resource.providers` | Comma-separated list of `ResourceProvider` fully qualified class names to enable. **[1]** If unset, all resource providers are enabled. | |
| `otel.java.disabled.resource.providers` | Comma-separated list of `ResourceProvider` fully qualified class names to disable. **[1]** | |

Expand Down
17 changes: 11 additions & 6 deletions content/en/ecosystem/adopters.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,32 @@ OpenTelemetry's mission is to enable effective observability for all its
end-users. If you are thinking about adopting OpenTelemetry for your
organization, you may be curious about other adoption journeys. The table below
is a non-exhaustive list of
[_end-user_ organizations](https://community.cncf.io/end-user-community/) that
have adopted OpenTelemetry for
[Observability](/docs/concepts/observability-primer/).
[_end-user_ organizations](https://www.cncf.io/enduser/) that have adopted
OpenTelemetry for [Observability](/docs/concepts/observability-primer/).

{{% ecosystem/adopters-table %}}

## Adding your organization as an adopter {#how-to-add}

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

- Link to a blog post or other resource that describes how your organization
makes use of OpenTelemetry
- GitHub handle or email address as a point of contact so that we can reach out
in case we have questions

Note that this list is for
[_end-user_ organizations](https://community.cncf.io/) that do not provide any
[_end-user_ organizations](https://www.cncf.io/enduser/) that do not provide any
OpenTelemetry-related services.

If your organization provides a **library** or **service** made observable
through OpenTelemetry, see [Integrations](/ecosystem/integrations/).

If your organization provides a solution that consumes OpenTelemetry to offer
**Observability to end users**, see [Vendors](/ecosystem/vendors).

{{% ecosystem/keep-up-to-date adopter %}}

[adopters list]:
https://github.com/open-telemetry/opentelemetry.io/tree/main/data/ecosystem/adopters.yaml
10 changes: 7 additions & 3 deletions content/en/ecosystem/distributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,10 @@ is provided as a convenience for the community. {{% /alert %}}

{{% ecosystem/distributions-table %}}

## How to add your distribution {#how-to-add}
## Adding 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 should include the following:
[distributions list]. The entry should include the following:

- Link to the main page of your distribution
- Link to the documentation that explains how to use the distribution
Expand All @@ -48,3 +47,8 @@ The entry should include the following:
{{% /alert %}}

[submit a PR]: /docs/contributing/pull-requests/

{{% ecosystem/keep-up-to-date distribution %}}

[distributions list]:
https://github.com/open-telemetry/opentelemetry.io/tree/main/data/ecosystem/distributions.yaml
4 changes: 3 additions & 1 deletion content/en/ecosystem/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ have a CNCF logo beside their name.

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

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

To have your library, service, or app listed, [submit a PR] with an entry added
to the [registry](/ecosystem/registry/adding). The entry should include the
Expand All @@ -67,3 +67,5 @@ end users, see [Vendors](/ecosystem/vendors).
{{% /alert %}}

[submit a PR]: /docs/contributing/pull-requests/

{{% ecosystem/keep-up-to-date integration %}}
21 changes: 21 additions & 0 deletions content/en/ecosystem/registry/updating.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Keeping registry and list information current
linkTitle: Updating
---

We periodically review [registry](..) entry and [list data], such as external
links, to ensure that only [adopters](../../adopters/),
[distributions](../../distributions/),
[integrations, libraries](../../integrations/), and [vendors](../../vendors/)
actively supporting OpenTelemetry are included in the registry.

Entry authors are encouraged to maintain links to active and up-to-date
distributions, documentation, and libraries. We reserve the right to update or
remove entries for components that seem to no longer actively support
OpenTelemetry. This may happen, for example, when external links become invalid.
We will attempt to contact the GitHub user who submitted the original entry data
on a best effort basis, but otherwise reserve the right to edit and remove
entries and entry data.

[list data]:
https://github.com/open-telemetry/opentelemetry.io/tree/main/data/ecosystem
20 changes: 12 additions & 8 deletions content/en/ecosystem/vendors.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,10 @@ source product for their customers.

{{% ecosystem/vendor-table %}}

## Add your organization
## Adding your organization {#how-to-add}

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

- Link to the documentation that details how your offering consumes
OpenTelemetry natively via [OTLP](/docs/specs/otlp/).
Expand All @@ -34,13 +33,18 @@ The entry should include the following:
in case we have questions

Note that this list is for organizations that consume OpenTelemetry and offer
Observability to [end users](https://community.cncf.io/end-user-community/).
Observability to [end users](/community/end-user/).

If you adopt OpenTelemetry for Observability as an end-user organization, and
you do not provide any kind of services around OpenTelemetry, see
[Adopters](/ecosystem/adopters).
If you adopt OpenTelemetry for Observability as an
[end-user organization](https://www.cncf.io/enduser/), and you do not provide
any kind of services around OpenTelemetry, see [Adopters](/ecosystem/adopters/).

If you provide a library, service, or app that is made observable through
OpenTelemetry, see [Integrations](/ecosystem/integrations).
OpenTelemetry, see [Integrations](/ecosystem/integrations/).

[submit a PR]: /docs/contributing/pull-requests/

{{% ecosystem/keep-up-to-date vendor %}}

[vendors list]:
https://github.com/open-telemetry/opentelemetry.io/tree/main/data/ecosystem/vendors.yaml
7 changes: 7 additions & 0 deletions content/zh/docs/contributing/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
title: 贡献
description: 了解如何为 OpenTelemetry 文档做贡献。
weight: 980
htmltest:
IgnoreDirs:
# TODO drop the following config once this page is updated to reflect the corresponding `en`
# page and the link 404 (detailed below) are resolved:
# zh/docs/contributing/index.html
# Non-OK status: 404 --> https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md
- ^zh/docs/contributing/
default_lang_commit: 8603bc8
---

Expand Down
27 changes: 14 additions & 13 deletions data/community/members.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1031,6 +1031,15 @@ maintainers:
- sqlcommenter-maintainers
html_url: https://github.com/sjs994
avatar_url: https://avatars.githubusercontent.com/u/7661510?v=4
- name: songy23
teams:
- collector-approvers
- collector-contrib-approvers
- collector-contrib-maintainers
- collector-contrib-triagers
- collector-triagers
html_url: https://github.com/songy23
avatar_url: https://avatars.githubusercontent.com/u/10536136?v=4
- name: srikanthccv
teams:
- opamp-go-approvers
Expand Down Expand Up @@ -1597,11 +1606,6 @@ approvers:
- semconv-genai-approvers
html_url: https://github.com/nirga
avatar_url: https://avatars.githubusercontent.com/u/4224692?v=4
- name: nslaughter
teams:
- lambda-extension-approvers
html_url: https://github.com/nslaughter
avatar_url: https://avatars.githubusercontent.com/u/28688390?v=4
- name: Oberon00
teams:
- build-tools-approvers
Expand Down Expand Up @@ -1691,14 +1695,6 @@ approvers:
- ruby-contrib-approvers
html_url: https://github.com/simi
avatar_url: https://avatars.githubusercontent.com/u/193936?v=4
- name: songy23
teams:
- collector-approvers
- collector-contrib-approvers
- collector-contrib-triagers
- collector-triagers
html_url: https://github.com/songy23
avatar_url: https://avatars.githubusercontent.com/u/10536136?v=4
- name: sourabh1007
teams:
- semconv-db-approvers
Expand Down Expand Up @@ -1840,6 +1836,11 @@ triagers:
- collector-triagers
html_url: https://github.com/jade-guiton-dd
avatar_url: https://avatars.githubusercontent.com/u/179536679?v=4
- name: jamesmoessis
teams:
- collector-contrib-triagers
html_url: https://github.com/jamesmoessis
avatar_url: https://avatars.githubusercontent.com/u/33504860?v=4
- name: jodeev
teams:
- php-triagers
Expand Down
8 changes: 1 addition & 7 deletions data/ecosystem/vendors.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -120,12 +120,6 @@
contact:
oss: true
commercial: true
- name: F5
nativeOTLP: true
url: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/f5cloudexporter
contact:
oss: false
commercial: true
- name: Google Cloud Platform
nativeOTLP: true
url: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/googlecloudexporter
Expand Down Expand Up @@ -254,7 +248,7 @@
commercial: true
- name: Observe, Inc.
nativeOTLP: true
url: https://docs.observeinc.com/en/latest/content/integrations/otel/opentelemetry.html
url: https://docs.observeinc.com/en/latest/content/send-data/app-instrumentation/index.html#instrument-with-opentelemetry
contact:
oss: false
commercial: true
Expand Down
Loading

0 comments on commit 552919a

Please sign in to comment.