Skip to content

Commit

Permalink
Update go/getting-started.md (#4577)
Browse files Browse the repository at this point in the history
Co-authored-by: Phillip Carter <pcarter@fastmail.com>
Co-authored-by: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com>
  • Loading branch information
3 people authored Jun 2, 2024
1 parent 05a20c1 commit aa67a24
Show file tree
Hide file tree
Showing 47 changed files with 202 additions and 217 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}}
3 changes: 1 addition & 2 deletions content/en/blog/2021/gc-election.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}}
3 changes: 1 addition & 2 deletions content/en/blog/2021/womens-day.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}}
4 changes: 2 additions & 2 deletions content/en/blog/2022/debug-otel-with-otel/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
39 changes: 18 additions & 21 deletions content/en/blog/2022/exponential-histograms/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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][])
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
13 changes: 6 additions & 7 deletions content/en/blog/2022/instrument-apache-httpd-server/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
9 changes: 4 additions & 5 deletions content/en/blog/2022/k8s-metadata/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
4 changes: 2 additions & 2 deletions content/en/blog/2022/kubecon-na.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions content/en/blog/2022/otel-demo-app-nomad/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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? 🥰
Expand Down
6 changes: 3 additions & 3 deletions content/en/blog/2023/contributing-to-otel/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 5 additions & 6 deletions content/en/blog/2023/ecs-otel-semconv-convergence.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
13 changes: 8 additions & 5 deletions content/en/blog/2023/end-user-q-and-a-03.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down
20 changes: 10 additions & 10 deletions content/en/blog/2023/exponential-histograms.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
21 changes: 10 additions & 11 deletions content/en/blog/2023/kubecon-eu.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

> <i class="far fa-exclamation-triangle"></i> **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

Expand All @@ -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.

Expand Down
Loading

0 comments on commit aa67a24

Please sign in to comment.