Skip to content

Commit

Permalink
Merge branch 'main' into update-accountingservice
Browse files Browse the repository at this point in the history
  • Loading branch information
cartermp authored Jun 22, 2024
2 parents c7d14ee + 8494656 commit e0cd049
Show file tree
Hide file tree
Showing 267 changed files with 551 additions and 283 deletions.
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,12 @@ content/en/docs/languages/rust/ @open-telemetry/docs-approvers @open-te
content/en/docs/languages/swift/ @open-telemetry/docs-approvers @open-telemetry/swift-approvers
content/en/docs/security/ @open-telemetry/docs-approvers @open-telemetry/sig-security-maintainers
content/en/docs/specs/ @open-telemetry/docs-approvers @open-telemetry/specs-approvers
content/en/docs/zero-code/go @open-telemetry/docs-approvers @open-telemetry/go-approvers @open-telemetry/go-instrumentation-approvers
content/en/docs/zero-code/java/ @open-telemetry/docs-approvers @open-telemetry/java-approvers @open-telemetry/java-instrumentation-approvers
content/en/docs/zero-code/js/ @open-telemetry/docs-approvers @open-telemetry/javascript-approvers
content/en/docs/zero-code/net/ @open-telemetry/docs-approvers @open-telemetry/dotnet-approvers @open-telemetry/dotnet-instrumentation-approvers
content/en/docs/zero-code/python/ @open-telemetry/docs-approvers @open-telemetry/python-approvers
content/en/docs/zero-code/php/ @open-telemetry/docs-approvers @open-telemetry/php-approvers
content/en/ecosystem/demo/ @open-telemetry/demo-approvers @open-telemetry/demo-approvers
content/zh/ @open-telemetry/docs-maintainers @open-telemetry/docs-zh-approvers
content/ja/ @open-telemetry/docs-maintainers @open-telemetry/docs-ja-approvers
Expand Down
1 change: 1 addition & 0 deletions .github/component-label-map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ sig:go:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/go/**
- content/en/docs/zero-code/go/**
sig:java:
- changed-files:
- any-glob-to-any-file:
Expand Down
4 changes: 2 additions & 2 deletions .textlintrc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ filters:
enablingComment: prettier-ignore-end
allowlist:
allow:
# Don't check registry .yml file fields for language, repo and tags:
- '/^\s*(?:language|repo|name|docs): .*$/m'
# Don't check registry .yml file fields for language, repo, url and tags:
- '/^\s*(?:language|repo|name|docs|url): .*$/m'
- /^(?:tags):(\s*-.+$)*/m
# Hugo template syntax:
- /{{.*?}}/
Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/2022/debug-otel-with-otel/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,4 +261,4 @@ COPY opentelemetry_module.conf /etc/nginx/conf.d
https://github.com/open-telemetry/opentelemetry-cpp-contrib/releases/tag/webserver%2Fv1.0.1
[java]:
/docs/zero-code/java/agent/configuration/#capturing-http-request-and-response-headers
[python]: /docs/languages/python/automatic/
[python]: /docs/zero-code/python/
2 changes: 1 addition & 1 deletion content/en/blog/2023/end-user-discussions-03.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ agent to the host metrics receiver for infrastructure monitoring.
maturing in OTel; for example, the Java JAR agent takes care of instrumenting
[most libraries](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/supported-libraries.md#libraries--frameworks)
that are used by applications. Auto-instrumentation is also available for
[Python](/docs/languages/python/automatic/), [.NET](/docs/zero-code/net/), and
[Python](/docs/zero-code/python/), [.NET](/docs/zero-code/net/), and
[Node.js](/docs/zero-code/js/).
- If you’re using Kubernetes, they can use the
[OTel operator](https://github.com/open-telemetry/opentelemetry-operator),
Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/2023/end-user-q-and-a-01.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ They are hoping to leverage
[OpenTelemetry’s Exemplars](/docs/specs/otel/metrics/data-model/#exemplars) to
link traces and metrics.

### How is the organization sending telemetry data to various observability back-ends?
### How is the organization sending telemetry data to various observability backends?

J’s team uses a combination of the proprietary backend agent and the
OpenTelemetry Collector (for metrics). They are one of the primary users of
Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/2023/php-auto-instrumentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ We have all necessary components in place:
and frameworks.
- Development tools that can help lower barrier for users and developers
interested in instrumenting arbitrary code.
- [Documentation](/docs/languages/php/automatic/)
- [Documentation](/docs/zero-code/php/)

One of our goals is to increase awareness of this work and involve more people
that will help us improve it, extend coverage and fix bugs.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
101 changes: 101 additions & 0 deletions content/en/blog/2024/otel-get-started-survey/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
title: Insights from the OpenTelemetry Getting Started Survey
linkTitle: OpenTelemetry Getting Started Survey
date: 2024-06-19
author: '[Ana Margarita Medina](https://github.com/AnaMMedina21) (ServiceNow)'
issue: 4662
sig: End User SIG
---

Getting started with new technologies can be hard, which is why we try to meet
our end-users where they are. As a part of that goal,
[the OpenTelemetry End-User SIG](/community/end-user/) recently surveyed the
community to find out how we can best help our users get started with
OpenTelemetry. The 104 responses we received will help drive improvements in
enablement content from the community as well as vendors.

Check out the results!

## Key takeaways

- No matter their level of OTel experience, folks would like to see the
following:
1. Comprehensive documentation (67.3% of respondents).
2. Reference implementations for instrumentation (65.3% of respondents).
3. Detailed tutorials (63.4% of respondents).
- Respondents are mostly working with containerization technologies, with 79.8%
of respondents using Kubernetes and 63.5% of respondents using Docker.
- Over 83% of respondents stated that the Traces Specification, Instrumentation
APIs and SDKs, and Metrics Specification are the most important aspects of
their OTel journey.

## Detailed insights

### Q: What technologies are you using when setting up your observability journey?

Out of 104 respondents, most are working with containers: 79.8% are using
Kubernetes and 63.5% are using Docker.

![Chart showing what technologies are being used](1-technologies-used.png)

### Q: Where in your observability journey is your organization?

Out of 104 respondents:

- 25% are beginners and they are learning about observability or have used
monitoring tools.
- 49% are intermediates and are setting up observability practice.
- 26% are experts and have a well-established observability practice.

![Chart showing where in their observability journey they are](2-level.png)

### Q: What languages are you using in your organization?

[JavaScript](/docs/languages/js/), [Java](/docs/languages/java/),
[Go](/docs/languages/go/), and [Python](/docs/languages/python/) are the most
widely used languages. They are being utilized by over 50% of the respondents.

[Other languages](/docs/languages/other/) used included Scala, TypeScript,
[Erlang/Elixir](/docs/languages/erlang/), Perl, R, Lua, Matlab, Julia, Haskell,
COBOL, Kotlin, and SAS.

![Chart showing what languages are being used](3-languages.png)

### Q: What resources do you wish you had when getting started with OpenTelemetry?

Depending on where in their observability journey they are, respondents prefer
different resources:

- Those who are learning about observability and those who are setting up an
observability practice would like to see comprehensive documentation and
detailed tutorials and videos.
- Those who have a well-established observability practice prefer reference
implementations for instrumentation as well as comprehensive documentation.

![Chart showing what resources folks want](4-resources.png)

### Q: What part of the project is most important to you in your OTel journey?

Most respondents stated that
[Traces Specification,](/docs/specs/otel/trace/api/)
[Instrumentation APIs and SDKs](/docs/languages/), and
[Metrics Specification](/docs/specs/otel/metrics/api/) are most important to
them.

![Chart showing what aspects are the most important](5-importance.png)

## Learn more

For a more detailed look at the survey results, you can check out the
[results](https://github.com/open-telemetry/sig-end-user/tree/main/end-user-surveys/getting-started).

## Keep in touch

Thanks to everyone who participated in the survey! We rely on your feedback to
help guide the future development of OpenTelemetry and to ensure it continues to
meet your evolving needs. We will post upcoming surveys in the following
avenues:

- [#otel-sig-end-user Slack channel](https://cloud-native.slack.com/archives/C01RT3MSWGZ)
– you can also reach out to us here!
- [End user resources page](/community/end-user/).
2 changes: 1 addition & 1 deletion content/en/docs/collector/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Collector
description: Vendor-agnostic way to receive, process and export telemetry data.
aliases: [collector/about]
cascade:
vers: 0.102.1
vers: 0.103.0
weight: 270
---

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/collector/management.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ We will set up a simple OpAMP control plane consisting of an example OpAMP
server and let an OpenTelemetry Collector connect to it via an example OpAMP
supervisor.

First, clone the `open-telemetry/opamp-go` repo:
First, clone the `open-telemetry/opamp-go` repository:

```sh
git clone https://github.com/open-telemetry/opamp-go.git
Expand Down Expand Up @@ -159,7 +159,7 @@ service:
```
Now it's time to launch the supervisor (which in turn will launch your
OpenTelemetry collector):
OpenTelemetry Collector):
```console
$ go run .
Expand Down
5 changes: 3 additions & 2 deletions content/en/docs/concepts/instrumentation/zero-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ Other configuration options are available, including:
Automatic instrumentation is available for the following languages:

- [.NET](/docs/zero-code/net/)
- [Go](/docs/zero-code/go)
- [Java](/docs/zero-code/java/)
- [JavaScript](/docs/zero-code/js/)
- [PHP](/docs/languages/php/automatic/)
- [Python](/docs/languages/python/automatic/)
- [PHP](/docs/zero-code/php/)
- [Python](/docs/zero-code/python/)
2 changes: 1 addition & 1 deletion content/en/docs/demo/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ solve them.
We'll be adding more scenarios over time.

- Generate a [Product Catalog error](feature-flags) for `GetProduct` requests
with product id: `OLJCESPC7Z` using the Feature Flag service
with product ID: `OLJCESPC7Z` using the Feature Flag service
- Discover a memory leak and diagnose it using metrics and traces.
[Read more](scenarios/recommendation-cache/)

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/demo/feature-flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ change the `defaultVariant` value in the config file for a given flag to "on".
| `adServiceManualGc` | Ad Service | Trigger full manual garbage collections in the ad service |
| `adServiceHighCpu` | Ad Service | Trigger high cpu load in the ad service. If you want to demo cpu throttling, set cpu resource limits |
| `cartServiceFailure` | Cart Service | Generate an error for `EmptyCart` 1/10th of the time |
| `productCatalogFailure` | Product Catalog | Generate an error for `GetProduct` requests with product id: `OLJCESPC7Z` |
| `productCatalogFailure` | Product Catalog | Generate an error for `GetProduct` requests with product ID: `OLJCESPC7Z` |
| `recommendationServiceCacheFailure` | Recommendation | Create a memory leak due to an exponentially growing cache. 1.4x growth, 50% of requests trigger growth. |
| `paymentServiceFailure` | Payment Service | Generate an error when calling the `charge` method. |
| `paymentServiceUnreachable` | Checkout Service | Use a bad address when calling the PaymentService to make it seem like the PaymentService is unavailable. |
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/kubernetes/operator/automatic.md
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@ spec:

#### Learn more {#python-learn-more}

[See the Python agent Configuration docs for more details.](/docs/languages/python/automatic/configuration/#disabling-specific-instrumentations)
[See the Python agent Configuration docs for more details.](/docs/zero-code/python/configuration/#disabling-specific-instrumentations)

### Go

Expand Down
3 changes: 0 additions & 3 deletions content/en/docs/languages/go/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,6 @@ To send trace data to an OTLP endpoint (like the [collector](/docs/collector) or
Jaeger >= v1.35.0) you'll want to configure an OTLP exporter that sends to your
endpoint.

To learn more on how to use the OTLP HTTP exporter, try the
[otel-collector example](https://github.com/open-telemetry/opentelemetry-go/tree/main/example/otel-collector)

### OTLP traces over HTTP

[`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp)
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/js/serverless.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ If you are interested in a plug and play user experience, see

### Dependencies

First, create an empty package.json:
First, create an empty `package.json`:

```sh
npm init -y
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/languages/php/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ cSpell:ignore: fastcgi pecl

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

If you use [automatic instrumentation](/docs/languages/php/automatic/) you can
setup exporters with
[zero-code configuration to setup exporters](/docs/languages/php/automatic/#zero-code-configuration-for-automatic-instrumentation).
If you use [zero-code instrumentation](/docs/zero-code/php/) you can set up
exporters with
[zero-code configuration to setup exporters](/docs/zero-code/php#zero-code-configuration-for-automatic-instrumentation).

{{% /alert %}}

Expand Down
15 changes: 8 additions & 7 deletions content/en/docs/languages/php/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ OpenTelemetry for PHP can be used to generate and export [traces][], [metrics][]
and [logs][].

This page will show you how to get started with OpenTelemetry in PHP. We will
create a simple "roll the dice" application, then apply both automatic and
manual instrumentation to generate [traces][] and export them to the console. We
create a simple "roll the dice" application, then apply both zero-code and code
based instrumentation to generate [traces][] and export them to the console. We
will then emit some [logs][] which will also be sent to the console.

## Prerequisites

OpenTelemetry requires PHP 8.0+ for automatic instrumentation, however manual
OpenTelemetry requires PHP 8.0+ for zero-code instrumentation, however manual
instrumentation will work with PHP 7.4

Ensure that you have the following installed:
Expand Down Expand Up @@ -86,10 +86,10 @@ php -S localhost:8080
Open <http://localhost:8080/rolldice> in your web browser to ensure it is
working.

## Add automatic instrumentation
## Add zero-code instrumentation

Next, you’ll use the OpenTelemetry PHP extension to
[automatically instrument](../automatic/) the application.
[automatically instrument](/docs/zero-code/php/) the application.

1. Since the extension is built from source, you need to install some build
tools
Expand All @@ -116,7 +116,8 @@ Next, you’ll use the OpenTelemetry PHP extension to

{{% alert title="Note" color="warning" %}}Alternative methods of installing
the extension are detailed in
[automatic instrumentation](../automatic/#installation). {{% /alert %}}
[zero-code instrumentation](/docs/zero-code/php/#installation).
{{% /alert %}}

3. Add the extension to your `php.ini` file:

Expand Down Expand Up @@ -487,7 +488,7 @@ values correspond to the active span at the time the log message was generated.
For more:

- Run this example with another [exporter][] for telemetry data.
- Try [automatic instrumentation](../automatic/) on one of your own apps.
- Try [zero-code instrumentation](/docs/zero-code/php/) on one of your own apps.
- Learn more about [manual instrumentation][] and try out some [examples](/docs/languages/php/examples/).
- Take a look at the [OpenTelemetry Demo](/docs/demo/), which includes the PHP
based [Quote Service](/docs/demo/services/quote/).
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/php/instrumentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -690,7 +690,7 @@ See [Exporters](/docs/languages/php/exporters)
OpenTelemetry can be used to measure and record different types of metrics from
an application, which can then be
[pushed](/docs/specs/otel/metrics/sdk/#push-metric-exporter) to a metrics
service such as the OpenTelemetry collector:
service such as the OpenTelemetry Collector:

- counter
- async counter
Expand Down
6 changes: 1 addition & 5 deletions content/en/docs/languages/php/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ You can turn off any instrumentation by adding its identifier to the
## Available instrumentation libraries

For a list of available instrumentations, see
[OpenTelemetry instrumentation packages](https://packagist.org/search/?query=open-telemetry&tags=instrumentation)
[OpenTelemetry instrumentation libraries](https://packagist.org/search/?query=open-telemetry&tags=instrumentation)
on Packagist.

## Next steps
Expand All @@ -49,7 +49,3 @@ custom telemetry data.
You might also want to configure an appropriate exporter to
[export your telemetry data](/docs/languages/php/exporters) to one or more
telemetry backends.

You can also check the
[automatic instrumentation for PHP](/docs/languages/php/automatic) for existing
library instrumentations.
4 changes: 2 additions & 2 deletions content/en/docs/languages/python/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ pip install -e ./opentelemetry-sdk

## Repositories and benchmarks

- Main repo: [opentelemetry-python][]
- Contrib repo: [opentelemetry-python-contrib][]
- Main repository: [opentelemetry-python][]
- Contrib repository: [opentelemetry-python-contrib][]

[opentelemetry-python]: https://github.com/open-telemetry/opentelemetry-python
[opentelemetry-python-contrib]:
Expand Down
8 changes: 4 additions & 4 deletions content/en/docs/languages/python/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ flask run -p 8080

## Instrumentation

Automatic instrumentation will generate telemetry data on your behalf. There are
Zero-code instrumentation will generate telemetry data on your behalf. There are
several options you can take, covered in more detail in
[Automatic Instrumentation](../automatic/). Here we'll use the
[Zero-code Instrumentation](/docs/zero-code/python/). Here we'll use the
`opentelemetry-instrument` agent.

Install the `opentelemetry-distro` package, which contains the OpenTelemetry
Expand Down Expand Up @@ -814,8 +814,8 @@ Value: 1
## Next steps

There are several options available for automatic instrumentation and Python.
See [Automatic Instrumentation](../automatic/) to learn about them and how to
configure them.
See [Zero-code Instrumentation](/docs/zero-code/python/) to learn about them and
how to configure them.

There's a lot more to manual instrumentation than just creating a child span. To
learn details about initializing manual instrumentation and many more parts of
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 @@ -104,7 +104,7 @@ You might also want to configure an appropriate exporter to
telemetry backends.

You can also check the
[automatic instrumentation for Python](/docs/languages/python/automatic).
[Zero-code instrumentation for Python](/docs/zero-code/python/).

[opentelemetry-python-contrib]:
https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation#readme
2 changes: 1 addition & 1 deletion content/en/docs/languages/ruby/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ end
```

If you now run your application, set the environment variable
`OTEL_TRACES_EXPORTER` to zipkin:
`OTEL_TRACES_EXPORTER` to Zipkin:

```sh
env OTEL_TRACES_EXPORTER=zipkin rails server
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/ruby/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ For more elaborate examples, see [examples](/docs/languages/ruby/examples/).

### Dependencies

To begin, install rails:
To begin, install Rails:

```sh
gem install rails
Expand Down
Loading

0 comments on commit e0cd049

Please sign in to comment.