diff --git a/README.md b/README.md index 3f4e8247d349..c60044ec0eb3 100644 --- a/README.md +++ b/README.md @@ -44,8 +44,8 @@ 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][]. ## Roles @@ -74,8 +74,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 0d57e712b82d..c32b2e24fb2f 100644 --- a/content/en/blog/2019/opentelemetry-governance-committee-explained/index.md +++ b/content/en/blog/2019/opentelemetry-governance-committee-explained/index.md @@ -74,6 +74,7 @@ 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 3c477b0e8f57..7fad088401b3 100644 --- a/content/en/blog/2021/gc-election.md +++ b/content/en/blog/2021/gc-election.md @@ -6,6 +6,7 @@ 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 b06df675da78..65966a157fbd 100644 --- a/content/en/blog/2021/womens-day.md +++ b/content/en/blog/2021/womens-day.md @@ -6,6 +6,7 @@ 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 fa89614193d5..4a345339cb98 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 4630f7b500c8..e5c666358263 100644 --- a/content/en/blog/2022/exponential-histograms/index.md +++ b/content/en/blog/2022/exponential-histograms/index.md @@ -40,12 +40,13 @@ 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 @@ -73,7 +74,8 @@ 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][]) @@ -125,10 +127,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 @@ -197,13 +199,14 @@ 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 b5975f6c7c5d..2dffb1d2b64d 100644 --- a/content/en/blog/2022/instrument-apache-httpd-server/index.md +++ b/content/en/blog/2022/instrument-apache-httpd-server/index.md @@ -8,12 +8,13 @@ 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 4a343f878c83..013aae54726e 100644 --- a/content/en/blog/2022/k8s-metadata/index.md +++ b/content/en/blog/2022/k8s-metadata/index.md @@ -172,10 +172,11 @@ 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 b46d6417835a..0e36d81a3d2c 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 e9b513efb822..7f0ff0eb4cf0 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 3746a3153c30..ac910e12b9f0 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 fdb3ec523b12..e76417d4beea 100644 --- a/content/en/blog/2023/ecs-otel-semconv-convergence.md +++ b/content/en/blog/2023/ecs-otel-semconv-convergence.md @@ -47,12 +47,13 @@ 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/exponential-histograms.md b/content/en/blog/2023/exponential-histograms.md index 757201196f14..9b481cf8f681 100644 --- a/content/en/blog/2023/exponential-histograms.md +++ b/content/en/blog/2023/exponential-histograms.md @@ -6,13 +6,14 @@ 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 @@ -129,9 +130,8 @@ 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 49f399a8a3eb..5091e3e93549 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,14 +41,15 @@ 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 @@ -66,9 +67,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 6a28a41b229f..643fbd8fc131 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,14 +78,15 @@ 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 @@ -101,9 +102,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 3f3512516462..7408c916fad2 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/2024/java-metric-systems-compared/index.md b/content/en/blog/2024/java-metric-systems-compared/index.md index 6085b3c6907e..69a21fa2c920 100644 --- a/content/en/blog/2024/java-metric-systems-compared/index.md +++ b/content/en/blog/2024/java-metric-systems-compared/index.md @@ -13,7 +13,8 @@ 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 @@ -472,9 +473,11 @@ 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 0b6e3742e849..1af8ce7a9fca 100644 --- a/content/en/blog/2024/kubecon-eu.md +++ b/content/en/blog/2024/kubecon-eu.md @@ -10,8 +10,9 @@ 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. @@ -45,9 +46,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 - @@ -89,8 +90,8 @@ cloud-native observability projects_. This event will be held on March 19, 2024 {{% 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/kubecon-na.md b/content/en/blog/2024/kubecon-na.md index 84cb402881ab..f687279e02e6 100644 --- a/content/en/blog/2024/kubecon-na.md +++ b/content/en/blog/2024/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 Salt Lake City from November -12 - 15, 2024. +technical committee are thrilled to be at [KubeCon NA][] in Salt Lake City from +November 12 - 15, 2024. Read on to learn about all the things related OpenTelemetry during KubeCon. @@ -78,15 +78,17 @@ first steps: documentation, Collector, Java, JS, Ruby, Python, .NET, and more. ## Observability Day -_[Observability Day][] fosters collaboration, discussion, and knowledge sharing of -cloud-native observability projects_. This event will be held on November 12, 2024 -from 9am to 6pm. [Check the full schedule](https://colocatedeventsna2024.sched.com/overview/type/Observability+Day) +_[Observability Day][] fosters collaboration, discussion, and knowledge sharing +of cloud-native observability projects_. This event will be held on November 12, +2024 from 9am to 6pm. +[Check the full schedule](https://colocatedeventsna2024.sched.com/overview/type/Observability+Day) to find your favorite talks about Observability and OpenTelemetry. > **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 Observatory diff --git a/content/en/community/end-user/slack-channel.md b/content/en/community/end-user/slack-channel.md index fa91be02db9f..cb0534371036 100644 --- a/content/en/community/end-user/slack-channel.md +++ b/content/en/community/end-user/slack-channel.md @@ -6,21 +6,17 @@ description: >- weight: 40 --- -Previously, we had a private channel to provide a space for end users to discuss -adoption and implementation issues while allowing them to maintain a layer of -privacy and to meet compliance concerns. Now that the project and community have -grown, and with the transition of the End User WG to End User SIG, we believe -that this private channel is no longer needed. +Join our Slack channel to connect with other OpenTelemetry end users! -As of April 2024, we will begin shifting all of our communications to the -[`#otel-sig-end-user`](https://cloud-native.slack.com/archives/C01RT3MSWGZ) -channel (previously named the `#otel-user-research` channel), and will be -archiving the private channel by **April 30, 2024**. +First, [request an invitation](https://slack.cncf.io/) to CNCF's Slack instance. +Next, join +[`#otel-sig-end-user`](https://cloud-native.slack.com/archives/C01RT3MSWGZ), and +introduce yourself if you'd like. -We encourage you to join us over at -[`#otel-sig-end-user`](https://cloud-native.slack.com/archives/C01RT3MSWGZ) to -learn about our new charter, what you can expect from us as an end user, and -more. Note the following: +We encourage questions and discussions about adoption and implementation. You +can also hear about upcoming events and get a chance to contribute to the +project by participating in surveys and user feedback sessions. Note the +following: - Troubleshooting or tactical SDK specific questions are still best directed to individual SIG channels or the diff --git a/content/en/docs/collector/building/connector/otel-collector-after-connector.svg b/content/en/docs/collector/building/connector/otel-collector-after-connector.svg index a6bd7802b339..561951e55d7a 100644 --- a/content/en/docs/collector/building/connector/otel-collector-after-connector.svg +++ b/content/en/docs/collector/building/connector/otel-collector-after-connector.svg @@ -1,235 +1,354 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/content/en/docs/collector/building/connector/otel-collector-before-connector.svg b/content/en/docs/collector/building/connector/otel-collector-before-connector.svg index 662198cd7766..102202599f99 100644 --- a/content/en/docs/collector/building/connector/otel-collector-before-connector.svg +++ b/content/en/docs/collector/building/connector/otel-collector-before-connector.svg @@ -1,6 +1,6 @@ - + diff --git a/content/en/docs/collector/distributions.md b/content/en/docs/collector/distributions.md index af9e63e425db..9b3c581e6678 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/img/otel-gateway-sdk.svg b/content/en/docs/collector/img/otel-gateway-sdk.svg index 006a96a54949..5279ce7a6be3 100644 --- a/content/en/docs/collector/img/otel-gateway-sdk.svg +++ b/content/en/docs/collector/img/otel-gateway-sdk.svg @@ -1,5 +1,5 @@ - + diff --git a/content/en/docs/collector/installation.md b/content/en/docs/collector/installation.md index 9de9bc56d5f6..492531bd2131 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 022f8278da18..b7aa01f34841 100644 --- a/content/en/docs/collector/internal-telemetry.md +++ b/content/en/docs/collector/internal-telemetry.md @@ -168,14 +168,14 @@ service: exporter: otlp: protocol: grpc/protobuf - endpoint: localhost:14317 + endpoint: http://localhost:14317 traces: processors: - batch: - exporter: - otlp: - protocol: grpc/protobuf - endpoint: localhost:14317 + - batch: + exporter: + otlp: + protocol: grpc/protobuf + endpoint: http://localhost:14317 ``` {{% alert title="Caution" color="warning" %}} diff --git a/content/en/docs/concepts/instrumentation/libraries.md b/content/en/docs/concepts/instrumentation/libraries.md index 1cbdc24fc33c..38a19054ad73 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 @@ -245,8 +245,8 @@ 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 4fc089ff9475..d54fc9332104 100644 --- a/content/en/docs/contributing/_index.md +++ b/content/en/docs/contributing/_index.md @@ -43,9 +43,9 @@ The pages in this section describe how to contribute to OpenTelemetry **documentation**. For guidance on how to contribute to the OpenTelemetry project in general, see -the community [OpenTelemetry New Contributor Guide]. Every [OTel repository][org] -for language implementations, the Collector, and conventions have their own project-specific -contributing guides. +the community [OpenTelemetry New Contributor Guide]. Every [OTel +repository][org] for language implementations, the Collector, and conventions +have their own project-specific contributing guides. [OpenTelemetry New Contributor Guide]: https://github.com/open-telemetry/community/blob/main/guides/contributor diff --git a/content/en/docs/contributing/localization.md b/content/en/docs/contributing/localization.md index 615669b7ef09..86370e8f4fe9 100644 --- a/content/en/docs/contributing/localization.md +++ b/content/en/docs/contributing/localization.md @@ -6,10 +6,10 @@ weight: 25 cSpell:ignore: shortcodes --- -The OTel website uses Hugo's [multilingual framework] to support page localizations. -English is the default language, with US English as the default (implicit) localization. -A growing number of other localizations are supported, as can be seen from the languages -dropdown menu in the top nav. +The OTel website uses Hugo's [multilingual framework] to support page +localizations. English is the default language, with US English as the default +(implicit) localization. A growing number of other localizations are supported, +as can be seen from the languages dropdown menu in the top nav. ## English language maintainer guidance diff --git a/content/en/docs/contributing/pull-requests.md b/content/en/docs/contributing/pull-requests.md index ac831674f9c7..8f64afb815d4 100644 --- a/content/en/docs/contributing/pull-requests.md +++ b/content/en/docs/contributing/pull-requests.md @@ -384,9 +384,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/architecture.md b/content/en/docs/demo/architecture.md index ab2f2040807b..245ff539c225 100644 --- a/content/en/docs/demo/architecture.md +++ b/content/en/docs/demo/architecture.md @@ -14,12 +14,13 @@ graph TD subgraph Service Diagram accountingservice(Accounting Service):::dotnet adservice(Ad Service):::java -cache[(Cache
(redis))] +cache[(Cache
(Valkey))] cartservice(Cart Service):::dotnet checkoutservice(Checkout Service):::golang currencyservice(Currency Service):::cpp emailservice(Email Service):::ruby -flagd(Flagd-ui):::typescript +flagd(Flagd):::golang +flagdui(Flagd-ui):::typescript frauddetectionservice(Fraud Detection Service):::kotlin frontend(Frontend):::typescript frontendproxy(Frontend Proxy
(Envoy)):::cpp @@ -30,40 +31,52 @@ productcatalogservice(Product Catalog Service):::golang quoteservice(Quote Service):::php recommendationservice(Recommendation Service):::python shippingservice(Shipping Service):::rust -queue[(queue
(Kafka))] +queue[(queue
(Kafka))]:::java -Internet -->|HTTP| frontendproxy -frontendproxy -->|HTTP| frontend -frontendproxy -->|HTTP| flagd -loadgenerator -->|HTTP| frontendproxy -frontendproxy -->|HTTP| imageprovider +adservice ---->|gRPC| flagd -queue -->|TCP| accountingservice -queue -->|TCP| frauddetectionservice - -frontend -->|gRPC| cartservice -frontend -->|gRPC| currencyservice +checkoutservice -->|gRPC| cartservice +checkoutservice --->|TCP| queue +cartservice --> cache +cartservice -->|gRPC| flagd -checkoutservice -->|gRPC| cartservice --> cache -checkoutservice -->|gRPC| productcatalogservice -checkoutservice -->|gRPC| currencyservice -checkoutservice -->|HTTP| emailservice -checkoutservice -->|gRPC| paymentservice checkoutservice -->|gRPC| shippingservice -checkoutservice -->|TCP| queue +checkoutservice -->|gRPC| paymentservice +checkoutservice --->|HTTP| emailservice +checkoutservice -->|gRPC| currencyservice +checkoutservice -->|gRPC| productcatalogservice + +frauddetectionservice -->|gRPC| flagd frontend -->|gRPC| adservice +frontend -->|gRPC| cartservice +frontend -->|gRPC| checkoutservice +frontend ---->|gRPC| currencyservice +frontend ---->|gRPC| recommendationservice frontend -->|gRPC| productcatalogservice -frontend --->|gRPC| checkoutservice -frontend ---->|gRPC| recommendationservice -->|gRPC| productcatalogservice -shippingservice -->|HTTP| quoteservice +frontendproxy -->|gRPC| flagd +frontendproxy -->|HTTP| frontend +frontendproxy -->|HTTP| flagdui +frontendproxy -->|HTTP| imageprovider + +Internet -->|HTTP| frontendproxy + +loadgenerator -->|HTTP| frontendproxy + +paymentservice -->|gRPC| flagd +queue -->|TCP| accountingservice +queue -->|TCP| frauddetectionservice + +recommendationservice -->|gRPC| productcatalogservice +recommendationservice -->|gRPC| flagd + +shippingservice -->|HTTP| quoteservice end classDef dotnet fill:#178600,color:white; classDef cpp fill:#f34b7d,color:white; -classDef erlang fill:#b83998,color:white; classDef golang fill:#00add8,color:black; classDef java fill:#b07219,color:white; classDef javascript fill:#f1e05a,color:black; @@ -80,7 +93,6 @@ graph TD subgraph Service Legend dotnetsvc(.NET):::dotnet cppsvc(C++):::cpp - erlangsvc(Erlang/Elixir):::erlang golangsvc(Go):::golang javasvc(Java):::java javascriptsvc(JavaScript):::javascript @@ -94,7 +106,6 @@ end classDef dotnet fill:#178600,color:white; classDef cpp fill:#f34b7d,color:white; -classDef erlang fill:#b83998,color:white; classDef golang fill:#00add8,color:black; classDef java fill:#b07219,color:white; classDef javascript fill:#f1e05a,color:black; diff --git a/content/en/docs/demo/forking.md b/content/en/docs/demo/forking.md index 6aa882a3f337..e3f4930d5078 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/kubernetes/collector/components.md b/content/en/docs/kubernetes/collector/components.md index 51bd7749bd68..59384c698ffd 100644 --- a/content/en/docs/kubernetes/collector/components.md +++ b/content/en/docs/kubernetes/collector/components.md @@ -283,77 +283,13 @@ filelog: exclude: # Exclude logs from all containers named otel-collector - /var/log/pods/*/otel-collector/*.log - start_at: beginning + start_at: end include_file_path: true include_file_name: false operators: - # Find out which format is used by kubernetes - - type: router - id: get-format - routes: - - output: parser-docker - expr: 'body matches "^\\{"' - - output: parser-crio - expr: 'body matches "^[^ Z]+ "' - - output: parser-containerd - expr: 'body matches "^[^ Z]+Z"' - # Parse CRI-O format - - type: regex_parser - id: parser-crio - regex: - '^(?P