Skip to content

Commit

Permalink
Merge branch 'open-telemetry:main' into drewby/genai_blog
Browse files Browse the repository at this point in the history
  • Loading branch information
drewby authored Nov 14, 2024
2 parents 78607e1 + ad58587 commit be9608f
Show file tree
Hide file tree
Showing 52 changed files with 805 additions and 197 deletions.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/PAGE_FEEDBACK.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Page Feedback
description: >-
Used for page feedback from users visiting opentelemetry.io and clicking "no"
if a page was helpful.
title: '[Page Feedback]: summary of your feedback'
body:
- type: input
id: url
attributes:
label: URL
description: >-
The URL of the webpage where you are facing an issue. If not
auto-populated, please copy the URL from the browser address bar.
placeholder: https://opentelemetry.io/
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description:
'How has the page not been helpful? What information is missing? '
placeholder: >-
Provide details on the problem. The more information you share with us
the faster we can resolve the issue.
validations:
required: true
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!--
Please provide a meaningful description of what your changes will do. Bonus points for including links to related issues, other PRs, or technical references.
A detailed description helps reviewers understand the context of your change and reduces
the time needed to review.
Please make sure to follow the [contribution guidelines](https://opentelemetry.io/docs/contributing/).
We run checks on all PRs, to ensure that your contribution follows our [style guide](https://opentelemetry.io/docs/contributing/style-guide/).
Many requirements of that guide can be enforced by running `npm run fix:all` locally and committing the changes.
Note, that although those checks need to be green before we can merge your PR, do not
worry about their status after submitting your PR. We will provide you with guidance, when and how to
address them.
Similarly, do not worry about your PR being out-of-date with the base branch and do not continuously
update or rebase your branch. We will let you know when it is necessary.
If you have any questions, feel free to ask.
-->
6 changes: 0 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE/DOCS_UPDATE.md

This file was deleted.

32 changes: 1 addition & 31 deletions .htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,40 +10,9 @@ IgnoreDirs:
# DO NOT EDIT! IgnoreDirs list is auto-generated from markdown file front matter.
# Ignore blog index pages for all locales and in all blog sections (top-level and years)
- ^(../)?blog/(\d+/)?page/\d+
# TODO drop next lines after https://github.com/open-telemetry/opentelemetry.io/issues/5555 is fixed for these pages:
- ^es/docs/concepts/glossary/
- ^es/docs/concepts/instrumentation/zero-code/
- ^es/docs/concepts/signals/baggage/
- ^es/docs/zero-code/php/
# TODO drop next lines after https://github.com/open-telemetry/opentelemetry.io/issues/5555 is fixed for these pages:
- ^ja/docs/concepts/components/
- ^ja/docs/concepts/glossary/
- ^ja/docs/concepts/signals/baggage/
- ^ja/docs/languages/erlang/sampling/
- ^ja/docs/languages/js/sampling/
- ^ja/docs/languages/ruby/sampling/
- ^ja/docs/zero-code/php/
# TODO drop next line after https://github.com/open-telemetry/opentelemetry.io/issues/5423 is fixed for ja pages:
- ^ja/docs/concepts/instrumentation/libraries/
# TODO drop next lines after https://github.com/open-telemetry/opentelemetry.io/issues/5555 is fixed for these pages:
- ^pt/docs/concepts/components/
- ^pt/docs/concepts/glossary/
- ^pt/docs/concepts/signals/baggage/
- ^pt/docs/languages/erlang/instrumentation/
- ^pt/docs/languages/erlang/sampling/
- ^pt/docs/languages/js/instrumentation/
- ^pt/docs/languages/js/sampling/
- ^pt/docs/languages/net/instrumentation/
- ^pt/docs/languages/net/libraries/
- ^pt/docs/languages/net/shim/
- ^pt/docs/languages/php/instrumentation/
- ^pt/docs/languages/python/instrumentation/
- ^pt/docs/languages/ruby/instrumentation/
- ^pt/docs/languages/ruby/sampling/
- ^pt/docs/zero-code/php/
# TODO drop next line after https://github.com/open-telemetry/opentelemetry.io/issues/5423 is fixed for pt pages:
- ^pt/docs/concepts/instrumentation/libraries/
# TODO drop next lines after https://github.com/open-telemetry/opentelemetry.io/issues/5555 is fixed for these pages:
- ^zh/docs/concepts/signals/baggage/
- ^zh/docs/zero-code/php/
# DO NOT EDIT! IgnoreDirs list is auto-generated from markdown file front matter.
Expand Down Expand Up @@ -81,6 +50,7 @@ IgnoreURLs: # list of regexs of paths or URLs to be ignored
- ^https://www.farfetch.com
- ^https://www.zocdoc.com
- ^https://x.com
- ^https://maven.org
# OTel Google calendar - curl returns 200, but the link checker gets a 401:
- ^https://calendar.google.com/calendar/embed\?src=google.com_b79e3e90j7bbsa2n2p5an5lf60%40group.calendar.google.com
# YouTube playlists sometimes give a 404, although they give a 200 when accessed via browser:
Expand Down
65 changes: 54 additions & 11 deletions assets/js/registrySearch.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ let pathName = window.location.pathname;
let searchQuery = '';
let selectedLanguage = 'all';
let selectedComponent = 'all';
let selectedFlag = 'all'; // Added selectedFlag

parseUrlParams();

Expand All @@ -49,7 +50,12 @@ if (pathName.includes('registry')) {
showBody();
}

if (selectedLanguage !== 'all' || selectedComponent !== 'all') {
// Set the dropdown values from query params
if (
selectedLanguage !== 'all' ||
selectedComponent !== 'all' ||
selectedFlag !== 'all'
) {
if (selectedLanguage !== 'all') {
document.getElementById('languageDropdown').textContent =
document.getElementById(
Expand All @@ -62,6 +68,10 @@ if (pathName.includes('registry')) {
`component-item-${selectedComponent}`,
).textContent;
}
if (selectedFlag !== 'all') {
document.getElementById('flagsDropdown').textContent =
document.getElementById(`flag-item-${selectedFlag}`).textContent;
}
updateFilters();
}

Expand Down Expand Up @@ -106,6 +116,22 @@ if (pathName.includes('registry')) {
updateFilters();
}),
);
// Flags dropdown event listener

let flagList = document
.getElementById('flagsFilter')
.querySelectorAll('.dropdown-item');

flagList.forEach((element) =>
element.addEventListener('click', function (evt) {
let val = evt.target.getAttribute('value');
selectedFlag = val;
document.getElementById('flagsDropdown').textContent =
evt.target.textContent;
setInput('flag', val);
updateFilters();
}),
);
});
}

