From db2ba27d6cc66044187504526223abe9b5958205 Mon Sep 17 00:00:00 2001 From: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com> Date: Sun, 2 Jun 2024 15:26:41 +0000 Subject: [PATCH] Results from /fix:format --- README.md | 12 +++--- .../index.md | 3 +- content/en/blog/2021/gc-election.md | 3 +- content/en/blog/2021/womens-day.md | 3 +- .../blog/2022/debug-otel-with-otel/index.md | 4 +- .../blog/2022/exponential-histograms/index.md | 39 +++++++++---------- .../instrument-apache-httpd-server/index.md | 13 +++---- content/en/blog/2022/k8s-metadata/index.md | 9 ++--- content/en/blog/2022/kubecon-na.md | 4 +- .../en/blog/2022/otel-demo-app-nomad/index.md | 4 +- .../blog/2023/contributing-to-otel/index.md | 6 +-- .../blog/2023/ecs-otel-semconv-convergence.md | 11 +++--- content/en/blog/2023/end-user-q-and-a-03.md | 13 ++++--- .../en/blog/2023/exponential-histograms.md | 20 +++++----- content/en/blog/2023/kubecon-eu.md | 21 +++++----- content/en/blog/2023/kubecon-na.md | 21 +++++----- content/en/blog/2023/logs-collection/index.md | 4 +- content/en/blog/2023/sunsetting-opencensus.md | 1 + .../java-metric-systems-compared/index.md | 11 ++---- content/en/blog/2024/kubecon-eu.md | 15 ++++--- content/en/blog/2024/profiling.md | 1 + content/en/docs/collector/distributions.md | 6 +-- content/en/docs/collector/installation.md | 12 +++--- .../en/docs/collector/internal-telemetry.md | 4 +- .../concepts/instrumentation/libraries.md | 8 ++-- content/en/docs/contributing/_index.md | 6 +-- content/en/docs/demo/forking.md | 4 +- .../docs/languages/erlang/instrumentation.md | 9 ++--- .../en/docs/languages/go/instrumentation.md | 8 ++-- content/en/docs/languages/java/exporters.md | 5 +-- .../en/docs/languages/java/getting-started.md | 14 +++---- .../en/docs/languages/java/instrumentation.md | 15 +++---- content/en/docs/languages/js/exporters.md | 9 ++--- content/en/docs/languages/js/resources.md | 8 ++-- .../en/docs/languages/net/getting-started.md | 3 +- content/en/docs/languages/net/resources.md | 4 +- .../en/docs/languages/php/getting-started.md | 3 +- .../en/docs/languages/ruby/getting-started.md | 12 +++--- content/en/docs/migration/_index.md | 6 +-- content/en/docs/zero-code/_index.md | 4 +- .../docs/zero-code/java/agent/annotations.md | 5 ++- .../zero-code/java/agent/configuration.md | 26 ++++++++----- .../en/docs/zero-code/net/getting-started.md | 12 +++--- content/en/ecosystem/registry/adding.md | 5 +-- .../docs/languages/exporters/intro.md | 4 +- .../docs/languages/exporters/outro.md | 3 +- 46 files changed, 201 insertions(+), 212 deletions(-) diff --git a/README.md b/README.md index 20e8a68d7ccd..cb27b13cb7c9 100644 --- a/README.md +++ b/README.md @@ -28,15 +28,15 @@ to the registry][]. ## Contributing We have curated some issues with the tags [help wanted][] and [good first -issue][]. This should allow you to quickly find a place to contribute. See -[CONTRIBUTING.md][] for more information. +issue][]. This should allow you to quickly find a place to contribute. See [CONTRIBUTING.md][] +for more information. We, the OTel Communications SIG, meet every two weeks on Monday at 10:00 PT. Check out the [OpenTelemetry community calendar][] for the Zoom link and any updates to this schedule. -Meeting notes are available as a public [Google doc][]. If you have trouble -accessing the doc, get in touch in the `#otel-comms` channel on [Slack][]. +Meeting notes are available as a public [Google doc][]. If you have trouble accessing +the doc, get in touch in the `#otel-comms` channel on [Slack][]. Here is a list of community roles with current and previous members: @@ -62,8 +62,8 @@ Here is a list of community roles with current and previous members: - [Morgan McLean](https://github.com/mtwo) - [jparsana](https://github.com/jparsana) -Learn more about roles in the [community repository][]. Thanks to [all who have -already contributed][contributors]! +Learn more about roles in the [community repository][]. Thanks to [all who have already +contributed][contributors]! ## Licenses diff --git a/content/en/blog/2019/opentelemetry-governance-committee-explained/index.md b/content/en/blog/2019/opentelemetry-governance-committee-explained/index.md index c32b2e24fb2f..0d57e712b82d 100644 --- a/content/en/blog/2019/opentelemetry-governance-committee-explained/index.md +++ b/content/en/blog/2019/opentelemetry-governance-committee-explained/index.md @@ -74,7 +74,6 @@ your questions! Thanks [Sarah Novotny](https://twitter.com/sarahnovotny) for review and feedback! -_A version of this article was [originally posted][] on -[medium.com/opentelemetry](https://medium.com/opentelemetry)._ +_A version of this article was [originally posted][] on [medium.com/opentelemetry](https://medium.com/opentelemetry)._ [originally posted]: {{% param canonical_url %}} diff --git a/content/en/blog/2021/gc-election.md b/content/en/blog/2021/gc-election.md index 7fad088401b3..3c477b0e8f57 100644 --- a/content/en/blog/2021/gc-election.md +++ b/content/en/blog/2021/gc-election.md @@ -6,7 +6,6 @@ canonical_url: https://medium.com/opentelemetry/announcing-the-2021-opentelemetr --- The OpenTelemetry project is excited to announce the 2021 OpenTelemetry -Governance Committee (GC) election. For all the details, see the [original -post][]. +Governance Committee (GC) election. For all the details, see the [original post][]. [original post]: {{% param canonical_url %}} diff --git a/content/en/blog/2021/womens-day.md b/content/en/blog/2021/womens-day.md index 65966a157fbd..b06df675da78 100644 --- a/content/en/blog/2021/womens-day.md +++ b/content/en/blog/2021/womens-day.md @@ -6,7 +6,6 @@ canonical_url: https://medium.com/opentelemetry/opentelemetry-observes-internati --- Happy International Women’s Day! The OpenTelemetry project would like to extend -our thanks to all our women contributors. For all the details, see the [original -post][]. +our thanks to all our women contributors. For all the details, see the [original post][]. [original post]: {{% param canonical_url %}} diff --git a/content/en/blog/2022/debug-otel-with-otel/index.md b/content/en/blog/2022/debug-otel-with-otel/index.md index e95f5d7a6b9c..530842a4f0bf 100644 --- a/content/en/blog/2022/debug-otel-with-otel/index.md +++ b/content/en/blog/2022/debug-otel-with-otel/index.md @@ -229,8 +229,8 @@ in the NGINX module and we need to fix that. ### The fix -To fix our problem we [added some checks to the module for NGINX][], that make -sure that the trace headers are only set once. +To fix our problem we [added some checks to the module for NGINX][], that make sure +that the trace headers are only set once. This fix is contained in the [v1.0.1 release of the otel-webserver-module][]. This means you can update the `Dockerfile` to install the NGINX module like the diff --git a/content/en/blog/2022/exponential-histograms/index.md b/content/en/blog/2022/exponential-histograms/index.md index e5c666358263..4630f7b500c8 100644 --- a/content/en/blog/2022/exponential-histograms/index.md +++ b/content/en/blog/2022/exponential-histograms/index.md @@ -40,13 +40,12 @@ The SDK is used to configure what happens with the data collected by the API. This typically includes processing it and exporting it out of process for analysis, often to an observability platform. -The API entry point for metrics is the [meter provider][]. It provides meters -for different scopes, where a scope is just a logical unit of application code. -For example, instrumentation for an HTTP client library would have a different -scope and therefore a different meter than instrumentation for a database client -library. You use meters to obtain instruments. You use instruments to report -measurements, which consist of a value and set of attributes. This Java code -snippet demonstrates the workflow: +The API entry point for metrics is the [meter provider][]. It provides meters for +different scopes, where a scope is just a logical unit of application code. For example, +instrumentation for an HTTP client library would have a different scope and therefore +a different meter than instrumentation for a database client library. You use meters +to obtain instruments. You use instruments to report measurements, which consist +of a value and set of attributes. This Java code snippet demonstrates the workflow: ```java OpenTelemetry openTelemetry = // declare OpenTelemetry instance @@ -74,8 +73,7 @@ and when the sum of the things is more important than their individual values the distribution of measurements is relevant for analysis. For example, a histogram is a natural choice for tracking response times for HTTP servers, because it's useful to analyze the distribution of response times to evaluate -SLAs and identify trends. To learn more, see the guidelines for [instrument -selection][]. +SLAs and identify trends. To learn more, see the guidelines for [instrument selection][]. I mentioned earlier that the SDK aggregates measurements from instruments. Each instrument type has a default aggregation strategy (or simply [aggregation][]) @@ -127,10 +125,10 @@ request, you can determine: requests resolve quickly but a small number of requests take a long time and bring down the average. -The second type of OpenTelemetry histogram is the [exponential bucket -histogram][]. Exponential bucket histograms have buckets and bucket counts, but -instead of explicitly defining the bucket boundaries, the boundaries are -computed based on an exponential scale. More specifically, each bucket is +The second type of OpenTelemetry histogram is the [exponential +bucket histogram][]. Exponential bucket histograms have buckets and bucket +counts, but instead of explicitly defining the bucket boundaries, the boundaries +are computed based on an exponential scale. More specifically, each bucket is defined by an index _i_ and has bucket boundaries _(base\*\*i, base\*\*(i+1)]_, where _base\*\*i_ means that _base_ is raised to the power of _i_. The base is derived from a scale factor that is adjustable to reflect the range of reported @@ -199,14 +197,13 @@ large range of measurement values. Let's bring everything together with a proper demonstration comparing explicit bucket histograms to exponential bucket histograms. I've put together some -[example code][] that simulates tracking response time to an HTTP server in -milliseconds. It records one million samples to an explicit bucket histogram -with the default buckets, and to an exponential bucket histogram with a number -of buckets that produces roughly the same size of [OTLP][] -encoded, -Gzip-compressed payload as the explicit bucket defaults. Through trial and -error, I determined that ~40 exponential buckets produce an equivalent payload -size to the default explicit bucket histogram with 11 buckets. (Your results may -vary.) +[example code][] that simulates tracking response time to an HTTP server in milliseconds. +It records one million samples to an explicit bucket histogram with the default buckets, +and to an exponential bucket histogram with a number of buckets that produces roughly +the same size of [OTLP][] -encoded, Gzip-compressed payload as the explicit bucket +defaults. Through trial and error, I determined that ~40 exponential buckets produce +an equivalent payload size to the default explicit bucket histogram with 11 buckets. +(Your results may vary.) I wanted the distribution of samples to reflect what we might see in an actual HTTP server, with bands of response times corresponding to different operations. diff --git a/content/en/blog/2022/instrument-apache-httpd-server/index.md b/content/en/blog/2022/instrument-apache-httpd-server/index.md index 2dffb1d2b64d..b5975f6c7c5d 100644 --- a/content/en/blog/2022/instrument-apache-httpd-server/index.md +++ b/content/en/blog/2022/instrument-apache-httpd-server/index.md @@ -8,13 +8,12 @@ cSpell:ignore: Centos centos7 Debajit debuggability libmod uncompress webserver --- If you are using Apache HTTP Server and in dire need of some observability tool -to monitor your web server, the [OpenTelemetry Module for Apache HTTP Server][] -is the right candidate for you: it enables tracing of incoming requests to the -server and it will capture the response time of many modules (including -`mod_proxy`) involved in such an incoming request. With that you will get -hierarchical time consumption by each module. This article demonstrates the -monitoring capabilities of the OpenTelemetry Module for Apache HTTP Server and -quick guide to get started with the module. +to monitor your web server, the [OpenTelemetry Module for Apache HTTP Server][] is +the right candidate for you: it enables tracing of incoming requests to the server +and it will capture the response time of many modules (including `mod_proxy`) involved +in such an incoming request. With that you will get hierarchical time consumption +by each module. This article demonstrates the monitoring capabilities of the OpenTelemetry +Module for Apache HTTP Server and quick guide to get started with the module. ## Getting Started with OpenTelemetry Module diff --git a/content/en/blog/2022/k8s-metadata/index.md b/content/en/blog/2022/k8s-metadata/index.md index 013aae54726e..4a343f878c83 100644 --- a/content/en/blog/2022/k8s-metadata/index.md +++ b/content/en/blog/2022/k8s-metadata/index.md @@ -172,11 +172,10 @@ reducing the scope of the collector service account to a single namespace. ## Using Resource detector processor -As of [recently][pr#832], the [OpenTelemetry operator][] sets the -`OTEL_RESOURCE_ATTRIBUTES` environment variable on the collector container with -the K8s pod attributes. This lets you to use the resource detector processor, -which attaches the environment variable values to the spans. This only works -when the collector is deployed in sidecar mode. +As of [recently][pr#832], the [OpenTelemetry operator][] sets the `OTEL_RESOURCE_ATTRIBUTES` +environment variable on the collector container with the K8s pod attributes. This +lets you to use the resource detector processor, which attaches the environment variable +values to the spans. This only works when the collector is deployed in sidecar mode. For example, if you deploy the following manifest: diff --git a/content/en/blog/2022/kubecon-na.md b/content/en/blog/2022/kubecon-na.md index 0e36d81a3d2c..b46d6417835a 100644 --- a/content/en/blog/2022/kubecon-na.md +++ b/content/en/blog/2022/kubecon-na.md @@ -8,8 +8,8 @@ cSpell:ignore: Kowall Logz Pothulapati unconference Vineeth The OpenTelemetry project maintainers, and members of the governance committee and technical committee are excited to be at [KubeCon NA][] in a few weeks! Join -in to meet up in person or virtually for [OpenTelemetry](/) activities in -Detroit from October 24 - 28, 2022. +in to meet up in person or virtually for [OpenTelemetry](/) activities in Detroit +from October 24 - 28, 2022. There are talks, workshops, an unconference as well as a project booth where you are welcome to stop by, say Hi! and tell us about how you are using diff --git a/content/en/blog/2022/otel-demo-app-nomad/index.md b/content/en/blog/2022/otel-demo-app-nomad/index.md index 7f0ff0eb4cf0..e9b513efb822 100644 --- a/content/en/blog/2022/otel-demo-app-nomad/index.md +++ b/content/en/blog/2022/otel-demo-app-nomad/index.md @@ -350,8 +350,8 @@ Before I wrap this up, I do want to give a HUGE shoutout to [Luiz Aoqui](https://www.linkedin.com/in/luizaoqui/) of HashiCorp, who helped me tweak my Nomad jobspecs, and to [Riaan Nolan](https://www.linkedin.com/in/riaannolan/), for his continued work -on HashiQube. (Aside, both [Luiz] and [Riaan] were my guests on the [On-Call Me -Maybe Podcast]!) +on HashiQube. (Aside, both [Luiz] and [Riaan] were my guests on the [On-Call +Me Maybe Podcast]!) I will now leave you with a picture of Phoebe the rat, peering out of a pink basket. Doesn’t she look cute? 🥰 diff --git a/content/en/blog/2023/contributing-to-otel/index.md b/content/en/blog/2023/contributing-to-otel/index.md index ac910e12b9f0..3746a3153c30 100644 --- a/content/en/blog/2023/contributing-to-otel/index.md +++ b/content/en/blog/2023/contributing-to-otel/index.md @@ -25,9 +25,9 @@ projects? I don't know about you, but for me, up until last year, the prospect of contributing to open source was just plain _scary_!! I mean, when you open up a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) -(PR), _[you are putting yourself out there]_, to be judged by those little -GitHub avatars that make up the approvers list for the repository you're -contributing to. YIKES! +(PR), _[you are putting yourself out there]_, to be judged by those little GitHub +avatars that make up the approvers list for the repository you're contributing to. +YIKES! But as scary as the thought of opening a PR might be, it's also SO VERY SATISFYING to see your contributions merged into a codebase. And most diff --git a/content/en/blog/2023/ecs-otel-semconv-convergence.md b/content/en/blog/2023/ecs-otel-semconv-convergence.md index e76417d4beea..fdb3ec523b12 100644 --- a/content/en/blog/2023/ecs-otel-semconv-convergence.md +++ b/content/en/blog/2023/ecs-otel-semconv-convergence.md @@ -47,13 +47,12 @@ and join the discussion on our - [Announcement from Elastic][] - [OpenTelemetry Semantic Conventions][] -- [OTEP 199: Merge Elastic Common Schema with OpenTelemetry Semantic - Conventions][] -- [OTEP Issue 197: Proposal: Add support for Elastic Common Schema (ECS) in - OpenTelemetry][] +- [OTEP 199: Merge Elastic Common Schema with OpenTelemetry Semantic Conventions][] +- [OTEP Issue 197: Proposal: Add support for Elastic Common Schema (ECS) + in OpenTelemetry][] - [OTEP Pull Request 199: Support Elastic Common Schema in OpenTelemetry][] -- [OTEP Pull Request 222: Support Elastic Common Schema (ECS) in - OpenTelemetry][] +- [OTEP Pull Request 222: Support Elastic Common Schema (ECS) + in OpenTelemetry][] [Announcement from Elastic]: https://elastic.co/blog/ecs-elastic-common-schema-otel-opentelemetry-announcement diff --git a/content/en/blog/2023/end-user-q-and-a-03.md b/content/en/blog/2023/end-user-q-and-a-03.md index 734fa6094f33..849faa757736 100644 --- a/content/en/blog/2023/end-user-q-and-a-03.md +++ b/content/en/blog/2023/end-user-q-and-a-03.md @@ -298,11 +298,14 @@ The team also leaned heavily on and on the OTel Community for additional support. Are you currently using any processors on the OTel Collector? \ -The team is currently experimenting with processors, namely for data masking ([transform processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/transformprocessor), -or [redaction processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/redactionprocessor)), -especially as they move to using OTel Logs, which will contain sensitive data that -they won’t want to transmit to their Observability backend. They currently, however, -are only using the [batch processor](https://github.com/open-telemetry/opentelemetry-collector/blob/main/processor/batchprocessor/README.md). +The team is currently experimenting with processors, namely for data masking +([transform processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/transformprocessor), +or +[redaction processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/redactionprocessor)), +especially as they move to using OTel Logs, which will contain sensitive data +that they won’t want to transmit to their Observability backend. They currently, +however, are only using the +[batch processor](https://github.com/open-telemetry/opentelemetry-collector/blob/main/processor/batchprocessor/README.md). ### Are you aware of any teams using span events? diff --git a/content/en/blog/2023/exponential-histograms.md b/content/en/blog/2023/exponential-histograms.md index 9b481cf8f681..757201196f14 100644 --- a/content/en/blog/2023/exponential-histograms.md +++ b/content/en/blog/2023/exponential-histograms.md @@ -6,14 +6,13 @@ cSpell:ignore: Ganesh Ruslan subsetting Vernekar Vovalov canonical_url: https://dyladan.me/histograms/2023/05/04/exponential-histograms/ --- -Previously, in [Why Histograms?][] and [Histograms vs Summaries][], I went over -the basics of histograms and summaries, explaining the tradeoffs, benefits, and -limitations of each. Because they're easy to understand and demonstrate, those -posts focused on so-called explicit bucket histograms. The exponential bucket -histogram, also referred to as native histogram in Prometheus, is a low-cost, -efficient alternative to explicit bucket histograms. In this post, I go through -what they are, how they work, and the problems they solve that explicit bucket -histograms struggle with. +Previously, in [Why Histograms?][] and [Histograms vs Summaries][], I went over the +basics of histograms and summaries, explaining the tradeoffs, benefits, and limitations +of each. Because they're easy to understand and demonstrate, those posts focused +on so-called explicit bucket histograms. The exponential bucket histogram, also referred +to as native histogram in Prometheus, is a low-cost, efficient alternative to explicit +bucket histograms. In this post, I go through what they are, how they work, and the +problems they solve that explicit bucket histograms struggle with. ## Types of histograms @@ -130,8 +129,9 @@ relative error = (bucketWidth / 2) / bucketMidpoint = 4.329% ``` -For more information regarding histogram errors, see [OTEP 149][] and the -[specification for exponential histogram aggregations][]. +For more information regarding histogram errors, see [OTEP 149][] and the [specification +for +exponential histogram aggregations][]. ## Choosing a scale diff --git a/content/en/blog/2023/kubecon-eu.md b/content/en/blog/2023/kubecon-eu.md index 5091e3e93549..49f399a8a3eb 100644 --- a/content/en/blog/2023/kubecon-eu.md +++ b/content/en/blog/2023/kubecon-eu.md @@ -8,8 +8,8 @@ author: '[Severin Neumann](https://github.com/svrnm)' --- The OpenTelemetry project maintainers, members of the governance committee, and -technical committee are excited to be at [KubeCon EU][] in Amsterdam from April -18 - 21, 2023! +technical committee are excited to be at [KubeCon EU][] in Amsterdam from April 18 - +21, 2023! Read on to learn about all the things related OpenTelemetry during KubeCon. @@ -41,15 +41,14 @@ Come network with OpenTelemetry maintainers and core contributors during the [OpenTelemetry project meeting](https://sched.co/1JWS7), on Tuesday April 18, 2023 from 16:00 - 17:00. You can attend with a _standard in-person pass_. -[Observability Day][] _fosters collaboration, discussion, and knowledge sharing -of cloud-native observability projects_. This event will be held on April 18, -2023 from 9:00 - 17:00. There will be several sessions on OpenTelemetry as well. +[Observability Day][] _fosters collaboration, discussion, and knowledge sharing of +cloud-native observability projects_. This event will be held on April 18, 2023 from +9:00 - 17:00. There will be several sessions on OpenTelemetry as well. > **IMPORTANT access note**: You > need an _in-person all-access_ pass for on-site access to **Observability -> Day**. For details, see [KubeCon registration][]. If you have a virtual -> ticket, you will be able to follow **Observability Day** through a live -> stream. +> Day**. For details, see [KubeCon registration][]. If you have a virtual ticket, +> you will be able to follow **Observability Day** through a live stream. ## OpenTelemetry Project Booth @@ -67,9 +66,9 @@ You will find us in the Solutions Showcase in Hall 5, Kiosk Number 20. You can help us improve the project by sharing your thoughts and feedback about your OpenTelemetry adoption, implementation, and usage! We also invite you to -fill out our [community survey][]. We will create action items from your -comments as appropriate. Check [#otel-user-research][] in CNCF's Slack instance -for survey results and action item updates to come after KubeCon EU. +fill out our [community survey][]. We will create action items from your comments +as appropriate. Check [#otel-user-research][] in CNCF's Slack instance for survey +results and action item updates to come after KubeCon EU. Come join us to listen, learn, and get involved in OpenTelemetry. diff --git a/content/en/blog/2023/kubecon-na.md b/content/en/blog/2023/kubecon-na.md index 643fbd8fc131..6a28a41b229f 100644 --- a/content/en/blog/2023/kubecon-na.md +++ b/content/en/blog/2023/kubecon-na.md @@ -8,8 +8,8 @@ author: '[Severin Neumann](https://github.com/svrnm) (Cisco)' --- The OpenTelemetry project maintainers, members of the governance committee, and -technical committee are thrilled to be at [KubeCon NA][] in Chicago from -November 6 - 9, 2023. +technical committee are thrilled to be at [KubeCon NA][] in Chicago from November +6 - 9, 2023. Read on to learn about all the things related OpenTelemetry during KubeCon. @@ -78,15 +78,14 @@ OpenTelemetry maintainers in making OpenTelemetry better for everyone during the ## Co-located Events -[Observability Day][] _fosters collaboration, discussion, and knowledge sharing -of cloud-native observability projects_. This event will be held on November 6, -2023 from 9am - 5pm. There will be several sessions on OpenTelemetry as well. +[Observability Day][] _fosters collaboration, discussion, and knowledge sharing of +cloud-native observability projects_. This event will be held on November 6, 2023 +from 9am - 5pm. There will be several sessions on OpenTelemetry as well. > **IMPORTANT access note**: You > need an _in-person all-access_ pass for on-site access to **Observability -> Day**. For details, see [KubeCon registration][]. If you have a virtual -> ticket, you will be able to follow **Observability Day** through a live -> stream. +> Day**. For details, see [KubeCon registration][]. If you have a virtual ticket, +> you will be able to follow **Observability Day** through a live stream. ## OpenTelemetry Project Booth @@ -102,9 +101,9 @@ Project Pavilion. If you’re lucky, you may even pick up some OpenTelemetry swa You can help us improve the project by sharing your thoughts and feedback about your OpenTelemetry adoption, implementation, and usage. We also invite you to -fill out our [community survey][]. We will create action items from your -comments as appropriate. Check [#otel-user-research][] in CNCF's Slack instance -for survey results and action item updates to come after KubeCon NA. +fill out our [community survey][]. We will create action items from your comments +as appropriate. Check [#otel-user-research][] in CNCF's Slack instance for survey +results and action item updates to come after KubeCon NA. ## OpenTelemetry Observatory diff --git a/content/en/blog/2023/logs-collection/index.md b/content/en/blog/2023/logs-collection/index.md index 7408c916fad2..3f3512516462 100644 --- a/content/en/blog/2023/logs-collection/index.md +++ b/content/en/blog/2023/logs-collection/index.md @@ -420,8 +420,8 @@ extend Yoda's code to do the following: [transform or attributes processors](/docs/collector/transforming-telemetry/). 1. Add [tracing](/docs/concepts/signals/traces/) support by emitting spans, where it makes sense. -1. Add an Observability backend such as OpenSearch (along with [Data Prepper]) - to the setup, allowing to ingest spans and logs in OTLP format. +1. Add an Observability backend such as OpenSearch (along with [Data Prepper]) to + the setup, allowing to ingest spans and logs in OTLP format. 1. Once you have traces and logs ingested in a backend, try to correlate these two telemetry signal types in the backend along with a frontend such as Grafana. diff --git a/content/en/blog/2023/sunsetting-opencensus.md b/content/en/blog/2023/sunsetting-opencensus.md index 4ad2f71e9fbb..04bcfc307e7c 100644 --- a/content/en/blog/2023/sunsetting-opencensus.md +++ b/content/en/blog/2023/sunsetting-opencensus.md @@ -90,6 +90,7 @@ repository[^python-timeline]. maintainers. [^shim-next-release]: Python and JavaScript shim packages will be released soon. + [^shim-support]: These shims implement the stable [OpenCensus Compatibility specification](/docs/specs/otel/compatibility/opencensus#migration-path) diff --git a/content/en/blog/2024/java-metric-systems-compared/index.md b/content/en/blog/2024/java-metric-systems-compared/index.md index 69a21fa2c920..6085b3c6907e 100644 --- a/content/en/blog/2024/java-metric-systems-compared/index.md +++ b/content/en/blog/2024/java-metric-systems-compared/index.md @@ -13,8 +13,7 @@ across many popular languages, OpenTelemetry reduces the cognitive load of polyglot teams by providing one vocabulary and one toolkit. While that’s all true, today I’d like to zoom in on a specific signal and -language, and talk about the performance of the [OpenTelemetry Java][] metrics -SDK. +language, and talk about the performance of the [OpenTelemetry Java][] metrics SDK. ## Metrics Primer @@ -473,11 +472,9 @@ benefit every application, but are especially important to applications with high cardinality and with strict performance SLAs. If you’re reading this and considering Java metric systems, I hope you chose -[OpenTelemetry Java][]. It’s a powerful and highly performant tool on its own, -but comes with APIs for other key observability signals, a -[rich instrumentation ecosystem](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/supported-libraries.md), -[implementations in a variety of other languages](/docs/languages/), and a -well-supported +[OpenTelemetry Java][]. It’s a powerful and highly performant tool on its own, but +comes with APIs for other key observability signals, a [rich instrumentation ecosystem](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/supported-libraries.md), +[implementations in a variety of other languages](/docs/languages/), and a well-supported [open governance structure](https://github.com/open-telemetry/community). ## Acknowledgements diff --git a/content/en/blog/2024/kubecon-eu.md b/content/en/blog/2024/kubecon-eu.md index 1af8ce7a9fca..0b6e3742e849 100644 --- a/content/en/blog/2024/kubecon-eu.md +++ b/content/en/blog/2024/kubecon-eu.md @@ -10,9 +10,8 @@ author: '[Severin Neumann](https://github.com/svrnm) (Cisco)' --- The OpenTelemetry project maintainers, members of the governance committee, and -technical committee are thrilled to be at [KubeCon + CloudNativeCon Europe][] -and at the co-located -[Observability Day](https://events.linuxfoundation.org/kubecon-cloudnativecon-europe/co-located-events/observability-day/) +technical committee are thrilled to be at [KubeCon + CloudNativeCon Europe][] and +at the co-located [Observability Day](https://events.linuxfoundation.org/kubecon-cloudnativecon-europe/co-located-events/observability-day/) in Paris from March 19 - 22, 2024. Read on to learn about all the things related OpenTelemetry during KubeCon. @@ -46,9 +45,9 @@ it again right before KubeCon! ## Observability Day -_[Observability Day][] fosters collaboration, discussion, and knowledge sharing -of cloud-native observability projects_. This event will be held on March 19, -2024 from 9:00 - 17:35. There will be several sessions on OpenTelemetry as well: +_[Observability Day][] fosters collaboration, discussion, and knowledge sharing of +cloud-native observability projects_. This event will be held on March 19, 2024 from +9:00 - 17:35. There will be several sessions on OpenTelemetry as well: - **[Welcome + Project Updates](https://sched.co/1YGT9)**
by Eduardo Silva, FluentBit & Austin Parker, honeycomb.io
Tuesday, March 19th • 09:00 - @@ -90,8 +89,8 @@ of cloud-native observability projects_. This event will be held on March 19, {{% alert title="Important access note" color="danger" %}} You need an _in-person all-access_ pass for on-site access to **Observability -Day**. For details, see [KubeCon registration][]. If you have a virtual ticket, -you will be able to follow **Observability Day** through a live stream. +Day**. For details, see [KubeCon registration][]. If you have a virtual ticket, you +will be able to follow **Observability Day** through a live stream. [kubecon registration]: https://events.linuxfoundation.org/kubecon-cloudnativecon-europe/register/ diff --git a/content/en/blog/2024/profiling.md b/content/en/blog/2024/profiling.md index a91eb80d67cf..c55baec614b5 100644 --- a/content/en/blog/2024/profiling.md +++ b/content/en/blog/2024/profiling.md @@ -123,4 +123,5 @@ adding support for profiling, client-side RUM, and more. It’s a great time to get involved – check out our [website](https://opentelemetry.io) to learn more! [^1]: Pending due diligence and review by the OpenTelemetry maintainers. + [^2]: According to public download statistics of our .NET, Java, and Python APIs diff --git a/content/en/docs/collector/distributions.md b/content/en/docs/collector/distributions.md index 9b3c581e6678..af9e63e425db 100644 --- a/content/en/docs/collector/distributions.md +++ b/content/en/docs/collector/distributions.md @@ -3,9 +3,9 @@ title: Distributions weight: 25 --- -The OpenTelemetry project currently offers [pre-built distributions][] of the -collector. The components included in the [distributions][] can be found by in -the `manifest.yaml` of each distribution. +The OpenTelemetry project currently offers [pre-built distributions][] of the collector. +The components included in the [distributions][] can be found by in the `manifest.yaml` +of each distribution. [pre-built distributions]: https://github.com/open-telemetry/opentelemetry-collector-releases/releases diff --git a/content/en/docs/collector/installation.md b/content/en/docs/collector/installation.md index 282aaad8339a..e69c6e01e947 100644 --- a/content/en/docs/collector/installation.md +++ b/content/en/docs/collector/installation.md @@ -10,8 +10,8 @@ systems and architectures. The following instructions show how to download and install the latest stable version of the Collector. If you aren't familiar with the deployment models, components, and repositories -applicable to the OpenTelemetry Collector, first review the [Data Collection][] -and [Deployment Methods][] page. +applicable to the OpenTelemetry Collector, first review the [Data Collection][] and +[Deployment Methods][] page. ## Docker @@ -84,10 +84,10 @@ The previous example is meant to serve as a starting point, to be extended and customized before actual production usage. For production-ready customization and installation, see [OpenTelemetry Helm Charts][]. -You can also use the [OpenTelemetry Operator][] to provision and maintain an -OpenTelemetry Collector instance, with features such as automatic upgrade -handling, `Service` configuration based on the OpenTelemetry configuration, -automatic sidecar injection into deployments, and more. +You can also use the [OpenTelemetry Operator][] to provision and maintain an OpenTelemetry +Collector instance, with features such as automatic upgrade handling, `Service` configuration +based on the OpenTelemetry configuration, automatic sidecar injection into deployments, +and more. For guidance on how to use the Collector with Kubernetes, see [Kubernetes Getting Started](/docs/kubernetes/getting-started/). diff --git a/content/en/docs/collector/internal-telemetry.md b/content/en/docs/collector/internal-telemetry.md index 3dfdad230978..0b300553fb2e 100644 --- a/content/en/docs/collector/internal-telemetry.md +++ b/content/en/docs/collector/internal-telemetry.md @@ -98,8 +98,8 @@ critical analysis. Log output is found in `stderr`. You can configure logs in the config `service::telemetry::logs`. The [configuration -options](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{% -param vers %}}/service/telemetry/config.go) are: +options](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{% param +vers %}}/service/telemetry/config.go) are: | Field name | Default value | Description | | ---------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/content/en/docs/concepts/instrumentation/libraries.md b/content/en/docs/concepts/instrumentation/libraries.md index 864d2caff0db..a2bd6b7cd3a6 100644 --- a/content/en/docs/concepts/instrumentation/libraries.md +++ b/content/en/docs/concepts/instrumentation/libraries.md @@ -5,8 +5,8 @@ aliases: [../instrumenting-library] weight: 40 --- -OpenTelemetry provides [instrumentation libraries][] for many libraries, which -is typically done through library hooks or monkey-patching library code. +OpenTelemetry provides [instrumentation libraries][] for many libraries, which is +typically done through library hooks or monkey-patching library code. Native library instrumentation with OpenTelemetry provides better observability and developer experience for users, removing the need for libraries to expose @@ -249,8 +249,8 @@ module might already have OpenTelemetry integration -- to find out, see the context on all logs, so users can correlate them. If your language and ecosystem don't have common logging support, use [span -events][] to share additional app details. Events maybe more convenient if you -want to add attributes as well. +events][] to share additional app details. Events maybe more convenient if you want +to add attributes as well. As a rule of thumb, use events or logs for verbose data instead of spans. Always attach events to the span instance that your instrumentation created. Avoid diff --git a/content/en/docs/contributing/_index.md b/content/en/docs/contributing/_index.md index 3c0d35a670f9..97ff3c182bc9 100644 --- a/content/en/docs/contributing/_index.md +++ b/content/en/docs/contributing/_index.md @@ -421,9 +421,9 @@ close the terminal window. #### Site deploys and PR previews -If you submit a PR, Netlify creates a [deploy preview][] so that you can review -your changes. Once your PR is merged, Netlify deploys the updated site to the -production server. +If you submit a PR, Netlify creates a [deploy preview][] so that you can review your +changes. Once your PR is merged, Netlify deploys the updated site to the production +server. > **Note**: PR previews include _draft pages_, but production builds do not. diff --git a/content/en/docs/demo/forking.md b/content/en/docs/demo/forking.md index e3f4930d5078..6aa882a3f337 100644 --- a/content/en/docs/demo/forking.md +++ b/content/en/docs/demo/forking.md @@ -3,8 +3,8 @@ title: Forking the demo repository linkTitle: Forking --- -The [demo repository][] is designed to be forked and used as a tool to show off -what you are doing with OpenTelemetry. +The [demo repository][] is designed to be forked and used as a tool to show off what +you are doing with OpenTelemetry. Setting up a fork or a demo usually only requires overriding some environment variables and possibly replacing some container images. diff --git a/content/en/docs/languages/erlang/instrumentation.md b/content/en/docs/languages/erlang/instrumentation.md index 7f0c714c0ada..8d815f5daaef 100644 --- a/content/en/docs/languages/erlang/instrumentation.md +++ b/content/en/docs/languages/erlang/instrumentation.md @@ -267,11 +267,10 @@ end ### Semantic Attributes Semantic Attributes are attributes that are defined by the [OpenTelemetry -Specification][] in order to provide a shared set of attribute keys across -multiple languages, frameworks, and runtimes for common concepts like HTTP -methods, status codes, user agents, and more. These attribute keys are generated -from the specification and provided in -[opentelemetry_semantic_conventions](https://hex.pm/packages/opentelemetry_semantic_conventions). +Specification][] in order to provide a shared set of attribute keys across multiple +languages, frameworks, and runtimes for common concepts like HTTP methods, status +codes, user agents, and more. These attribute keys are generated from the specification +and provided in [opentelemetry_semantic_conventions](https://hex.pm/packages/opentelemetry_semantic_conventions). For example, an instrumentation for an HTTP client or server would need to include semantic attributes like the scheme of the URL: diff --git a/content/en/docs/languages/go/instrumentation.md b/content/en/docs/languages/go/instrumentation.md index aa5811b0b7be..c9b61dc8ddbe 100644 --- a/content/en/docs/languages/go/instrumentation.md +++ b/content/en/docs/languages/go/instrumentation.md @@ -185,10 +185,10 @@ span.SetAttributes(myKey.String("a value")) #### Semantic Attributes Semantic Attributes are attributes that are defined by the [OpenTelemetry -Specification][] in order to provide a shared set of attribute keys across -multiple languages, frameworks, and runtimes for common concepts like HTTP -methods, status codes, user agents, and more. These attributes are available in -the `go.opentelemetry.io/otel/semconv/v1.21.0` package. +Specification][] in order to provide a shared set of attribute keys across multiple +languages, frameworks, and runtimes for common concepts like HTTP methods, status +codes, user agents, and more. These attributes are available in the `go.opentelemetry.io/otel/semconv/v1.21.0` +package. For details, see [Trace semantic conventions][]. diff --git a/content/en/docs/languages/java/exporters.md b/content/en/docs/languages/java/exporters.md index 624c3ce1c352..65d535ff4ecf 100644 --- a/content/en/docs/languages/java/exporters.md +++ b/content/en/docs/languages/java/exporters.md @@ -91,9 +91,8 @@ Note, that in the case of exporting via OTLP you do not need to set `OTEL_TRACES_EXPORTER`, `OTEL_METRICS_EXPORTER` and `OTEL_LOGS_EXPORTER` since `otlp` is their default value -In the case of [manual configuration] you can update the -[example app](/docs/languages/java/instrumentation#example-app) like the -following: +In the case of [manual configuration] you can update the [example app](/docs/languages/java/instrumentation#example-app) +like the following: ```java { hl_lines=["12-14",21,"39-53"] } package otel; diff --git a/content/en/docs/languages/java/getting-started.md b/content/en/docs/languages/java/getting-started.md index ad8a7addbecc..68de7ef50d5e 100644 --- a/content/en/docs/languages/java/getting-started.md +++ b/content/en/docs/languages/java/getting-started.md @@ -19,10 +19,9 @@ Ensure that you have the following installed locally: ## Example Application -The following example uses a basic [Spring Boot] application. You can use -another web framework, such as Apache Wicket or Play. For a complete list of -libraries and supported frameworks, consult the -[registry](/ecosystem/registry/?component=instrumentation&language=java). +The following example uses a basic [Spring Boot] application. You can use another +web framework, such as Apache Wicket or Play. For a complete list of libraries and +supported frameworks, consult the [registry](/ecosystem/registry/?component=instrumentation&language=java). For more elaborate examples, see [examples](/docs/languages/java/examples/). @@ -137,8 +136,8 @@ agent][] in a number of ways, the steps below use environment variables. to the JAR file.{{% /alert %}} 2. Set and export variables that specify the Java agent JAR and a [console - exporter][], using a notation suitable for your shell/terminal environment - — we illustrate a notation for bash-like shells: + exporter][], using a notation suitable for your shell/terminal environment — + we illustrate a notation for bash-like shells: ```sh export JAVA_TOOL_OPTIONS="-javaagent:PATH/TO/opentelemetry-javaagent.jar" \ @@ -240,8 +239,7 @@ For more: - Try [zero-code instrumentation](/docs/zero-code/java/agent/) on one of your own apps. - For light-weight customized telemetry, try [annotations][]. -- Learn about [manual instrumentation][] and try out more - [examples](/docs/languages/java/examples/). +- Learn about [manual instrumentation][] and try out more [examples](/docs/languages/java/examples/). - Take a look at the [OpenTelemetry Demo](/docs/demo/), which includes Java based [Ad Service](/docs/demo/services/ad/) and Kotlin based [Fraud Detection Service](/docs/demo/services/fraud-detection/) diff --git a/content/en/docs/languages/java/instrumentation.md b/content/en/docs/languages/java/instrumentation.md index a207e332e214..f3bc30d67749 100644 --- a/content/en/docs/languages/java/instrumentation.md +++ b/content/en/docs/languages/java/instrumentation.md @@ -579,9 +579,10 @@ To do [Tracing](/docs/concepts/signals/traces/) you'll need to acquire a First, a `Tracer` must be acquired, which is responsible for creating spans and interacting with the [Context](#context-propagation). A tracer is acquired by using the OpenTelemetry API specifying the name and version of the [library -instrumenting][instrumentation library] the [instrumented library] or -application to be monitored. More information is available in the specification -chapter [Obtaining a Tracer]. +instrumenting][instrumentation library] the [instrumented library] or application +to be monitored. More information is available in the specification chapter [Obtaining +a +Tracer]. Anywhere in your application where you write manual tracing code should call `getTracer` to acquire a tracer. For example: @@ -1567,8 +1568,8 @@ exporters out of the box: - Logging Exporter: saves the telemetry data into log streams. Varieties include `LoggingSpanExporter` and `OtlpJsonLoggingSpanExporter`. - OpenTelemetry Protocol Exporter: sends the data in OTLP to the [OpenTelemetry - Collector] or other OTLP receivers. Varieties include `OtlpGrpcSpanExporter` - and `OtlpHttpSpanExporter`. + Collector] or other OTLP receivers. Varieties include `OtlpGrpcSpanExporter` and + `OtlpHttpSpanExporter`. Other exporters can be found in the [OpenTelemetry Registry]. @@ -1685,8 +1686,8 @@ particular backend. OpenTelemetry provides the following exporters out of the box: - OpenTelemetry Protocol Exporter: sends the data in OTLP to the [OpenTelemetry - Collector] or other OTLP receivers. Varieties include - `OtlpGrpcLogRecordExporter` and `OtlpHttpLogRecordExporter`. + Collector] or other OTLP receivers. Varieties include `OtlpGrpcLogRecordExporter` + and `OtlpHttpLogRecordExporter`. - `InMemoryLogRecordExporter`: keeps the data in memory, useful for testing and debugging. - Logging Exporter: saves the telemetry data into log streams. Varieties include diff --git a/content/en/docs/languages/js/exporters.md b/content/en/docs/languages/js/exporters.md index 401ed6884541..3b00b9ad964c 100644 --- a/content/en/docs/languages/js/exporters.md +++ b/content/en/docs/languages/js/exporters.md @@ -134,8 +134,8 @@ collector. #### Use OTLP exporter with HTTP/JSON or HTTP/protobuf [OpenTelemetry Collector Exporter with gRPC][] works only with Node.js, -therefore you are limited to use the [OpenTelemetry Collector Exporter with -HTTP/JSON][] or [OpenTelemetry Collector Exporter with HTTP/protobuf][]. +therefore you are limited to use the [OpenTelemetry Collector Exporter +with HTTP/JSON][] or [OpenTelemetry Collector Exporter with HTTP/protobuf][]. Make sure that the receiving end of your exporter (collector or observability backend) accepts `http/json` if you are using [OpenTelemetry Collector Exporter @@ -161,9 +161,8 @@ If your website and collector are hosted at a different origin, your browser might block the requests going out to your collector. You need to configure special headers for Cross-Origin Resource Sharing (CORS). -The OpenTelemetry Collector provides [a feature][] for http-based receivers to -add the required headers to allow the receiver to accept traces from a web -browser: +The OpenTelemetry Collector provides [a feature][] for http-based receivers to add +the required headers to allow the receiver to accept traces from a web browser: ```yaml receivers: diff --git a/content/en/docs/languages/js/resources.md b/content/en/docs/languages/js/resources.md index 7972a35f5a75..f0dc34e02c6e 100644 --- a/content/en/docs/languages/js/resources.md +++ b/content/en/docs/languages/js/resources.md @@ -12,13 +12,13 @@ Node.js SDK. ## Setup -Follow the instructions in the [Getting Started - Node.js][], so that you have -the files `package.json`, `app.js` and `tracing.js`. +Follow the instructions in the [Getting Started - Node.js][], so that you have the +files `package.json`, `app.js` and `tracing.js`. ## Process & Environment Resource Detection -Out of the box, the Node.js SDK detects [process and process runtime -resources][] and takes attributes from the environment variable +Out of the box, the Node.js SDK detects [process and process +runtime resources][] and takes attributes from the environment variable `OTEL_RESOURCE_ATTRIBUTES`. You can verify what it detects by turning on diagnostic logging in `tracing.js`: diff --git a/content/en/docs/languages/net/getting-started.md b/content/en/docs/languages/net/getting-started.md index f7fd44784209..29301d2e10f3 100644 --- a/content/en/docs/languages/net/getting-started.md +++ b/content/en/docs/languages/net/getting-started.md @@ -265,8 +265,7 @@ For more: - Run this example with another [exporter][] for telemetry data. - Try [automatic instrumentation](/docs/zero-code/net/) on one of your own apps. -- Learn about [manual instrumentation][] and try out more - [examples](/docs/languages/net/examples/). +- Learn about [manual instrumentation][] and try out more [examples](/docs/languages/net/examples/). - Take a look at the [OpenTelemetry Demo](/docs/demo/), which includes .NET based [Cart Service](/docs/demo/services/cart/). diff --git a/content/en/docs/languages/net/resources.md b/content/en/docs/languages/net/resources.md index 4d51bbddff83..42b4eea6e9e6 100644 --- a/content/en/docs/languages/net/resources.md +++ b/content/en/docs/languages/net/resources.md @@ -8,8 +8,8 @@ cSpell:ignore: myhost pcarter uuidgen ## Setup -Follow the instructions in the [Getting Started][], so that you have a running -.NET app exporting data to the console. +Follow the instructions in the [Getting Started][], so that you have a running .NET +app exporting data to the console. ## Adding resources with environment variables diff --git a/content/en/docs/languages/php/getting-started.md b/content/en/docs/languages/php/getting-started.md index fc22043fc94a..8a8d5667b063 100644 --- a/content/en/docs/languages/php/getting-started.md +++ b/content/en/docs/languages/php/getting-started.md @@ -488,8 +488,7 @@ For more: - Run this example with another [exporter][] for telemetry data. - Try [automatic instrumentation](../automatic/) on one of your own apps. -- Learn more about [manual instrumentation][] and try out some - [examples](/docs/languages/php/examples/). +- 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/). diff --git a/content/en/docs/languages/ruby/getting-started.md b/content/en/docs/languages/ruby/getting-started.md index 8a5f2a35e0f4..16430e6a8f6f 100644 --- a/content/en/docs/languages/ruby/getting-started.md +++ b/content/en/docs/languages/ruby/getting-started.md @@ -177,12 +177,12 @@ Adding tracing to a single service is a great first step. OpenTelemetry provides a few more features that will allow you gain even deeper insights! - [Exporters][] allow you to export your data to a preferred backend. -- [Context propagation][] is perhaps one of the most powerful concepts in - OpenTelemetry because it will upgrade your single service trace into a - _distributed trace_, which makes it possible for OpenTelemetry vendors to - visualize a request from end-to-end across process and network boundaries. -- [Span events][] allow you to add a human-readable message on a span that - represents "something happening" during its lifetime. +- [Context propagation][] is perhaps one of the most powerful concepts in OpenTelemetry + because it will upgrade your single service trace into a _distributed trace_, which + makes it possible for OpenTelemetry vendors to visualize a request from end-to-end + across process and network boundaries. +- [Span events][] allow you to add a human-readable message on a span that represents + "something happening" during its lifetime. - [Instrumentation][instrumentation] will give provide you the ability to enrich your traces with domain specific data. - [The OpenTelemetry Demo](/docs/demo/) includes the Ruby based diff --git a/content/en/docs/migration/_index.md b/content/en/docs/migration/_index.md index e090451d8296..22d6d61ca3d2 100644 --- a/content/en/docs/migration/_index.md +++ b/content/en/docs/migration/_index.md @@ -7,9 +7,9 @@ weight: 50 ## OpenTracing and OpenCensus OpenTelemetry was created as a merger of OpenTracing and OpenCensus. From the -start, OpenTelemetry was considered [to be the next major version of both -OpenTracing and OpenCensus][]. Because of that, one of the [key goals][] of the -OpenTelemetry project is to provide backward compatibility with both projects +start, OpenTelemetry was considered [to be the next major version of +both OpenTracing and OpenCensus][]. Because of that, one of the [key goals][] of +the OpenTelemetry project is to provide backward compatibility with both projects and a migration story for existing users. If you come from one of these projects, you can follow the migration guides for diff --git a/content/en/docs/zero-code/_index.md b/content/en/docs/zero-code/_index.md index 0807395341a3..e1f7c1ea147d 100644 --- a/content/en/docs/zero-code/_index.md +++ b/content/en/docs/zero-code/_index.md @@ -13,8 +13,8 @@ see [Issue #4427] {{% /pageinfo %}} -OpenTelemetry [zero-code instrumentation][] is supported for the languages -listed below in the section index. +OpenTelemetry [zero-code instrumentation][] is supported for the languages listed +below in the section index. If you are using Kubernetes, you can use the [OpenTelemetry Operator for Kubernetes][otel-op] to [inject zero-code instrumentation] for .NET, Java, diff --git a/content/en/docs/zero-code/java/agent/annotations.md b/content/en/docs/zero-code/java/agent/annotations.md index 02f2defc6f63..2df0e753319a 100644 --- a/content/en/docs/zero-code/java/agent/annotations.md +++ b/content/en/docs/zero-code/java/agent/annotations.md @@ -107,8 +107,9 @@ using `@WithSpan` and you want to suppress some of them without modifying the code. {{% config_option - name="otel.instrumentation.opentelemetry-instrumentation-annotations.exclude-methods" %}} -Suppress `@WithSpan` instrumentation for specific methods. Format is `my.package.MyClass1[method1,method2];my.package.MyClass2[method3]`. + name="otel.instrumentation.opentelemetry-instrumentation-annotations.exclude-methods" %}} Suppress +`@WithSpan` instrumentation for specific methods. Format is +`my.package.MyClass1[method1,method2];my.package.MyClass2[method3]`. {{% /config_option %}} ## Creating spans around methods with `otel.instrumentation.methods.include` diff --git a/content/en/docs/zero-code/java/agent/configuration.md b/content/en/docs/zero-code/java/agent/configuration.md index 427409d06def..ac75cd828e9b 100644 --- a/content/en/docs/zero-code/java/agent/configuration.md +++ b/content/en/docs/zero-code/java/agent/configuration.md @@ -29,13 +29,15 @@ can enable additional resource providers that are disabled by default: {{% config_option name="otel.resource.providers.aws.enabled" default=false -%}} Enables the [AWS Resource Provider](https://github.com/open-telemetry/opentelemetry-java-contrib/tree/main/aws-resources). +%}} Enables the +[AWS Resource Provider](https://github.com/open-telemetry/opentelemetry-java-contrib/tree/main/aws-resources). {{% /config_option %}} {{% config_option name="otel.resource.providers.gcp.enabled" default=false -%}} Enables the [GCP Resource Provider](https://github.com/open-telemetry/opentelemetry-java-contrib/tree/main/gcp-resources). +%}} Enables the +[GCP Resource Provider](https://github.com/open-telemetry/opentelemetry-java-contrib/tree/main/gcp-resources). {{% /config_option %}} ## Configuring the agent @@ -254,22 +256,26 @@ and {{% config_option name="otel.instrumentation.common.enduser.enabled" default=false -%}} Common flag for enabling/disabling enduser attributes. {{% /config_option %}} +%}} Common flag for enabling/disabling enduser attributes. +{{% /config_option %}} {{% config_option name="otel.instrumentation.common.enduser.id.enabled" default=false -%}} Determines whether to capture `enduser.id` semantic attribute. {{% /config_option %}} +%}} Determines whether to capture `enduser.id` semantic attribute. +{{% /config_option %}} {{% config_option name="otel.instrumentation.common.enduser.role.enabled" default=false -%}} Determines whether to capture `enduser.role` semantic attribute. {{% /config_option %}} +%}} Determines whether to capture `enduser.role` semantic attribute. +{{% /config_option %}} {{% config_option name="otel.instrumentation.common.enduser.scope.enabled" default=false -%}} Determines whether to capture `enduser.scope` semantic attribute. {{% /config_option %}} +%}} Determines whether to capture `enduser.scope` semantic attribute. +{{% /config_option %}} #### Spring Security @@ -282,14 +288,14 @@ names: {{% config_option name="otel.instrumentation.spring-security.enduser.role.granted-authority-prefix" default=ROLE_ -%}} Prefix of granted authorities identifying roles to capture in the `enduser.role` -semantic attribute. {{% /config_option %}} +%}} Prefix of granted authorities identifying roles to capture in the +`enduser.role` semantic attribute. {{% /config_option %}} {{% config_option name="otel.instrumentation.spring-security.enduser.scope.granted-authority-prefix" default=SCOPE_ -%}} Prefix of granted authorities identifying scopes to capture in the `enduser.scopes` -semantic attribute. {{% /config_option %}} +%}} Prefix of granted authorities identifying scopes to capture in the +`enduser.scopes` semantic attribute. {{% /config_option %}} ## Suppressing specific instrumentation diff --git a/content/en/docs/zero-code/net/getting-started.md b/content/en/docs/zero-code/net/getting-started.md index 612dd083c0f3..1d00bbaa45a4 100644 --- a/content/en/docs/zero-code/net/getting-started.md +++ b/content/en/docs/zero-code/net/getting-started.md @@ -107,8 +107,8 @@ dotnet run ## Instrumentation Next, you'll use a [OpenTelemetry .NET Automatic Instrumentation](../) to -instrument the application at launch time. While you can [configure .NET -Automatic Instrumentation][] in a number of ways, the steps below use Unix-shell +instrument the application at launch time. While you can [configure +.NET Automatic Instrumentation][] in a number of ways, the steps below use Unix-shell or PowerShell scripts. > **Note**: PowerShell commands require elevated (administrator) privileges. @@ -150,10 +150,10 @@ or PowerShell scripts. {{% /tab %}} {{< /tabpane >}} -3. Set and export variables that specify a [console exporter][], then execute - script configuring other necessary environment variables using a notation - suitable for your shell/terminal environment — we illustrate a notation - for bash-like shells and PowerShell: +3. Set and export variables that specify a [console exporter][], then execute script + configuring other necessary environment variables using a notation suitable for + your shell/terminal environment — we illustrate a notation for bash-like + shells and PowerShell: {{< tabpane text=true >}} {{% tab Unix-shell %}} diff --git a/content/en/ecosystem/registry/adding.md b/content/en/ecosystem/registry/adding.md index 9546be7f48c1..d5268955db3e 100644 --- a/content/en/ecosystem/registry/adding.md +++ b/content/en/ecosystem/registry/adding.md @@ -7,9 +7,8 @@ description: How to add entries to the registry. Do you maintain or contribute to an integration for OpenTelemetry? We'd love to feature your project in the [registry](../)! -To add your project, submit a [pull request][]. You'll need to create a data -file in [data/registry][] for your project, by using the following template: -[registry-entry.yml][]. +To add your project, submit a [pull request][]. You'll need to create a data file +in [data/registry][] for your project, by using the following template: [registry-entry.yml][]. [data/registry]: https://github.com/open-telemetry/opentelemetry.io/tree/main/data/registry diff --git a/layouts/shortcodes/docs/languages/exporters/intro.md b/layouts/shortcodes/docs/languages/exporters/intro.md index 9d2867a6dd6a..be714cb9b1e7 100644 --- a/layouts/shortcodes/docs/languages/exporters/intro.md +++ b/layouts/shortcodes/docs/languages/exporters/intro.md @@ -51,8 +51,8 @@ them up. diff --git a/layouts/shortcodes/docs/languages/exporters/outro.md b/layouts/shortcodes/docs/languages/exporters/outro.md index a6ccb6adc578..8f4add50c32c 100644 --- a/layouts/shortcodes/docs/languages/exporters/outro.md +++ b/layouts/shortcodes/docs/languages/exporters/outro.md @@ -3,8 +3,7 @@ ## Custom exporters Finally, you can also write your own exporter. For more information, see the -[SpanExporter Interface in the API -documentation]({{ $spanExporterInterfaceUrl }}). +[SpanExporter Interface in the API documentation]({{ $spanExporterInterfaceUrl }}). ## Batching span and log records