Skip to content

Commit

Permalink
Merge branch 'open-telemetry:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
svrnm authored May 22, 2024
2 parents a4cf770 + 44dca8b commit 694beab
Show file tree
Hide file tree
Showing 30 changed files with 1,096 additions and 431 deletions.
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[submodule "themes/docsy"]
path = themes/docsy
url = https://github.com/google/docsy.git
docsy-pin = v0.10.0-2-g6f7e81d
docsy-pin = v0.10.0-6-g102892d
docsy-note = "2024-04-01 Switching to google/docsy.git from cncf/docsy.git since we don't have any CNCF customizations."
docsy-reminder = "Ensure that any tag referenced by `docsy-pin` is present in the remote repo (url), otherwise add (push) the tags to the repo."
[submodule "content-modules/opentelemetry-specification"]
Expand Down
2 changes: 1 addition & 1 deletion assets/scss/_styles_project.scss
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@
}

details {
background-color: $gray-100;
background-color: var(--bs-tertiary-bg);
margin-bottom: 0.5em;

summary {
Expand Down
14 changes: 13 additions & 1 deletion content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,25 @@ title: OpenTelemetry
description: >-
High-quality, ubiquitous, and portable telemetry to enable effective
observability
show_banner: true
outputs:
- HTML
- REDIRECTS # Include this `content/en` ONLY
developer_note:
The blocks/cover shortcode (used below) will use as a background image any
image file containing "background" in its name.
show_banner: true
limit_banner: 2 # Default to 2, adjust as needed
banners:
- message:
'<i class="fas fa-bullhorn"></i> Join us for [**OTel Community Day** on
June
25th](https://events.linuxfoundation.org/open-telemetry-community-day/)!'
to: 2024-06-25
- message:
'<i class="fas fa-bullhorn"></i> Help improve OTel and Prometheus
interoperability: [complete our
survey](https://forms.gle/bZAG9f7udoJsjZUG9) by May 31'
to: 2024-05-31
---

<div class="d-none"><a rel="me" href="https://fosstodon.org/@opentelemetry"></a></div>
Expand Down
9 changes: 4 additions & 5 deletions content/en/community/end-user/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,8 @@ about your implementation or adoption that you'd like to share with project
contributors, or you want to help prioritize project issues. You've come to the
right place!

- To connect with other end users and learn about upcoming events:
- Join the [Slack channel](slack-channel/)
- Join the [APAC end user discussion group](discussion-group/)
- To connect with other end users and learn about upcoming events, join the
[Slack channel](slack-channel/).
- To learn about OpenTelemetry, check out:
- [OTel in practice](otel-in-practice/)
- Curated content on the
Expand Down Expand Up @@ -54,5 +53,5 @@ OpenTelemetry.
**I have questions about this, who can I reach out to?**

You can find members of the
[OpenTelemetry End User SIG](https://github.com/open-telemetry/community/tree/main/working-groups/end-user)
in [#otel-sig-end-user](https://cloud-native.slack.com/archives/C01RT3MSWGZ).
[OpenTelemetry End User SIG](https://github.com/open-telemetry/sig-end-user) in
[#otel-sig-end-user](https://cloud-native.slack.com/archives/C01RT3MSWGZ).
48 changes: 6 additions & 42 deletions content/en/community/end-user/discussion-group.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,46 +5,10 @@ description: Monthly OpenTelemetry usage discussions, all are welcome!
weight: 20
---

**As of April 2024, AMER and EMEA sessions are discontinued in favor of
discussion panels with a more targeted focus.**
**As of April 2024, discussion-group sessions are discontinued in favor of
end-user panels with a more targeted focus.**

Interested in learning how other end users are implementing OpenTelemetry in
their organizations? Come talk shop with other OpenTelemetry end users! This is
a vendor-neutral space to discuss best practices, ask questions, and meet other
observability-minded folks.

Feedback that is shared and collected in these sessions will be routed back to
the relevant project maintainers to help drive prioritization of improvements
and changes to the project.

## About

- Search the blog for "End-User Discussions" to find summaries of past
discussions.
- A project maintainer and/or a Governance Committee member will be in
attendance at each session to provide additional context, insight, and plans
to user questions and feedback.
- Sessions are recorded.

## Upcoming sessions

Here are upcoming sessions, or you can view them on the
[OpenTelemetry calendar](https://github.com/open-telemetry/community#calendar):

- **APAC (Asia Pacific)**: every third Wednesday of the month at 11AM India ST
(GMT +5.5), [register](https://lu.ma/1w129wgu) to get the Zoom link
- April 17
- May 15
- June 19

Past topics/questions have included:

- Best practices on monitoring collectors in production
- Using OTel in CI/CD pipelines
- What’s holding you back from adopting more OpenTelemetry?
- Auto vs manual instrumentation use cases
- How to secure a publicly exposed OTel Collector?

We use a [Lean Coffee](https://leancoffee.org) format where discussion topics
are generated and democratically selected by the group at the start of the
meeting. Topics are rigorously time-boxed by a facilitator.
If you would like to participate or help organize a future end-user panel, you
can find members of the
[OpenTelemetry End User SIG](https://github.com/open-telemetry/sig-end-user) in
[#otel-sig-end-user](https://cloud-native.slack.com/archives/C01RT3MSWGZ).
93 changes: 4 additions & 89 deletions content/en/docs/collector/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -602,95 +602,10 @@ service:

### Telemetry

The `telemetry` is where the telemetry for the Collector itself can be
configured. Collector's own telemetry can be useful when troubleshooting
Collector issues. It consists of two subsections: `logs` and `metrics`.

The `logs` subsection lets you configure how the logs can be generated by the
Collector. By default, the Collector writes its logs to `stderr` with a log
level of `INFO`. You can also add static key-value pairs to all log entries with
the `initial_fields` to enrich the logging context. The [`logs` configuration
options](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
param vers %}}/service/telemetry/config.go) are:

- `level`: sets the minimum enabled logging level, default `INFO`.
- `development`: puts the logger in development mode, default `false`.
- `encoding`: sets the logger's encoding, default `console`. Example values are
`json`, `console`.
- `disable_caller`: stops annotating logs with the calling function's file name
and line number. By default `false`, all logs are annotated.
- `disable_stacktrace`: disables automatic stacktrace capturing, default
`false`. By default, stacktraces are captured for `WARN` level and above logs
in development and `ERROR` level and above in production.
- `sampling`: sets a sampling policy.
- `output_paths`: a list of URLs or file paths to write logging output to,
default `["stderr"]`.
- `error_output_paths`: a list of URLs or file paths to write logger errors to,
default `["stderr"]`.
- `initial_fields`: a collection of fields to add to the root logger. By
default, there is no initial field.

The `metrics` subsection lets you configure how the metrics can be generated and
exposed by the Collector. By default, the Collector generates basic metrics
about itself and expose them for scraping at <http://127.0.0.1:8888/metrics>.
You can expose the endpoint to a specific or even all network interfaces when
needed. The [`metrics` configuration
options](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
param vers %}}/service/telemetry/config.go) are:

- `level`: the level of telemetry metrics, default `basic`. The possible values
are:
- `none`: no telemetry is collected.
- `basic`: essential service telemetry.
- `normal`: the default level, adds standard indicators on top of basic.
- `detailed`: the most verbose level, includes dimensions and views.
- `address`: the `[address]:port` formatted URL that metrics exposition should
be bound to. Default `127.0.0.1:8888`.

The following example shows the Collector telemetry configuration:

```yaml
service:
telemetry:
logs:
level: DEBUG
initial_fields:
service: my-instance
metrics:
level: detailed
address: 0.0.0.0:8888
```

Note that it's possible to scrape the metrics by using a
[Prometheus receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/prometheusreceiver)
within the Collector configuration so that we can consume the Collector's
metrics at the backend. For example:

```yaml
receivers:
prometheus:
trim_metric_suffixes: true
use_start_time_metric: true
start_time_metric_regex: .*
config:
scrape_configs:
- job_name: 'otel-collector'
scrape_interval: 5s
static_configs:
- targets: ['127.0.0.1:8888']
exporters:
otlp:
endpoint: my.company.com:4317
tls:
insecure: true
service:
pipelines:
metrics:
receivers: [prometheus]
exporters: [otlp]
```
The `telemetry` config section is where you can set up observability for the
Collector itself. It consists of two subsections: `logs` and `metrics`. To learn
how to configure these signals, see
[Activate internal telemetry in the Collector](/docs/collector/internal-telemetry#activate-internal-telemetry-in-the-collector).

## Other Information

Expand Down
Loading

0 comments on commit 694beab

Please sign in to comment.