Expand Down Expand Up @@ -208,34 +234,51 @@ function setInput(key, value) {
history.replaceState(null, null, '?' + queryParams.toString());
}

// Filters items based on language and component filters
// Filters items based on language, component and flags
function updateFilters() {
let allItems = [...document.getElementsByClassName('registry-entry')];
if (selectedComponent === 'all' && selectedLanguage === 'all') {
if (
selectedComponent === 'all' &&
selectedLanguage === 'all' &&
selectedFlag === 'all'
) {
// Show all items if all filters are set to 'all'
allItems.forEach((element) => element.classList.remove('d-none'));
} else {
// Apply the filters
allItems.forEach((element) => {
const dc = element.dataset.registrytype;
const dl = element.dataset.registrylanguage;
if (
(dc === selectedComponent || selectedComponent === 'all') &&
(dl === selectedLanguage || selectedLanguage === 'all')
) {
const df = element.dataset.registryflags
? element.dataset.registryflags.split(' ').map((f) => f.toLowerCase())
: [];

const componentMatches =
dc === selectedComponent || selectedComponent === 'all';
const languageMatches =
dl === selectedLanguage || selectedLanguage === 'all';
const flagMatches =
selectedFlag === 'all' || df.includes(selectedFlag.toLowerCase());

if (flagMatches) {
console.log('Flag matches:', df);
}

if (componentMatches && languageMatches && flagMatches) {
// Changed
element.classList.remove('d-none');
} else if (dc === selectedComponent && dl !== selectedLanguage) {
element.classList.add('d-none');
} else if (dl === selectedLanguage && dc !== selectedComponent) {
element.classList.add('d-none');
} else {
element.classList.add('d-none');
}
});
}
}

// Parse URL parameters and update variables
function parseUrlParams() {
let urlParams = new URLSearchParams(window.location.search);
searchQuery = urlParams.get('s');
selectedLanguage = urlParams.get('language') || 'all';
selectedComponent = urlParams.get('component') || 'all';
selectedFlag = urlParams.get('flag') || 'all'; // Added
}
4 changes: 3 additions & 1 deletion content/en/docs/collector/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,13 @@ preferred shell.

## Generate and collect telemetry

3. Launch the Collector:
3. Launch the Collector, listening on ports 4317 (for OTLP gRPC), 4318 (for OTLP
HTTP) and 55679 (for ZPages):

```sh
docker run \
-p 127.0.0.1:4317:4317 \
-p 127.0.0.1:4318:4318 \
-p 127.0.0.1:55679:55679 \
otel/opentelemetry-collector-contrib:{{% param vers %}} \
2>&1 | tee collector-output.txt # Optionally tee output for easier search later
Expand Down
31 changes: 20 additions & 11 deletions content/en/docs/kubernetes/operator/automatic.md
Original file line number Diff line number Diff line change
Expand Up @@ -361,17 +361,16 @@ time). This means that the configured endpoint must be able to receive OTLP over
will connect to the `http` port of the `otlpreceiver` of the Collector created
in the previous step.

> As of operator v0.67.0, the Instrumentation resource automatically sets
> `OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` and `OTEL_EXPORTER_OTLP_METRICS_PROTOCOL`
> to `http/protobuf` for Python services. If you use an older version of the
> Operator you **MUST** set these env variables to `http/protobuf`, or Python
> auto-instrumentation will not work.
> As of operator v0.108.0, the Instrumentation resource automatically sets
> `OTEL_EXPORTER_OTLP_PROTOCOL` to `http/protobuf` for Python services. If you
> use an older version of the Operator you **MUST** set this env variable to
> `http/protobuf`, or Python auto-instrumentation will not work.
#### Auto-instrumenting Python logs

By default, Python logs auto-instrumentation is disabled. If you would like to
enable this feature, you must to set the `OTEL_LOGS_EXPORTER` and
`OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED` environment variables as
enable this feature, you must to set
`OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED` environment variable as
follows:

```yaml
Expand All @@ -389,14 +388,12 @@ spec:
- baggage
python:
env:
- name: OTEL_LOGS_EXPORTER
value: otlp_proto_http
- name: OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED
value: 'true'
```
> Note that `OTEL_LOGS_EXPORTER` must be explicitly set to `otlp_proto_http`,
> otherwise it defaults to gRPC.
> As of operator v0.111.0 setting `OTEL_LOGS_EXPORTER` to `otlp` is not required
> anymore.

#### Excluding auto-instrumentation {#python-excluding-auto-instrumentation}

Expand Down Expand Up @@ -541,6 +538,18 @@ securityContext:
runAsUser: 0
```

### Auto-instrumenting a Python musl based container {#annotations-python-musl}

Since operator v0.113.0 Python auto-instrumentation also honors an annotation
that will permit it to run it on images with a different C library than glibc.

```sh
# for Linux glibc based images, this is the default value and can be omitted
instrumentation.opentelemetry.io/otel-python-platform: "glibc"
# for Linux musl based images
instrumentation.opentelemetry.io/otel-python-platform: "musl"
```

## Troubleshooting

If you run into problems trying to auto-instrument your code, here are a few
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/languages/java/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
title: Java
description: >-
<img width="35" class="img-initial" src="/img/logos/32x32/Java_SDK.svg"
alt="Java"> A language-specific implementation of OpenTelemetry in Java.
alt="Java"> Language-specific implementation of OpenTelemetry in Java.
aliases: [/java, /java/metrics, /java/tracing]
cascade:
vers:
instrumentation: 2.9.0
otel: 1.44.0
instrumentation: 2.10.0
otel: 1.44.1
contrib: 1.38.0
semconv: 1.28.0
weight: 18
Expand Down
Loading

0 comments on commit be9608f

Please sign in to comment.